Cachet is an open-source platform designed for organizations to efficiently create status pages. The cachet is perfect for businesses and organizations of all sizes. It includes essential tools for maintaining and communicating service statuses and ensuring accessibility for administrators and users. When considering hosting Cachet, deploying it on UpCloud is a dependable choice due to its scalable infrastructure and user-friendly deployment solutions. ServerAvatar assists with UpCloud VPS and simplifies the deployment of the Cachet application on the UpCloud platform through easy steps.
Create a Server in UpCloud
Getting Started with UpCloud:
UpCloud is a high-performance VPS (Virtual Private Server) hosting platform designed for developers, businesses, and IT professionals. Renowned for its speed and reliability, UpCloud features the unique MaxIOPS storage technology, delivering performance significantly faster than traditional SSDs. This makes it an excellent choice for applications with high I/O demands, such as databases and web hosting. With its user-friendly control panel, UpCloud simplifies server management, making it an attractive option for anyone needing superior VPS hosting solutions.
To deploy any application on UpCloud, we must first set up a server. Therefore, our initial step will be to deploy a server and complete its initial setup.
Step 1: Server Deployment
- Log in to your Upcloud account. If you don’t have an account, create an account on UpCloud.
- Then, Navigate to Server → Server List and click on the Deploy Server button, as shown in the image below.
Step 2: Select Location
- The first thing you have to do is select the location for your server. UpCloud provides different options for selecting the location.
- The general rule is to select the region that is closest to your audience. It means that for the majority of your audience, Your sites will load faster due to lower latency.
Step 3: Select the plan for your Server
- Here you have to select the plan of your Droplet. UpCloud offers a variety of plans. Select the one that best meets your requirements.
- The minimum requirements for hosting Cachet are 2GB or more of RAM, but for larger deployments or heavy traffic, 4GB or more is advisable depending on your traffic, and configurations. Also, Minimum of 1GB of free disk space for the Cachet application and additional space for data, logs, and backups. The exact amount will depend on your usage and data storage needs.
Step 4: Add New Storage Device
- In the Storage section, you can attach new storage devices as needed. Your initial storage is based on the selected server plan. You can attach up to 16 storage devices, each with a maximum size of 4 TB.
- To add more disks, click the "Add new device" button and adjust the storage size with the slider. You can modify the storage configuration later by adding, removing, or resizing disk devices.
Step 5: Automated Backups
- You can also enable Automated Backups by clicking the toggle button on the right side. You can choose from Day, Week, Month, or Year plans.
- After selecting the appropriate plan, you can set a backup schedule using the drop-down menu below.
Step 6: Choose an Operating System
- In this step, you need to select your server operating system. We recommend selecting Ubuntu 20.04 LTS x64 or Ubuntu 22.04 LTS x64. If you are using ServerAvatar to manage your servers, these operating systems are required.
Step 7: Select Network Configuration
- In this step, by default network configurations are set that include IPv4 and IPv6 addresses, and a private Utility Network connection is set. You can customize these settings and attach your private network by clicking on the “Attach Private Network” option.
Step 8: Additional Options
- In this step, you can enable or disable IPv6 support and metadata service. Also, you can set the desired TimeZone and select between network and display adapters.
- If it suits you, we suggest keeping these options at their default settings.
Step 9: Select Login Method
- Now you have to select the Login method. There are two types of login methods. They are:
- Authentication via SSH Keys
- Authentication via One-Time Password
- If you are using SSH keys for authentication, It is the best option. You can also click on the “Add New” button to import your keys.
- If you do not know what is SSH key, You can go with the One-Time password method. You have to set a new password after the first time you log into this server.
- Make sure to set a strong password for your root user, which is the most powerful user with all the privileges on Linux OS. You can select the convenient way to have the password.
Step 10: Enter Initialization Script
- The Initialization scripts are user-defined automation scripts supported by all Linux public templates. When you select one of your stored scripts, it will appear in the edit field.
- You can make changes to the scripts or write a new one. The server will execute the script during the first bootup.
Step 11: Finalise Details
- In the last step of this process, We have to enter the Host Name, Server Name, and number of servers you want to deploy. Click on the Deploy button to create a server.
- In a few minutes, You will have the Server up and running.
- Now, We have to perform the initial step to allow the Serveravatar port from the firewall configuration.
- To allow the Serveravatar port from firewall configuration, Click on the Server → Server List Option and then click on the icon next to your server as shown in the below image.
- Now, navigate to the Firewall Section and Click on “Add Rule”.
- Create a rule to allow ServerAvatar Communication Port - 43210 as shown in the below image. Click on the Ok to add the firewall rule.
- Now, click on the “Save Changes” button to save the changes to Firewall Rules as shown in the below image.
Initial Server Configuration
The Initial server configuration includes the installation and configuration of various packages required to host your website. Usually, You have to write commands and modify configuration files. Luckily, With ServerAvatar, Your full server configuration and optimization can be automated.
Here are the three ways to automatically configure your server with ServerAvatar.
Connect a server using a direct method
- Login/Register to ServerAvatar account, click the Create button from the right side of the screen, and select Server from the dropdown.
- Select Direct Method in the serve connecting method section.
- Type the Server Name as per your choice.
- Select a Tech Stack as per your need. You can either select Apache, Nginx, OpenLiteSpeed or Node Stack.
- Select a Database: MySQL, MariaDB or MongoDB.
- Enable the toggle if you want to install the latest LTS version of node.js on your server.
- Select a Management plan and click the Connect Now button.
- You’ll see the command on your screen. Login to your server using an ssh connection and execute that command as a root user.
- The server connection process will be started on your ServerAvatar account after executing the command.
Connect a server using integration
- Login/Register to your ServerAvatar account, navigate to the Integration tab from the sidebar of the panel, and access Cloud Platform from the dropdown.
- Now Select a cloud platform you want to link with ServerAvatar.
- The popup form will appear on your screen. Enter details to link your cloud provider account. The integration method is different based on the cloud provider you select.
- You can integrate five different cloud provider platforms with ServerAvatar, which is-
Check the above link of cloud platforms to know more about integrating cloud platforms with ServeAvatar.
Connect a server using commands
Step 1. Login to your server using root user
Once you create a server as per your requirements, connect to your server using an ssh connection and execute the below three commands as a root user in your server console area.
wget https://srvr.so/install
chmod +x install
./install
Step 2. Select a web server
It will ask you which web server you would like to install on your server: Apache, Nginx, OpenLiteSpeed or Node Stack. Type anyone that you would like to install on your server and hit the enter button.
Step 3. Claim your server
Completing the process will give you a link to claim your server.
Open the link on your browser to access the ServerAvatar server panel.
Install and Setup Cachet status page system with ServerAvatar
Step 1: Create a PHP application
To create an application, go to the ServerAvatar server panel, navigate to the Applications tab, and click the Create button like the following image.
1. Fill in basic detail
In the first step, fill in the basic details, including the Application Name, select the Domain type, and type the Primary Domain/Test Domain Name.
Note that:
If you want to host Joomla CMS on your domain, then make sure to point your domain to the current IP address of your server, and for that:
- Log in to your hosting provider site, where you buy your domain. You can check your domain information with one click.
- Access DNS Manager to edit your DNS records(contact the support team if you don’t find them)
- Change the IP address of A Record of your website to the current server’s IP address.
Note that:
For accessing Cachet on the subdomain, you need to add your subdomain on A Record that points to the current IP address of your server. To point to an IPV6 address, you would need to use an AAAA record
Click the Next Step to continue.
2. Select the application creation method
Here you can fill in the required details. It includes-
- Select the Git method and GitHub as a service provider so we can deploy an application from Git public repository.
- Mark on Public Repository.
- Type/Paste the GitHub project URL. You’ll find the link on GitHub in the image below.
- Type the Branch of the GitHub project.
- Type the below commands in the deployment script.
php7.3 /usr/bin/composer install cp .env.example .env php7.3 artisan key:generate
Note that:
Note that: Cachet supports PHP7.1 To 7.3, we need to specify the version in the command in the deployments script.
3. Allocate system user
System users manage the resources of the application. You can create a new application user or give permission to the existing user.
Click the Next Step to continue.
4. Other Options
In this step, select PHP version 7.3. Cachet supports PHP 7.1 - 7.3. Type Public in the Custom Webroot field.
5. Review your application details
Review your application details. Click the Create Application button.
Step 2: Create a Cachet database
On the server panel, navigate to the Databases tab from the sidebar and click the Create button to create a MySQL database.
Fill in database details, including-
- Database Name
- Database Username
- Database Password
Step 3: Delete the .env.example file and update the database information
To delete the .env.example file, go to the application panel>>file manager and access the public_html folder. Now check the Show Hidden Files. The .env.example file is at the top of the multiple hidden files. Please select the file and delete it like the following image.
Now open the .env file and change the database details we created in the second step. It includes-
DB_DATABASE: Database Name DB_USERNAME: Database Username DB_PASSWORD: Database Password
Don’t forget to save the file(CTRL+s) after making appropriate changes.
Step 4: Install SSL
To install SSL for your application. Go to your application panel and click the SSL Certificate from the sidebar.
You can install Automatic SSL or a Custom installation method to secure your site with an SSL certificate. It is recommended to install automatic SSL for your application.
Step 5: Install and Set up Cachet
1. Environment set up
Access your domain/subdomain on the browser to install and set up Cachet. The setup screen will look like the following image.
Fill in the required details in the above image and click the Next button.
2. Status Page Setup
On the next page, you’ll need to set up the status page. Here you can fill up the details, including your Website Name, Website Domain, Timezone, and Language.
Click the Next button to continue.
3. Administrator Account
Fill up admin details, including** Admin Username**, Email, and Password.
Once you enter all the details, click the Complete Setup button. The message will display like the following image. Click the Go To Dashboard button to continue.
Notice: you may see the error “An error occurs, and this resource cannot be displayed.”
If it occurs, log in to your application using an SSH connection. You can see the credentials in the application panel in the following image.
Execute the following command in your terminal to log in to your application-
ssh Username@Host
Now go to your application path using “cd Application_Name/public_html” and execute the following command.
Php7.3 artisan migrate:refresh
After that, go to your setup page and click the Complete Setup button. It will configure cachet successfully.
Once you access the dashboard, you’ll create and manage components and incidents, including updating incidents with additional information and marking them as resolved when the issue is fixed.
That’s it. Your CacheT instance should be live and you can start working on your status pages. We hope this tutorial was helpful to you. You can also refer to other deployment tutorials given below.