How to host BookStack on SSD Nodes Server - 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. SSD Nodes serves as a reliable hosting choice for Bookstack, offering scalable infrastructure and straightforward deployment options. ServerAvatar facilitates a user-friendly experience for deploying the Bookstack application on the SSD Nodes platform.

Create a Server in SSD Nodes

Getting started with SSD Nodes:

Discover how to create an account and set up a cloud VPS on SSDNodes, a top hosting provider. Follow our simple, step-by-step guide to get your account up and running quickly and easily, so you can start managing your hosting services today.

SSDNodes offers dependable and scalable hosting solutions to individuals and corporations because of its speed and affordability. They provide an infrastructure to host webpages, software, and other internet services effectively.

Step 1: Setup Cloud VPS with SSD Nodes

• First, log in to your SSD Nodes account and navigate to the Servers option. Next, click on Purchase a New Server from the dropdown menu.

Step 2: Select the plan

• SSD Nodes Offer two Different VPS plans:
  1. Standard VPS
  2. Performance VPS
• You have to select a Plan according to your needs. After selecting your plan just click on Get Started.

Step 3: Finalizing Your VPS Selection

• In the following step, You will see the summary of your selected VPS Plan. Click Proceed to Checkout if you are satisfied with the plan you have chosen, or select Customize Your Own Server to modify your VPS server according to your requirements.

Step 4: Customizing the VPS Configuration

• You can see your selected plan as shown in the below image.

• You can select the billing cycle based on your requirements.

• You have the option to select a server location that is more convenient for you. It is recommended to select the location that is closest to your audience. It means that for the majority of your audience, Your sites will load faster due to lower latency.

• Now, you have to select your preferred operating system. Generally, the BookStack application requires Ubuntu 20.04 LTS or a later version for compatibility and support. ServerAvatar supports Ubuntu 20.04 LTS and Ubuntu 22.04 LTS. Therefore, choose one of these supported operating systems.

• Now, there is an Advance Options section where you can configure settings according to your requirements, Additionally, you can add a Public SSH Key and specify the Server's Name and Description. Once you've set up your Advanced Options, proceed to the payment checkout.

• Review and confirm all the choices you've made for your VPS and Click on the Proceed to Checkout option.

Step 5: Finalizing Your Order and VPS Deployment

• Now, you need to confirm and complete the payment, also you can review the Order Summary on the same page as shown in the image below. After you've completed the payment process, your VPS will be set up quickly and will be ready for use in a minimum amount of time.

• Congratulations! You have successfully created your SSD Nodes VPS, 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 image below.

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.