How to host YOURLS on Azure VM Instance - 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. For hosting YOURLS, Azure is an excellent choice due to its scalable infrastructure and easy deployment features. ServerAvatar enhances this experience by providing Azure VPS hosting and offering a simple, user-friendly approach to deploying YOURLS application.

Create VM Instance in Azure

Getting Started with Azure:

Azure virtual machines are one of several types of on-demand, scalable computing resources that Azure offers. Typically, you choose a virtual machine when you need more control over the computing environment than the other choices offer. An Azure virtual machine offers the benefits of virtualization without the need to purchase or manage the underlying physical hardware. However, you are responsible for tasks such as configuring, patching, and installing software on the virtual machine to ensure its proper functioning.

Azure virtual machines can serve a variety of purposes. Here are a few examples:

1. Development and testing: Azure virtual machines provide a fast and straightforward method to deploy a computer environment tailored for coding and testing applications with specific configurations.
2. Cloud-based applications: Given the variable demand for your application, it can be cost-effective to host it on an Azure virtual machine. You scale up by deploying additional virtual machines as needed and scale down by shutting them down during periods of lower demand.
3. Extended data center: Virtual machines within an Azure virtual network can seamlessly integrate with your organization's network infrastructure.

Create a VM Instance in Azure:

To create a server in Microsoft Azure, First log in to Microsoft Azure. Once you are there, Follow the steps given below.

Step 1: Create a resource

• To access the resource creation form, Go to the Microsoft Azure Home and click on the addition icon button to create a resource. See the following image for reference.

• Then, click on the Create Virtual Machine as derived in the following image:

• By default, you are in the basic section, you have to fill out the details of your project. Select your Subscription plan and create a Resource group accordingly.

• After that, you have to enter the following details of your instance which includes:
  1. Virtual machine name: Enter your virtual machine name.
  2. Region: Select the Location of your Instance.
  3. Availability options: There are four options available:
     • No infrastructure redundancy is required. (Recommended)
     • Availability Zone: If you select this option then you will have to choose the Zones available for your instance.
     • Virtual machine scale set: If you select this option then you have to create your own Virtual machine scale set in your current resource and region.
     • Availability Set: If you select this option then you can choose Aligned availability sets or Classic availability sets.
  4. Security type: Azure offers three types of security:
     • Standard: Selecting this type will provide a basic level of security.
     • Trusted launch virtual machines: Selecting this will ensure a secure boot process by leveraging hardware-backed security features to protect against firmware-level attacks and other vulnerabilities. (Recommended)
     • Confidential virtual machines: Selecting this will provide a secure environment where data can be processed in encrypted memory, safeguarding it from unauthorized access even from the cloud provider.
  5. Image: Generally, the YOURLS application requires Ubuntu 18.04 LTS or a later version for compatibility and support. We recommend to use Ubuntu 20.04 LTS x64 or Ubuntu 22.04 LTS x64 as an operating system.
  6. VM architecture: Select the radio button that shows x64 bit.
  7. Size: Select the VM component size as per your requirements.
  8. Enable Hibernation: Ignore this checkbox.

• Following the steps you have to enter the Administrator account details:

1. Authentication type: You can either use the SSH public key or password for authentication, we recommend to use SSH public key.
2. Username: Enter username of your choice.
3. SSH public key source: There are three sources available in Azure for SSH public key:
   • Generate new key pair: If you want to generate a new SSH public key then you can choose this option and also you can select encryption format that is RSA SSH format or Ed25519 SSH Format. (Ed25519 provides enhanced performance and security using a smaller key size, whereas RSA remains prevalent, especially in legacy systems and applications).
   • Use existing key stored in Azure: Select this if you have stored any SSH public key in Azure.
   • Use existing public key: Select this if you already have a public key of your own.

• Now you have to set up Inbound port rules. Inbound port rules define how incoming network traffic is handled by a device or network service. These rules specify which ports on the device or service are open and accessible from external sources, such as the Internet or other networks. In this section, you have to select the ‘Allow Selected Port’ radio button as public inbound rules and select the inbound port as shown in the picture below.

Step 2: Select the Disk for the Virtual Machine

• You can select the disk according to your requirements and needs. You can refer to the image to see the options available in Azure for configuring the disk.

Step 3: Configuring Network Interface Settings

• Here you have to configure your virtual machine network interface, for that, you have to fill out the details as follows:
  1. Virtual network: Select the network or you can create one.
  2. Subnets: Select by default subnets or if you have knowledge you can manage and configure them on your own.
  3. Public IP: Select the newly created by default public IP or you can create one.
  4. NIC network security group: Leave it Basic as shown in the below image.
  5. Public inbound ports: Click on Allow selected ports.
  6. Select inbound ports: Select port HTTP(80), HTTPS(443) and SSH(22).
  7. Delete public IP and NIC when VM is deleted: Check this box as needed.
  8. Enable accelerated networking: Ignore this checkbox.

• Moreover, Microsoft Azure also provides load-balancing features. The purpose of this feature is to enhance resource utilization, increase throughput, reduce response times, and prevent any single resource from becoming overloaded.
• This practice is essential for maintaining high availability and reliability of applications and services by evenly distributing workloads. However, Microsoft Azure offers three options you can choose a radio button according to your needs, for that refer to the image depicted below:

Step 4: Configure management options for your Virtual machine

• In this step, you can set up management of your virtual machine and you can configure it according to your requirements and needs.

Step 5: Configure monitoring options for your Virtual machine

• The next step is to configure monitoring of virtual machines. With the help of this feature, you can monitor your virtual machine's Health by setting up Alerts and Diagnosing the issues related to your virtual machine. Please refer to the image mentioned below.

Step 6: Advanced option for your Virtual machine

• In this step, you can enhance configurations by adding additional agents, scripts, or applications through virtual machine extensions or cloud-init. Microsoft Azure makes various options available in this section to set up your virtual machine. You can select the feature you want to add to your virtual machine. Referring to the image below will give you a better understanding.
• Note: Feel free to skip this step, if you don't want to add additional features to your Virtual machine.

Step 7: Create tags for your Virtual machine

• Tags consist of name and value pairs that allow you to classify resources. They facilitate consolidated billing by applying the same tag to multiple resources and resource groups. You can create tags of your own choice and checkmark the resource as per your needs as depicted in the image below.

Step 8: Review And Create A Virtual Machine

• Lastly, you can check all the details you have entered for creating the Virtual machine in Microsoft Azure and after reviewing it, you can click on the Create button as shown in the image below.

Step 9: Allow ServerAvatar port from Microsoft Azure Cloud panel

• The final step is to allow a port so that you can connect your virtual machine server to ServerAvatar. Follow the steps shown in the image below.

1. Go to the Microsoft Azure Dashboard.
2. After that click on your newly created Virtual machine
3. Next, go to the Network settings and create new inbound port rules.
4. Finally, add the details mentioned in the image below.

Congratulations! You have successfully created your instance in Microsoft Azure which is now ready to connect with ServerAvatar.

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