How to host BookStack on AWS EC2 VM Instance - ServerAvatar

Bookstack is an open-source platform designed 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. When considering hosting BookStack, AWS EC2 offers a dependable and scalable solution. AWS EC2 provides a wide range of instance types and configurations to match various performances with flexible deployment options. ServerAvatar makes the deployment of the BookStack Application on the AWS EC2 platform straightforward through a simplified process.

Create an AWS EC2 Instance

Getting Started with AWS EC2:

In the dynamic landscape of cloud computing, Amazon EC2 (Elastic Compute Cloud) stands as a cornerstone service provided by Amazon Web Services (AWS), offering a flexible and scalable solution for hosting virtual servers in the cloud. Designed to cater to a diverse range of computing needs, EC2 allows businesses and developers to deploy virtual machines quickly and securely, enabling them to run various applications and manage workloads with ease.

From startups seeking cost-effective computing power to enterprises requiring robust, scalable infrastructure, EC2 provides a vast array of instance types optimized for different use cases. These instances offer customizable configurations, including computing power, memory, storage, and networking capabilities, empowering users to tailor their virtual environments precisely to their application requirements.

Whether it's launching a single instance for a small-scale project or orchestrating a complex network of instances across multiple regions, EC2 simplifies the process with its intuitive management console and comprehensive APIs. This versatility makes it a preferred choice for businesses looking to leverage the scalability and reliability of cloud computing without the overhead of managing physical hardware.

Using AWS EC2 instances offers a multitude of benefits that cater to diverse business needs and technical requirements. Here are some key advantages:

• Scalability: EC2 enables swift adjustments to your computing capacity according to demand, offering elasticity that efficiently manages fluctuating workloads for businesses, preventing resource over-provisioning.
• Cost-Effectiveness: With EC2, you pay only for the compute capacity you use. This pay-as-you-go pricing model eliminates the need for upfront investments in hardware and allows for cost optimization by scaling resources as needed.
• Flexibility: EC2 provides a diverse range of instance types tailored for various use cases, including compute-optimized, memory-optimized, storage-optimized, and GPU instances. This versatility allows you to select the ideal instance type that best suits your specific application needs.
• Security: AWS offers a secure environment for hosting EC2 instances, incorporating features such as security groups, network access control lists (ACLs), and Virtual Private Clouds (VPCs) to manage network access effectively. Integration with other AWS services, such as AWS Identity and Access Management (IAM), further enhances security by providing detailed access control capabilities.
• Ease of Use: EC2 instances can be easily launched, managed, and configured using the AWS Management Console, Command Line Interface (CLI), or SDKs/APIs. Automation tools like AWS CloudFormation and AWS Elastic Beanstalk further simplify deployment and management tasks.
• Reliability: AWS ensures a high level of reliability for EC2 instances with SLAs that guarantee a specific level of uptime. Additionally, EC2 instances can be configured to automatically recover from failures using features like Auto Scaling and Amazon Elastic Block Store (EBS) snapshots.

Let’s Get started with Creating a Virtual Machine on AWS EC2:

To create a server in Amazon. First log in to Amazon web service. Once you are there, Follow the steps given below.

Step 1: Search for the EC2 service in the AWS search bar

• The first step is to search for EC2 services, as Amazon provides multiple web services. Then click on the EC2 with virtual servers in the cloud option which is shown in the image below.

Step 2: Launching Instances from the EC2 Dashboard

• Now you are in the EC2 Dashboard, navigate to the running instances section. After that new tab for instances will be displayed there you have to click on the Launch Instances button as shown in the images below.

Step 3: Naming and Tagging Your EC2 Instance

• The next step is to name the instance of your choice and you can also add tags to your instance which can help organize, manage, and track resources.

Step 4: Select the OS for your Instance

• After following the steps, proceed to select the operating system for your instance. Generally, the BookStack application required Ubuntu 20.04 LTS or a later version for compatibility and support.
• Click on Ubuntu and then select the Amazon Machine Image of Ubuntu Server 22.04 LTS as an operating system. In addition to this, select the architecture to 64-bit(x64/86) as shown in the image below.

Step 5: Select the Instance type

• In this step, select the size of your VM instance. AWS EC2 provides lots of different options when it comes to plans and pricing. The selection of instances completely depends on the requirements. So, select the instance based on the complexity and traffic of your sites.

Step 6: Select SSH Key pair or create one

• Here you can select the Key pair name for SSH. If you don't have any key pair stored, you can also create a new key pair by clicking on the Create new key pair option as shown in the following image.

Step 7: Configuring Network Settings

• In this step, you have to configure the network by simply clicking on the Edit button as shown in the following image.

• Then you have to create a new security group by selecting the create security group radio button. You can enter the security group name of your choice and can also add a description for your security group for that you can refer to the image below.

Step 8: Add Inbound Security Group Rules

• The next step is to add inbound security group rules which are necessary to configure for connecting your instance to ServerAvatar. Click on the button shown in the image below to add security group rules.

• ServerAvatar requires 43210 port to be open. In total, You need to keep the following ports open on the instance.
  • 22 (SSH): To access your server via SSH
  • 80 (HTTP): To access your sites on HTTP
  • 443 (HTTPS): To access your sites on HTTPS
  • 43210 (ServerAvatar): To allow communication between ServerAvatar and your instance
• To understand and proceed further, please take the reference of the image depicted below.

Step 9: Configure the storage for your instance

• The final step is to configure the storage. You can select the size of the storage according to your needs. However, it is recommended to select at least 25GB disk volume, and in AWS EC2 there is also an option to select the root volume which you can choose as per your requirements. Now click on the Launch Instance button, as shown in the image below.

• Congratulations! You have successfully created your AWS EC2 Instance 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 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.