How to host BookStack on InterServer VPS - 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. InterServer is a dependable hosting option for BookStack, providing scalable infrastructure and simple deployment solutions. ServerAvatar makes it easy and user-friendly to deploy the BookStack application on the InterServer platform.

Create a VPS in InterServer

Getting started with InterServer:

InterServer's Virtual Private Server (VPS) hosting leads their array of hosting solutions, providing businesses and developers a sturdy platform to drive their online endeavors with dependable flexibility. InterServer's VPS hosting leverages cutting-edge technology and infrastructure housed in state-of-the-art data centers. This ensures optimal performance and uptime, crucial for demanding applications and websites. With Interserver's VPS plans, users benefit from dedicated resources including CPU cores, RAM, and storage, providing a scalable environment capable of handling varying levels of traffic and resource requirements.

Interserver's VPS hosting stands out for its cost-effectiveness while maintaining high performance and a rich feature set. Their range of VPS plans caters to diverse needs, accommodating startups, small businesses, and large enterprises with tailored solutions. Whether you're launching a new project, migrating an existing site, or seeking to upgrade to a more robust hosting solution, Interserver's VPS hosting offers the performance, scalability, and support needed to succeed in today's digital landscape.

Let’s get started with creating the virtual private server in Interserver, for that follow the steps given below.

Step 1: Accessing Your InterServer Account

• First, log in to InterServer account. If you are new to InterServer, click on the Sign Up to register with InterServer. Refer to the below image.

Step 2: Create VPS in InterServer

• After you log in to your InterServer account, the Dashboard of InterServer will appear. You can see various sections like Domains, Web Hosting, Licenses, Storage, and Dedicated Servers. However, you have to click on the Order Now button in the VPS section to create a fresh VPS.

Step 3: Configuring the VPS in InterServer

• First you need to choose the Platform for your VPS. It should be a kernel-based virtual machine (KVM).
• Now you have to select the location of your VPS. Make sure to select a server location closest to your major traffic source demographically.
• Then you have to select the Slices. It is the number of cores on your server, which you can select according to your requirements.
• Moreover, you have to choose image i.e. an operating system running on the server. So here you have to select an OS for your server along with its versions. Generally, the BookStack application requires Ubuntu 20.04 LTS or a later version for compatibility and support. If you are managing your servers with ServerAvatar, Select Ubuntu 20.04 x64 bit or Ubuntu 22.04 x64 bit.
• In addition to this you have to set the root password for your VPS of your own choice. After filling up all the necessary details for your VPS Click on the Continue button.

Step 4: Review your VPS details

• Here you have to verify the details of your virtual machine, select the agreed terms checkbox, and click on the Place Order button to create VPS.

Step 5: Make a payment for your VPS

• The final step is to make a payment for your VPS, so for that, you have to Add Billing Address and verify your order of VPS. There are various modes of payment available to make a payment for your VPS. Select the mode as per your convenience.

• Congratulations! You have successfully created your instance in InterServer 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: Log in 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.