Skip to main content

📌 Configuring Parameters for main stack

Step 1. Prerequisite - Prepare template

Choose an existing template→Specify template→Amazon S3 URL→ here paste the URL template https://devsecopsinc-bookstack.s3.us-east-1.amazonaws.com/main-template.yml. And click Next button.

3-Step 1.jpeg

Step 2. Specify stack details

Here, you need to fill in the Stack name. The name should follow this naming convention:
${Product}-${Environment}-main (e.g., bookstack-dev-main).

4-Step 2 Name.jpeg

There are 21 parameters some of which are predefined. You don’t need to fill in all of them — just focus on the required and empty fields. For additional guidance, refer to the help description provided under each parameter.

4-Step 2 Parameters.jpeg

7 Required Rarameters:

1. Deployment Environment – Specify the environment (e.g., dev, prod).

2. Product Name - We recommend always using bookstack.

   (For optional parameters, you can leave the string blank, as we did with CostAllocationTag.)

3.  AppURL – Define the URL where BookStack will be accessible.

4. VPC ID – Enter the ID of an existing VPC.

5. VPC CIDR block – Provide the CIDR block of your existing VPC.

6. Subnet IDs – Enter the IDs of your existing subnets (e.g., Subnet 1 ID, Subnet 2 ID).

4-2 Step 2 Parameters.png

7. SSL Certificate ARN – Provide the ARN of your SSL Certificate for the ALB. (If you don’t have one, you must create it.)

4-3 Step 2 Parameters.png

Override Optional Parameters

Some parameters have predefined default values. You can modify them as needed or leave them unchanged:

EC2 instance type (t4g.small is recommended for small environments).

RDS DB instance type (db.t4g.small is the default).

RDS storage size (20 GB by default).

Multi-AZ deployment (set to false for cost efficiency).

Enable/Disable RDS backups.

Enable/Disable RDS deletion protection.

• Schedule backup rules.

Schedule backup deletion.

Остановился тут ⬇️

1️⃣ Launching the CloudFormation Stack

1. Click Next and review your configuration.

2. On the next page, check the box for I acknowledge that AWS CloudFormation might create IAM resources with custom names.

3. Click Create stack.

2️⃣ Retrieving the Access URL

1. After successful deployment, navigate to the Outputs tab in CloudFormation.

2. Locate AppURL → this is your final BookStack access URL.

3. If using a custom domain, create a CNAME record in your DNS registrar, pointing AppURL to LoadBalancerDNSName.

3️⃣ Accessing BookStack

1. Open AppURL in your browser.

2. Log in using the default credentials:

Username: admin@admin.com

Password: password

3. Change your password immediately! You can do this under Profile → Settings.

Additional Information

Application logs are available in CloudWatch Logs.

Data is stored in RDS, while Bookstack files are stored on Amazon EFS.

Deletion: If needed, delete the main CloudFormation Stack to remove all associated resources automatically. ⚠ Important Notice! Before proceeding, navigate to AWS Backup → Vaults → your-backup-vault-name → Recovery Points. Select all recovery points, click the Action button, and choose Delete. This will remove all EFS backups.
Otherwise, deleting the CloudFormation stack will result in an error.
Bookstack aws backup.png