Admin
Installation guide
Last updated: January 2023
Support documentation / Installing Enhance
Installation steps
To proceed, you will need:
- Your Enhance install command
- Your Enhance licence key
ℹ️ If you have signed up for a 60 day free trial you will find both of these in your my.enhance account. They were also sent to you by email.
To install Enhance:
- Log in to your new server as root via SSH or log in as a user with sudo privileges and type "sudo -i".
- Copy and paste your installation command into the terminal and hit ‘Enter’
- Once the installation is complete, a control panel URL will be displayed in the terminal window, visit this link. This may take up to 30 minutes depending on the speed of your server and your server's internet connection.
When the control panel loads, follow the steps on screen to create an Owner login and configure your master server. At this point or at any point in the future you can add additional servers.
ℹ️ If you have recently pointed a subdomain to your Enhance server to act as a hostname for your control panel, please allow time for DNS propagation.
Completing installation if you closed your terminal window
The web URL to complete installation is presented to you at the end of the command line installation process. If you closed your terminal, it is possible to recover. Run the following command as root or with sudo:
docker inspect orchd | grep -oE "REGISTRATION_KEY\=([a-z0-9-]+)" | sed 's/REGISTRATION_KEY=//'
This will give you the registration key to complete the setup. You should then browse to:
https://{controlPanelDomain}/setup/{registrationKey}
Where {controlPanelDomain} is the control panel domain you chose when starting the command line installation and {registrationKey} is the UUID from the above command.
Multi server clusters
If you are planning an Enhance estate with more than one server, we suggest disabling the application role on the control panel server so no customer websites will be placed there. This will improve performance and security.
To create additional servers, click "servers" -> "add server" and paste the install command provided into a blank Ubuntu 20.04 server.
ℹ️ The install command for secondary servers is different to the install command for control panel servers.
ℹ️ If you have the Ubuntu "ufw" firewall enabled, please allow all traffic from the primary IP of your control panel server.
Troubleshooting
If the Enhance installation hangs or you encounter any other issues during installation, please;
1. Firstly check that your instance has sufficient RAM (4GB minimum).
2. Ensure your server has x86_64 architecture (ARM, is not supported).
If none of the above resolve your issue, please run "docker logs orchd" and "journalctl -u enhcontrold" and send the output to support@enhance.com for assistance.