How to host YOURLS on Vultr Server - ServerAvatar

YOURLS is an open-source URL-shortening platform known for its features and flexibility. With a range of plugins and customizable options, YOURLS supports personalized URL-shortening solutions without requiring deep technical knowledge. It allows users to efficiently create and manage short links, offering features for link tracking, custom URL generation, and analytics. When choosing a hosting platform for the YOURLS application, opting for Vultr ensures reliability with its scalable infrastructure and straightforward deployment options. ServerAvatar makes the deployment of the YOURLS application on the Vultr platform an easy step-by-step process.

Create a Cloud Instance in Vultr

To create a server in Vultr, follow the below given steps. If you want to learn How to use Vultr to manage your infrastructure in Vultr, You can refer to our Vultr cloud guide.

Step 1: Go to the Instance Creation Page

Vultr provides different types of cloud instances. From the server creation page, you can create cloud instances such as Regular VMs, Dedicated, Bare Metal, Cloud GPUs, and some managed services.

To access the server creation page, log in to your Vultr account and click on the Deploy New Server option from the + button given on the dashboard.

Step 2: Choose the Server

You can create 4 different types of cloud instances which includes Optimised Cloud Compute, Cloud Compute, Cloud GPU, and Bare Metal. Select the one that fits your requirements.

Step 3: Choose Server Type

Based on your selection of the server in the second step, You will have to select a specific type of server. If you have selected the Optimised Cloud Compute instance, You will see the options like this as shown in the image below:

Step 4: Select Server Location

Location is a very important option. Make sure to select a server location closest to your major traffic source demographically. You can select locations in 5 different continents.

Step 5: Select Server Image

In simple terms, a Server image is an operating system running on the server. So here, You have to select an OS for your server.

If you are managing your servers with ServerAvatar, Select Ubuntu 20.04 or Ubuntu 22.04.

Step 6: Select Server Size

Here, Select a server size according to your requirements. The minimum requirement for hosting YOURLS is 1GB of RAM, more is recommended for smoother performance, especially if you’re running other services on the server. The exact amount will depend on your usage and data storage needs.

If you are just getting started with the project, You can start with a small configuration and then upgrade it according to future requirements.

Step 7: Add Auto Backups and Additional Features

We recommend you to enable auto backups for important websites or apps. If you are creating a temporary server, You can skip the auto backups.

In addition to this feature, You can enable DDOS Protection and other options according to your requirements.

Do not enable the "No Public IPv4 Address" option. It will create the server without IPv4, which is impossible to connect with ServerAvatar.

Step 8: Select an SSH Key

If you use an SSH key to authenticate with the server, Select an SSH key in this section. If you haven't uploaded your key yet, You can do it by clicking on the Add New option.

SSH key is not mandatory. If you don’t want to use SSH keys, Ignore this option. You can still connect to your server by using the password.

Step 9: Firewall Group

If you are using the Vultr firewall, You can select the firewall group from here.

If you do not have the 43210 port enabled in your firewall group, you need to configure it to connect a server with ServerAvatar.

Step 10: Server Hostname and Label

In this step, you have to choose the hostname and the label for the server. You can set the same hostname and label. They are used for identification purposes only.

Step 11: Deploy Now!

Finally, click on the Deploy Now button to create a server. It might take a minute or two to fully boot up your server. Once it is ready, You will see it in the Products section in Vultr.

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