How to host YOURLS on Google Cloud 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. When choosing a hosting platform for YOURLS, opting for Google Cloud ensures reliability with its scalable infrastructure and straightforward deployment options. ServerAvatar makes the deployment of the YOURLS application on the Google Cloud platform an easy step-by-step process.

Create a VM Instance in Google Cloud

Getting started with Google Cloud:

Google is one of the most famous and reliable cloud providers among all of its competitors in the market. Google Cloud Platform provides a robust and comprehensive set of cloud computing services, catering to diverse business needs from startups to large enterprises. With its focus on scalability, performance, security, and innovation, GCP enables organizations to build, deploy, and scale applications and services efficiently in the cloud. Whether it's computing, storage, data analytics, machine learning, or networking, GCP offers a powerful and flexible platform for modern cloud computing requirements.

Google Cloud Platform’s Compute Engine offers robust virtual machine capabilities designed to meet the needs of modern cloud computing environments. Whether you’re looking for flexibility, scalability, performance, or integration with other Google Cloud services, Compute Engine provides a comprehensive solution for running your applications and workloads in the cloud efficiently and securely. Here’s a detailed introduction to Google Cloud as a virtual machine provider:

• Compute Engine as a primary service: It allows you to quickly scale VMs up or down based on demand, allowing you to handle varying workloads effectively. Users have the flexibility to select VM instance types tailored to their needs for CPU, memory, and disk capacities. Google provides predefined machine types optimized for different tasks, or you can customize machine types to allocate resources according to specific requirements.
• Key Features and Capabilities: It provides preemptible VMs at a greatly reduced price, ideal for fault-tolerant and batch-processing tasks. VM instances can be migrated live between host systems without any downtime, ensuring exceptional availability and reliability. Users have the option to either create custom VM images or utilize Google's pre-built images for quick deployment of popular software configurations.
• Integration with Google Services: It offers Control access and permissions for VM instances by managing IAM roles and policies. Compute Engine seamlessly integrates with Google Cloud's VPC networking, enabling the creation of secure and isolated networks tailored for your VMs. It also supports VPNs, Cloud Interconnect, and Google Cloud Load Balancing to efficiently manage network traffic. Moreover, Google's Deployment Manager can be used to automate the creation and management of VMs and associated resources following Infrastructure-as-Code principles.
• Management and Monitoring: Administer VM instances using the Google Cloud Console, which offers a graphical interface for deploying, monitoring, and managing resources. Engage with Compute Engine programmatically through Google Cloud SDK tools and APIs, enabling automation and seamless integration with other systems.
• Security and Compliance: Compute Engine incorporates security features such as encryption of data at rest and in transit, secure boot, and IAM controls to safeguard VM instances and data. Google Cloud Platform adheres to various compliance standards (e.g., ISO, SOC, GDPR), providing assurances for regulatory requirements across different industries.

Let’s get started with creating a Virtual Machine on the Google Cloud Platform:

Step 1: Creating a VM in Google Cloud Platform

• Click on the below link and log in to your Google account.

  • https://console.cloud.google.com

• Here you can create a New project or you can select the project you want, and then click on Create a VM as shown in the image below.

Step 2: Creating a VM Instance

• For creating a VM instance click on the sidebar, select the Compute Engine, and then click on the VM instances and Create Instance, as depicted in the images below.

Step 3: Configuring a New VM Instance

• Click on New VM Instance, here you can give Name to your virtual machine. Additionally, you can select the Region and Zone of your choice. Moreover, you can select the machine according to your needs from the available types. Refer to the image below.

Step 4: Select the Machine type

• Now you have the option to select a Machine Type with predefined configurations of vCPUs and memory which is suitable for most workloads. In addition to this, you can also add Availability policies according to your needs. (Recommended Standard policy)

• Also, you can customize your machine that is suitable for your workload as shown in the image below.

Step 5: Select the Boot disk

• In this step, you have to select the Operating System for your instance. Click on the Change button to select the boot disk as shown in the image below.

• Generally, the YOURLS application requires Ubuntu 18.04 LTS or a later version for compatibility and support. We recommend you to use Ubuntu 20.04 LTS x64 or Ubuntu 22.04 LTS x64. If you are using ServerAvatar to manage your instance, these operating systems are required.
• Moreover, you can select the disk type you want; however, we recommend you select a Balanced persistence disk with a minimum 25 GB disk size, then click on the Select button as depicted in the following image.

Step 6: Firewall rules

• The next step is to allow firewall rules that are available at the time of creating an instance in Google. Select the checkbox next to the HTTP and HTTPS to allow incoming traffic. Click on the Create button to create a VM instance in Google as shown in the image below.

Step 7: Creating New Firewall Rule

• Now, you have to go to the VPC network by clicking on the sidebar and then click on the Firewall section. After that click on Create Firewall Rule as shown in the images below.

• Here you have to enter the details such as the Name of the rule and its description. You can also turn on firewall logs. In addition to this leave the network and priority sections as default. The direction of traffic should be Ingress and Allow the action. In the Targets section, you have three options: All instances in the network, Specified target tags, and Specified service accounts, select from them according to your needs. Furthermore, set the Source filter to IPv4 ranges you can specify the ranges as per your requirement in the Source IPv4 ranges input field. To understand it better refer to the image below.

• Lastly, you need to specify the Protocols and ports. ServerAvatar requires 43210 port to be open and the protocol is TCP so add the port number in that field and click on Create as shown in the image below.

• Congratulations! You have successfully created your instance in Google Cloud 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

• After filling out the details, click on the Create Application button as shown in the image.

• 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.

• In the public_html folder navigate to the User folder. Select the config-sample.php file in the user folder and click on the 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: Access YOURLS

• Now, to access the YOURLS application, open the web browser. Enter the domain of your site and add /admin after the domain as mentioned in the below example.

  • Example: http://your-application-domain/admin

• It will redirect you to the Yourls application's 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