How to host YOURLS on Digitalocean Droplet - ServerAvatar

YOURLS is an open-source URL-shortening platform known for its features and flexibility. It allows users to efficiently create and manage short links, offering features for link tracking, custom URL generation, and analytics. With a range of plugins and customizable options, YOURLS supports personalized URL-shortening solutions without requiring deep technical knowledge. For hosting YOURLS, DigitalOcean is an excellent choice due to its scalable infrastructure and easy deployment features. ServerAvatar makes the deployment of the YOURLS application on the DigitalOcean platform straightforward through a simplified process.

Create Server in Digitalocean

Digitalocean is one of the most popular cloud platforms right now. It offers on-demand cloud computing for various use cases as well as some managed solutions. We can deploy any PHP-based applications on Digitalocean Droplets. Droplets are the servers or cloud computing instances in Digitalocean. If you want to learn about droplet management in-depth in Digitalocean, We recommend you to read our Digitalocean guide.

To deploy any application on Digitalocean, We first need a Droplet. So, we will first create a droplet and perform the initial setup.

Step 1: Go to the Create Droplets page.

Log in to your Digitalocean account and click on the Create button given on the top-right corner of the page. From the drop-down menu, click on the Droplets option to see a droplet creation form.

Step 2: Choose Region

On the Droplet creation page, you will find several sections for selecting different options. We will proceed step by step.

The first thing you have to do is select the region for your droplet. Digitalocean provides several options when it comes to 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 low latency.

Step 3: Choose an Image or an OS

In this step, you have to select the operating system for your droplet. Generally, the YOURLS application requires Ubuntu 18.04 LTS or a later version for compatibility and support.

However, We recommend you to use Ubuntu 20.04 LTS x64 or Ubuntu 22.04 LTS x64. These operating systems are a requirement if you are using ServerAvatar to manage your droplets.

Step 4: Choose the size of the Droplet

Here you have to choose the size of your Droplet. As we mentioned above, Digitalocean provides many different types of droplets. Select the one that fits best for your project.

If your site is brand new and does not have much traffic, start with a small plan. Once the project starts getting traction, you can upgrade the plan to handle more visitors on the site.

Step 5: Choose Authentication Method

Now you have to select the authentication method. There are two types of authentication methods. They are as follows:

1. Authentication via SSH Keys
2. Authentication via Password

Using SSH keys for authentication is the best option. If you are not familiar with SSH keys, you can choose the password method. Make sure to set a strong password for your root user, which is the most powerful user with all the privileges on Linux OS.

Step 6: Selecting Additional Options

There are three additional options you can choose from. They are optional but important in different use cases. The additional options are:

1. Monitoring: It is a free feature by Digitalocean. It allows you to see additional monitoring data for your server.
2. Backups: We recommend you to enable full server backups if you are going to deploy in a production environment. The cost of the backups depends on the size of the droplet.
3. Managed Database: You do not need a Managed database if you are using ServerAvatar to manage sites on a droplet. A managed database is a pre-configured MySQL Droplet.

Step 7: Finalise Details

In the last step of this process, We have to enter the name of the droplet, and the number of droplets you want to create, Define any tags, and select the project. Enter all the details and click on the Create Droplet button to create a droplet.

In a few minutes, You will have the Droplet up and running. Now, We have to perform the initial configuration on the Droplet to host PHP-based frameworks and software.

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.

wget https://srvr.so/install
chmod +x install
./install

Install and Setup YOURLS on Cloud using ServerAvatar

Getting Started With YOURLS:

YOURLS is a powerful set of PHP scripts that allows you to run Your Own URL Shortener on your server. This gives you full control over your links, provides detailed statistics, supports plugins, and much more, all in a free and open-source package.

Key Features:

• Open Source: YOURLS is open-source, so you can modify and use it according to your needs.
• Extensible: You can extend its functionality using various Plugins available in the YOURLS environment.
• Total Control: YOURLS allows you to manage your short links, putting your branding front and center by using your own domain or subdomain.
• Detailed Insights: Get detailed insights into link performance with YOURLS' comprehensive statistics and analytics, helping you understand how your links are performing.

Requirements:

• Web Server: YOURLS requires Apache version 2.4 or greater, with the mod_rewrite module enabled.
• PHP: PHP version 7.4 or greater is needed for YOURLS to work correctly. If you plan on using the YOURLS API, make sure the PHP cURL extension is enabled.
• Database: MySQL 5.0 or greater & MariaDB 10.0 or greater for storing link data.
• HTTPS Support: For security reasons, it's recommended to host your YOURLS installation on a server with HTTPS support.

Install and Setup YOURLS on Cloud using ServerAvatar:

Step 1: Create an Application

• To create a new Custom application for YOURLS, navigate to the Applications tab on the server panel. Click on the Create button on the server panel to start the process of application creation.

• On the following screen, fill in the Application details, including:

  • Application Name: enter your Application Name.
  • Select Domain: Select between a Test Domain or a Primary Domain as per your requirements.
  • Enter Domain: Enter your Application Domain.
  • Method: Select Git as your application method.
  • Service Provider: Select GitHub as service provider for cloning the repository.
  • Repository Type: Public
  • Clone HTTPS URL: https://github.com/YOURLS/YOURLS.git
  • Branch: master
  • Deployment Script: composer update (to update the composer after cloning)

• Now, your Application is ready. You can see your Application in the Dashboard.

Step 2: Create a Database

• To create a Database that stores your confidential data, Go to the Dashboard and click on the Databases option. Enter Your Database name and just hit on the “Create a Database” button as shown in the image below.

• After successfully creating a Database, you can see your Database in the Databases Dashboard.

Step 3: Copy config.php File

• Go to Application Dashboard and navigate to File Manager open the public_html folder by clicking on it.

• Select the sample-config.php and click on copy icon as shown in the image below.

• In the pop-up of Copy File enter the location for the file to copy at /public_html/user/config.php and click on the Copy button as shown in the below image.

Step 4: Update config.php File

• After copying the config.php file, open it and modify fields such as Database Name, Database Username, Password, and YOURLS Site.

• To find your database credentials, navigate to the Databases section in the server panel and click on the manage users icon next to the database you have set up for your application.

• You can see your Database credentials as shown in the image below.

Step 5: Update your Custom Webroot

• Navigate to the Settings section in your Application panel and add admin to your custom webroot path as shown in the below image and click on Update Custom Webroot.

Step 6: Access YOURLS

• Now, to access the YOURLS, open your web browser and enter your site's domain.
  • Example: http://yourlsapp.satesting1.click
  • For instance: http://your-application-domain
• It will redirect You to Yourls installation page.

• Now, Click on the Install YOURLS Button.

• After completing the Installation process, You will see the go to YOURLS Administration Page as shown in the below image.

• You can log in to the YOURLS Administration page using the username and password.
  • Username: Your Username
  • Password: Your Password