Configure¶
You can check .env.example file to see additional settings.
CRON Setup¶
Create one CRON that runs every minute as follows;
* * * * * php /path-to-your-project/artisan schedule:run >/dev/null
Email Queues¶
Queues allow you to defer the processing of a time consuming task, such as sending an email, until a later time. Deferring these time consuming tasks drastically speeds up web requests to your application.
You can change the queue driver in your .env file QUEUE_DRIVER=database
Note
You can process the jobs by running php artisan queue:work --queue=default,high,normal,low --tries=3 --daemon
.
Application Configuration¶
You can set your application to production by modifying this value in .env file.
APP_ENV
- Set it to productionAPP_DEBUG
- Set it to false
System Configuration¶
Here some of the system configurations you can change in your .env
EMAIL_TRACKING_ENABLE
- Enables email tracking for leads.PDF_FONT
- Font to use on PDF generated.DAILY_DIGEST_ENABLED
- Enables daily email summary - Default true.DAILY_DIGEST_AT
- Sets the time when daily summary should be sent - Default 23:58ACTIVITY_DAYS
- The number of days activity logs take to be cleared - Default 7 daysTICKETS_DUE_DAYS
- Number of days before a ticket expires - Default 3 daysTASKS_DUE_DAYS
- Days before a task is overdue - Default 7 daysALERT_TODO_DAYS
- Number of days to notify me before a todo is overdueESTIMATE_REMIND_DAYS
- Number of days before a reminder is sent to client about expiring estimate. Default 2 daysCONTRACT_REMIND_DAYS
- Days before a client is notified of expiring contract that has not been signed. Default 2 daysENABLE_DRIFT
- Enable DriftENABLE_CRISP
- Enable CrispENABLE_ONESIGNAL
- Enable Onesignal
Backup Settings¶
BACKUP_DISKS
- Comma separated list of backup disks e.g local,s3BACKUPS_MAIL_ALERT
- Email to send notifications on successfull backupBACKUPS_SLACK_WEBHOOK
- Slack webhook to post backup notificationsBACKUPS_SLACK_CHANNEL
- Slack channel to post backup notifications. Default blank
Email Settings¶
MAIL_DRIVER
- Email driver. Default smtpMAIL_HOST
- Email host e.g smtp.mailtrap.ioMAIL_PORT
- Outgoing email port e.g 2525MAIL_USERNAME
- Outgoing email usernameMAIL_PASSWORD
- Outgoing email passwordMAIL_ENCRYPTION
- Default nullMAIL_FROM_ADDRESS
- The email address that sends emails (Your company address)MAIL_FROM_NAME
- Your company name that appears on emails
Attention
To send a test email go to Settings -> System Info and click on Test Email button.
Paypal Configuration¶
- To setup paypal IPN;
- Login to Paypal account
- Set the IPN to https://{YOUR-DOMAIN}/webhook/paypal/ipn replace {YOUR-DOMAIN} with your actual domain e.g https://app.workice.com/webhook/paypal/ipn
Attention
To enable PayPal Live, go to Settings -> Payment Settings
Stripe Configuration¶
To configure Stripe, proceed as follows;
- Login to your stripe dashboard account
- Get your API Keys by clicking Developers section
- Obtain your stripe webhook keys by clicking on Webhooks under Developers section of your stripe dashboard.
Open your .env file in Workice CRM and modify the values below;
STRIPE_KEY={YOUR_STRIPE_PUBLISHABLE_KEY}
STRIPE_SECRET={YOUR_STRIPE_SECRET_KEY}
STRIPE_WEBHOOK_SECRET={YOUR_STRIPE_WEBHOOK_KEY}
Stripe Webhook Configuration¶
- To handle Stripe webhooks, proceed as follows;
- Login to your stripe dashboard and click on Developers section.
- Click Webhooks -> Add Endpoint button
- Enter webhook URL as https://{YOUR-DOMAIN}/stripe/webhook replace {YOUR-DOMAIN} with your actual domain e.g https://app.workice.com/stripe/webhook
By default, Workice CRM will automatically handle cancelling subscriptions that have too many failed charges (as defined by your Stripe settings), customer updates, customer deletions, subscription updates, and credit card changes;
Razorpay Configuration¶
To configure RazorPay, proceed as follows;
- Login to your razorpay dashboard account
- Get your API Keys by clicking Settings -> API Keys section
Open your .env file in Workice CRM and modify the values below;
RAZORPAY_KEY={RAZORPAY_KEYID}
RAZORPAY_SECRET={RAZORPAY_SECRET}
Attention
Create Razorpay webhook and enter webhook URL as https://{YOUR-DOMAIN}/webhook/razorpay/ipn replace {YOUR-DOMAIN} with your actual domain e.g https://app.workice.com/webhook/razorpay/ipn
Braintree Configuration¶
To configure Braintree, proceed as follows;
- Login to your braintree dashboard account
- Get your API Keys by clicking Settings -> API section
- Just below the API keys you’ll see your Merchant ID
Open your .env file in Workice CRM and modify the values below;
BRAINTREE_MERCHANT_ID={BRAINTREE_MERCHANT_ID}
BRAINTREE_PUBLIC_KEY={BRAINTREE_PUBLIC_KEY}
BRAINTREE_PRIVATE_KEY={BRAINTREE_PRIVATE_KEY}
Attention
You will need to enter your Merchant Account in Settings -> Payment Settings -> Braintree Merchant Account
Attention
To enable Braintree Live, go to Settings -> Payment Settings
WePay Configuration¶
To configure WePay gateway, proceed as follows;
- Login to your WePay dashboard account
- Get your API Keys by clicking on your business account
- Copy and replace the values below with your WePay API Keys
Open your .env file in Workice CRM and modify the values below;
WEPAY_ACCOUNT_ID={WEPAY_ACCOUNT_ID}
WEPAY_CLIENT_ID={WEPAY_CLIENT_ID}
WEPAY_SECRET_ID={WEPAY_CLIENT_SECRET}
WEPAY_ACCESS_TOKEN={WEPAY_ACCESS_TOKEN}
Attention
To enable WePay Live, go to Settings -> Payment Settings
2Checkout Configuration¶
To configure 2checkout, proceed as follows;
- Login to your 2checkout dashboard account
- Get your API Keys by clicking on API section
- Obtain your SELLER ID by clicking on your 2chekout avatar and copy Account Number.
Open your .env file in Workice CRM and modify the values below;
2CHECKOUT_PUBLISHABLE_KEY={2CHECKOUT_PUBLISHABLE_KEY}
2CHECKOUT_PRIVATE_KEY={2CHEKOUT_PRIVATE_KEY}
2CHECKOUT_SELLER_ID={2CHEKOUT_SELLER_ID}
Attention
To enable 2Checkout Live, go to Settings -> Payment Settings
Google Calendar Setup¶
To display events from your Google Calendar, Go to Settings -> System Settings and enter your Google Calendar API key and your Google Calendar ID. Once the settings are configured, your events will display on Workice calendar.
Using a (Reverse) Proxy¶
If you need to set a list of trusted (reverse) proxies you can modify app/Http/Middleware/TrustProxies.php file. Your trusted proxies should be listed as an array on the $proxies property of this middleware. In addition to configuring the trusted proxies, you may configure the proxy $headers that should be trusted:
protected $proxies = [
'192.168.1.1',
'192.168.1.2',
'10.0.0.0/8',
'192.168.0.0/16'
];