How to host YOURLS on Contabo VM Instance - 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. When it comes to hosting YOURLS, Contabo is preferred due to its scalable infrastructure and seamless deployment options. ServerAvatar makes the deployment of the YOURLS application on the Contabo platform an easy step-by-step process.

Create VM Instance in Contabo

What Is Contabo?

Contabo is a web hosting company that provides a variety of internet hosting services. Founded in Germany in 2003, Contabo offers services such as:

1. VPS Hosting: Virtual Private Servers with scalable resources for various needs, from small projects to larger applications.
2. Dedicated Servers: Physical servers dedicated to a single user, offering high performance and control.
3. Web Hosting: Shared hosting solutions for websites, which include storage, bandwidth, and various management tools.
4. Object Storage: Scalable storage solutions for managing large amounts of data.
5. Domain Registration: Services for registering and managing domain names.

Contabo is known for its competitive pricing, high-performance hardware, and customer service, making it a popular choice for both individual users and businesses looking for reliable hosting solutions.

To set up a server in Contabo, begin by logging into your Contabo account. Once logged in, proceed with the following steps.

Step 1: Create an account on Contabo

Login to your Contabo account, select "VPS" from the dropdown menu, and then click on "Cloud VPS".

Step 2: Select your Cloud VPS plan

Contabo offers a variety of Cloud VPS options. Here, you should select the plan that best meets your requirements as shown in the below image.

Step 3: Select Region

• First, you need to select the term length (in months) according to your requirements.
• Next, you will need to select the location for your VPS. Contabo offers multiple options for selecting the location.
• It's recommended to select the region closest to your audience. This ensures that your sites load faster for the majority of your audience due to reduced latency.

Step 4: Select your Storage Type

Contabo provides different types of storage space, including both complimentary and paid options. Here, you should select the storage type based on your specific requirements. As shown in the image below.

Step 5: Select an Image or an OS

In this step, you need to select the Operating System for your cloud VPS. Generally, the YOURLS application requires Ubuntu 18.04 LTS or a later version for compatibility and support.

We recommend using Ubuntu 20.04 LTS x64 or Ubuntu 22.04 LTS x64. If you are using ServerAvatar to manage your cloud VPS, these operating systems are recommended.

Step 6: Setting a Password

Here, it's recommended to create a strong password for your root user, as it holds all privileges on the Linux OS.

Step 7: Select Object Storage

Now, you need to select object storage space for backing up your VPS. You will find several options ranging from 250 GB to 1 TB. If you do not require object storage you can select the None option from the dropdown.

Step 8: Select Network

• In the Network section, you will find three options, You should select these according to your specific requirements:
  • Private Network
  • Bandwidth
  • IPv4

Step 9: Selecting Additional Options

• Backup Space: This option allows you to add additional storage space dedicated specifically for backups of your VPS data.
• Server Management: Contabo offers server management services where they handle the day-to-day operations of your VPS.
• Monitoring: This option provides monitoring services for your VPS. It includes monitoring server uptime, resource usage (CPU, RAM, disk), and network connectivity.
• SSL: SSL (Secure Sockets Layer) certificates are crucial for securing communication between your website and its visitors.

After completing all the necessary steps, click on the "Next" button to proceed to the payment method where you can finalize your details.

Step 10: Finalize Details

In this step, you can review all your selections for your Cloud VPS, finalize your details, and proceed with the payment. In a few minutes, your Cloud VPS will be ready. Now, we need to perform the initial configuration 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