Advanced settings for OneDesk On-Prem
These settings need to be added in the /root/.OneDesk configuration file. Changes to the OneDesk stack happen only on install / update of RPM files,
so any changes to this file wil not be reflected live.
-
AzureAD Login and Office365 SMTP/IMAP
You will nedd to configure an AzureAD enterpise application and configure the following 2 properties in /root/.OneDesk . To know more about how to configure the AzureAD click here
AZUREAD_CID=Application_Id_from_Azure_ActiveDirectory
AZUREAD_CIS=Client_Secret_from_Azuzre_ActiveDirectory
-
Google OAuth2
You will nedd to configure an Google OAuth2 application and configure the following 2 properties:
GOOGLE_OAUTH2_CID=Google_OAuth2_ClientId
GOOGLE_OAUTH2_CIS=Google_OAuth2_Client_Secret
-
Local IMAP
Local IMAP setup is installed by onedesk-prereqs package and it is controlled by the following configurations:
IMAP_LOCAL_SETUP=y #configure local server to have smtp and imap virtual hosts (y or n)
IMAP_USER=some_imap_user #needed only if IMAP_LOCAL_SETUP=n
IMAP_PASS=some_imap_password #needed only if IMAP_LOCAL_SETUP=n
IMAP_HOST=your_imap_host #needed only if IMAP_LOCAL_SETUP=n
IMAP_PORT=143 #needed only if IMAP_LOCAL_SETUP=n
IMAP_PROTOCOL=imap:// #needed only if IMAP_LOCAL_SETUP=n, valid values: imap:// imaps://
-
Amazon AWS S3 for attachments
OneDesk can natively store the attachments in the AWS S3 cloud. OneDesk never serves your attachments directly from AWS S3, so the bucket has to be private. This option affects only new
attachments, existing attachments will stay on disk.
S3_BUCKET_NAME=se_bucket_name_in_your_account
S3_ACCESS_KEY=restricted_S3_access_key
S3_SECRET_KEY=corresponding_secret_key
-
AI Features
AI features are powered by OpenAI. To enable AI features you need to add your own OpenAI API-key to the OneDesk configuration file.
Note: You must also have purchased a OneDesk license that includes the optional AI add-on.
OPENAI_TOKEN=openai_token
OPENAI_SEARCH_COSINE_SIMILARITY_THRESHOLD=0.25 # optional
OPENAI_SEARCH_SYSTEM_PROMPT_RECORD_COSINE_SIMILARITY_THRESHOLD=0.15 # optional
OPENAI_CHAT_MODEL="gpt-4.1" # optional
OPENAI_EMBEDDING_MODEL="text-embedding-3-large" # optional
-
Voice
Voice features are powered by Twilio. You need to add your Twilio credentials to the OneDesk configuration file AND obtain a license key that includes the optional voice plugin.
Note: You must also have purchased a OneDesk license that includes the optional Voice add-on.
TWILIO_MAIN_ACCOUNT_SID=your_twillio_main_account_sid
TWILIO_MAIN_ACCOUNT_AUTH_TOKEN=your_twillio_main_account_auth_token
TWILIO_MAIN_ACCOUNT_API_KEY=your_twillio_api_key
TWILIO_MAIN_ACCOUNT_API_SECRET=your_twillio_api_secret
TWILIO_DEVICE_CALL_APP_SID=your_twillio_ml_device_app
TWILIO_PHONE_CALL_APP_SID=your_twillio_ml_call_app
-
Reserved configurations added automatically by the installer
OneDesk's installer automatically adds certain configurations to your .OneDesk file.
ADMIN_1ST_PASS=1st_random_password (can safely be removed once you have changed the password of the 1st admin)
DEFAULT_ORG_ID=number #set by the OneDesk's migration RPM (do NOT alter!)
SSL_SELF_RENEW=y (added when self-obtain certificated from Let's Encrypt are used)