How to host BookStack on Contabo VM Instance - ServerAvatar

BookStack is a web-based software application for creating and managing documentation and knowledge bases. It provides a platform for teams and individuals to collaboratively create and organize content such as articles, notes, and documentation into a hierarchical structure. Hosting BookStack on Contabo VPS provides a reliable and scalable solution. Contabo's VPS plan delivers a robust infrastructure and simple deployment options. ServerAvatar simplifies the process by offering an easy-to-follow, step-by-step setup for your BookStack application on Contabo's VPS.

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. The minimum requirements for hosting BookStack are 2GB or more of RAM for better performance and at least 1GB of free disk space for the BookStack application depending on your usage and data storage needs.

Here, you can 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. We recommend using Ubuntu 20.04 LTS x64 or Ubuntu 22.04 LTS x64. Ubuntu is known for its ease of configuration and management. 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 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 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 shown in 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.