This article outlines the necessary steps to install the Application Gateway for safous.com domains. Generally, the installation of the app gateway can be segmented into these procedural steps:
- Obtaining Token & Installer
- Executing the Installer
- Verification
Obtaining Token & Installer:
The first procedure to do is to obtain the installation token and the installer file by conducting these steps:-
Login to Safous Admin Portal and navigate to Tenant > Services where you can find the Get Token button. Click on the button.
Important Note!!
The Get Token button will be greyed-out once you have already installed the maximum number of App Gateway as stated in the contract. - Once you have clicked the Get Token button, Safous will generate Safous Installation Token needed for the installation of App Gateway and display it on the browser tab.
- Connect to your virtual machine/host where you want to install the App Gateway. Please make sure to use a user with root privilege.
- Please copy the Safous Installation Token and execute the command below. Replace the <INSTALLATION TOKEN> placeholder with the copied token.
TOKEN=<INSTALLATION_TOKEN> Important Note!!
The TOKEN is only valid for 24 hours since it has been generated - Download the installer file by executing this command
curl -s --fail -H "Authorization: Bearer $TOKEN" https://setup.safous.com/installer -o installer || echo 'Error'
Executing the Installer
After acquiring the installation token and the installer file, the next step is to run the installer. Please follow the steps below in order to successfully install the Application Gateway:
- Execute the installer by running this command
sudo bash installer - The installer will verify if the server meets the required minimum specifications.
- If the server has met the minimum specifications, the installer will continue to the next step.
- If the server fails to meet the minimum specifications, the installer will prompt you to confirm whether you wish to proceed with the installation.
- Enter y to continue the installation.
- Enter n to exit the installer.
- Next, the installer will retrieve the required SSL certificate for your App Gateway, which is tied to your specified domain.
- After successfully obtaining the SSL certificate for the App Gateway, the installer will prompt you to specify the geographical region of your server. This information is necessary for establishing a connection to the nearest Point of Presence (PoP) in that region.
- Enter 1, if the App Gateway is located in Japan
- Enter 2, if it is located in any of ASEAN Countries (Indonesia, Malaysia, Philippines, Thailand, and Vietnam)
- Enter 3, if it is located not in Japan and ASEAN Countries
- Select the version of App Gateway that you want to install.
- We recommend proceeding with the latest version, Version 5, as it offers the newest features and improvements by entering 1.
- If you prefer to use the legacy Version 4, please enter 2. Should you later decide to upgrade to Version 5, you can easily do so by following the provided upgrade procedure.
Important Note!!
The support for version 4.x will last until the end of March 2025.
- Enter password for the admin account. Please note that the password must be strong. The requirements are:
- At least 8 digits long
- Have at least 1 upper case letter
- Have at least 1 lower case letter
- Have at least 1 symbol
Important Note!!
Please keep this password safely, as it may be needed for troubleshooting purpose by Safous Support Team. - Enter the name of the site where the App Gateway will be deployed.
- When deploying an App Gateway for a different site, make sure to use a unique name that differs from the existing ones.
- Conversely, if you're deploying an App Gateway for the same site to enable HA functionality, it should retain the same name.
- The installer will display your choices and ask for the final confirmation before proceeding for the installation of the App Gateway.
- Enter y to install the App Gateway.
- Enter n to exit the installer.
- The installer will execute a setup process to install all necessary packages and configure the App Gateway. Upon completion, a comprehensive checklist will be available for review at the end of the installation process.
Verification
The last procedure to do after the end of installation is to verify that the App Gateway have been installed successfully by conducting these steps:
- Ensure you are still connected to the App Gateway host
- Check that the App Gateway containers are running successfully by running this command
sudo docker ps 
- Run the command down below. Please change the <DOMAIN> placeholder with the domain parameter that you could find in the installation process:
curl https://login.<DOMAIN> - Check the output
- If the App Gateway is successfully installed, the command will generate an output like the screenshot below:
- If the App Gateway installation fails or met some problems, the command will generate an output like the screenshots below.
- If the App Gateway is successfully installed, the command will generate an output like the screenshot below:
- If the output resembles the screenshot in the success example, your App Gateway installation is complete. You can now create a new user to log in to the user portal by referring to this article.
- Should the output resemble the screenshot of the failed example, immediately reach out to support@safous.com for assistance from Safous Support.