If you require assistance installing OneDesk onPrem, we offer installation services. You can request this service at support@onedesk.com

Pre-requirements

• Linux VM, that supports rpm files (Tested and supported: Alma 8, RedHat 8), X86_64 architecture.
• minimum 32G of RAM (t3.2xlarge or m5.2xlarge in AWS, Standard_E4_v3 or Standard_D8_v3 in Azure)
• minimum 60G disk space, recommended 80G
• opened ports: 443 and 80
• (optional) SSL certificate + associated key (optional because if the instance is accessible via public IP, the certificate will be automatically obtained from Let's Encrypt)
• (optional) shared drive / S3 access for backups
• (optional) opened ports if email server is not provided: 25
• (optional) Google Firebase credentials -- for mobile-friendly apps (Knowledge Base etc...)

Warning

The OneDesk installer has been tested using the above hardware requirements, and using the correct versions of the required packages. Any changes you make to the installation procedures are NOT supported by OneDesk, so please follow the instructions carefully.

OneDesk requires the installation of specific versions of different packages and will download and install the correct versions for you. If you substitute a version, it may not be supported by OneDesk and you will have to start the installation over again.

We require that you start the installation process with a CLEAN IMAGE to prevent conflict with any previously installed software.

OneDesk's onPrem Installation steps

1. Obtain repo access key from OneDesk
2. Open a terminal/console and login as root (alternatively you can use sudo).
3. Create and edit a basic configuration file in /root/.OneDesk, the file contents should be as below. The file name has a dot (indicates hidden file) and it is case-sensitive. Don't forget to review and edit at least the highlighted values! How to edit.
   
   ADMIN_EMAIL=sys_admin_email@example.com #Enter your loginname for your admin user
ADMIN_1ST_PASS=admin_random_password #Enter your temporary password for admin user. You should reset password upon first login.
DB_HOST=127.0.0.1
DB_PORT=5432
DB_PASS=changeit #Enter your Postgresql superadmin database password (postgres user). We recommand setting a secure password
ODE_PROTOCOL=https://
ODE_DOMAIN=some_url_including_subdomain #Replace with the domain where you are hosting OneDesk. Must be a domain with subdomain not an IP address.(eg: support.example.com)
JABBER_HOST=generally_the_same_as_ODE_DOMAIN #Replace with the domain where you are hosting OneDesk, generally the same as ODE_DOMAIN (eg: support.example.com)
JABBER_PASSWORD=some_random_jabber_password # it is used only internally by the app, not exposed or used outside the instance. It is optional to change it.
TOTP_FROM_ADDRESS=totp_2fa@example.com #Email address from where the 2FA code will be sent.
STORAGE_PATH=/mnt/nfs_share # path for disk used for storing attachments
AJP_PASS=some_random_ajp_password # it is used only internally by the app, not exposed or used outside the instance. It is optional to change it.

   For more advanced settings and tuning options please consult the full configuration options.
   
   You can download and create this basic configuration file by running the following command as root:
   
   curl https://repo.onedesk.com/.OneDesk -o /root/.OneDesk
   
   
4. open a command prompt as root and run the following two commands one after another:
   
   dnf config-manager --add-repo https://repo.onedesk.com/repo
dnf config-manager --save --setopt=*.gpgkey=https://repo.onedesk.com/repo/RPM-GPG-KEY-onedesk --setopt=*.gpgcheck=1 --setopt=*.name="OneDesk OnPrem" repo.onedesk.com_repo

   
   
5. edit /etc/yum.repos.d/repo.onedesk.com_repo.repo and put the repo key OneDesk provided to the end of the baseurl configuration. After the edit the line should look similar to:
   
   baseurl=https://repo.onedesk.com/repo/YOUR_ONEDESK_REPO_KEY
   
   
6. open a command prompt as root and run the following three commands one after another:
   
   dnf install onedesk-prereqs --refresh
dnf install onedesk-db-utils onedesk-webapps onedesk-microservices onedesk-customerapps
reboot

   ...after these steps your installation is complete, your machine is rebooting, and your SSH connection will be closed.
   
   
7. Congratulations, OneDesk is installed on your server! Please wait 5-10 minutes for your server to complete starting up.
   Then using your browser, you can login at the domain you specified in your configuration file (ODE_DOMAIN) using the ADMIN_EMAIL as login name and ADMIN_1ST_PASS as password.

These instructions have been tested with the pre-requirements and instructions above. If you are unable to login, please start again, after verifying all the pre-requirements are met, with a clean image and carefully follow each line of the instructions.