Day 11: Bookstack – An Open-Source Wiki Platform – 7 Days of Docker

In the era of digital documentation, having an efficient wiki platform is crucial for knowledge sharing and team collaboration. BookStack provides an intuitive, scalable, and open-source solution that enables users to efficiently manage, search, and categorize documentation in a user-friendly way.

Why Choose BookStack?

BookStack stands out for several reasons:

• Open-Source & Free: Available for anyone to use and modify, ensuring transparency and community-driven development
• Scalability: Can handle requirements from small teams to enterprise-level deployments
• Customizable: Allows various integrations and modifications to fit specific needs
• User-Friendly Interface: Designed for smooth navigation with an intuitive UI that organizes content into Books, Chapters, and Pages

Why Use Docker for BookStack?

Docker provides several advantages when deploying BookStack:

• Simplified installation without manually configuring PHP, web servers, or databases
• Consistent environment across different systems
• Easy updates with minimal downtime
• Isolation from other applications on your server

System Requirements

BookStack doesn’t officially list minimum system requirements in their documentation, but based on common usage:

• Recommended: Modern CPU, at least 1GB RAM (more for larger instances)
• Database: MySQL 8.0+ or MariaDB
• PHP: PHP 8.1+ (handled by the Docker container)
• Web Server: Apache or Nginx (handled by the Docker container)
• Browsers: Modern browsers like Chrome, Firefox, Safari, Edge

Setting Up BookStack in Docker

Using Docker to run BookStack simplifies deployment and maintenance. Here’s how you can set it up:

1. Create a Docker Compose File

First, create a new directory for your BookStack installation:

mkdir bookstack
cd bookstack

Create a docker-compose.yml file:

version: '3'
services:
  bookstack:
    image: lscr.io/linuxserver/bookstack:latest
    container_name: bookstack
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Europe/London
      - APP_URL=http://your-domain.com
      - DB_HOST=bookstack_db
      - DB_USER=bookstack
      - DB_PASS=your_database_password
      - DB_DATABASE=bookstack
    volumes:
      - ./bookstack_data:/config
    ports:
      - 8080:80
    restart: unless-stopped
    depends_on:
      - bookstack_db
    
  bookstack_db:
    image: lscr.io/linuxserver/mariadb:latest
    container_name: bookstack_db
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Europe/London
      - MYSQL_ROOT_PASSWORD=your_root_database_password
      - MYSQL_DATABASE=bookstack
      - MYSQL_USER=bookstack
      - MYSQL_PASSWORD=your_database_password
    volumes:
      - ./bookstack_db_data:/config
    restart: unless-stopped

Remember to replace:

• your-domain.com with your actual domain or IP address
• your_database_password with a strong password
• your_root_database_password with another strong password
• Adjust the timezone (TZ) to match your location

2. Launch BookStack

Start the containers with:

docker-compose up -d

3. Access BookStack

Once the containers are running, open your browser and go to:

You should now see the BookStack login interface. The default credentials are:

• Email: admin@admin.com
• Password: password

Important: Change these default credentials immediately after your first login!

Key Features

• Organized Structure: Content arranged in a hierarchical Books > Chapters > Pages system
• WYSIWYG Editor: Easy-to-use editor with markdown support for formatting
• Advanced Search: Powerful search functionality to quickly find relevant information
• Role-Based Permissions: Control who can view, create, and edit content
• Page Revisions: Track changes and restore previous versions when needed
• API Access: Integration capabilities through the BookStack API
• Mobile Responsive: Access from any device with a fully responsive design

Use Cases

• Internal Documentation: Create a centralized repository for company information
• Project Management: Document project requirements and processes
• Technical Documentation: Maintain detailed technical guides and references
• Knowledge Base: Build a searchable library of information for your team

Community and Support

BookStack benefits from an active open-source community that continuously contributes to its development. Users can:

• Get Help: Access the community forum and official documentation
• Report Issues: Submit bug reports via the GitHub repository
• Contribute: Participate in development through code contributions or documentation
• Learn More: Visit the official BookStack website

With Docker simplifying the deployment process, BookStack offers an excellent solution for teams and organizations seeking a robust, open-source documentation platform that’s easy to set up and maintain.