How to host BookStack on Azure VM Instance - ServerAvatar

Bookstack is an open-source platform designed for organizations seeking to simplify the creation of status pages. It provides essential features for managing and sharing service statuses, ensuring ease of access for both administrators and users. When considering hosting BookStack, deploying it on Azure is a dependable choice due to its scalable infrastructure and user-friendly deployment solutions. ServerAvatar assists with Azure VPS and simplifies the deployment of the BookStack application on the Azure platform through easy steps.

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: 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 BookStack wiki software with ServerAvatar

Step 1: Create a PHP application

On the ServerAvatar server panel, navigate to the Applications tab and click the Create button like the following image.

1. Fill up basic details

In the first step of the application creation, fill in the basic details, including, Application Name, select the application type, and type Primary Domain/Test Domain Name.

note that:

If you want to host BookStack on your domain, then make sure to point your domain to the current IP address of your server, and for that:

1. Log in to your domain provider site, where you buy your domain. Click here for more info about your domain name.
2. Access DNS Manager to edit your DNS records(contact the support team if you don’t find them)
3. Change the IP address of A Record of your website to the current server’s IP address. To host BookStack on your subdomain, for example, bookstack.yourdomain.com, create a new application with the subdomain as your primary domain and follow the same procedure. For accessing BookStack on the subdomain, you need to add your subdomain on A Record that points to the current IP address of your server. To point to an IPV6 address, you would need to use an AAAA record.

Click the Next Step to continue.

2. Select an application creation method

BookStack is an open-source project. It can be available on GitHub, so you can directly clone the repository with Serveravatar. In this step-

1. Select the Git method and GitHub as a service provider.
2. Mark on Public repository.
3. Type BookStack project URL from the GitHub BookStack project. You‘ll find it as shown in the following image.

4. Enter the release branch name in the branch field.
5. Type the below commands in the deployment script.

cp .env.example .env 

composer install --no-dev 

php artisan key:generate --force

3. Allocate system user

Allocate a system user for your BookStack application. You can create a new system user or select an existing system user.

Click the Next Step button to continue.

4. Other options

Select a PHP version for your application, and set Custom Webroot as Public in the respective field.

Click the Next Step button.

5. Review your application details

Review your application details and click the Create Application button.

Upon creating an application, the repository can be successfully cloned to your application Public_html folder.

Step 2: Create BookStack Database

To create a database for the BookStack application, go to the server panel, navigate to the Database tab, and click the Create button like the following image.

On the next screen, fill up the database details, including -

• Database Name
• Database Username
• Database Password

Click the Create Database to continue.

Step 3: Delete the .env.example file and Update the Database Information and App URL

To delete the .env.example file, go to Application Panel>>File Manager And access the public_html folder. Now click the Show Hidden Files box. The .env.example file can be shown at the top of the files, like the following image.

Now open the .env file and update the details with the database we created in the above step. It includes- DB_DATABASE: Database Name DB_USERNAME: Database Username DB_PASSWORD: Database Password

After that, update the app URL just above the file's database information. Note that if you install SSL on your application, type https:// before your domain name; otherwise, type http:// in the code.

Step 4: Update the Database Schema

It is necessary to keep your database up to date. And for that, log in to your application using an SSH connection. You can see the credentials in the application dashboard as the following image.

Note: Make sure the SSH connection toggle is enabled on your application.

Execute the following command in your terminal to log in to your application-

ssh Username@Host

Now go to your application path using “cd Application_Name/public_html” and execute the following command.

php artisan migrate - -force

After the successful migration of the database, access the URL of your application in the web browser.

Step 5: Login to BookStack

Upon accessing the URL, the login page will appear. You can now log in using the default admin details admin@admin.com and password of password. You can change these details immediately after logging in for the first time.

You’ll see the admin screen like the following image upon logging in.

You can now perform administrative tasks to manage your documentation and knowledge base website.