Then run bash setup.sh. It stops at the first error and is safe to run again. Servers and tests aren't started; it lists them at the end. Read it first.

1. 1

   Clone the repository

   git clone https://github.com/BookStackApp/BookStack.git
   cd BookStack

   Copy
2. 2

   Install the required runtimes

   Node.js LTS (no version pinned), PHP ^8.3.0

   # needs nvm: https://github.com/nvm-sh/nvm
   nvm install --lts
   sudo apt install php-cli php-mbstring php-xml php-curl unzip composer  # Debian/Ubuntu

   Copy
3. 3

   Configure environment variables

   Fill in secrets: APP_KEY, DB_PASSWORD, MAIL_PASSWORD

   cp .env.example .env

   Copy
4. 4

   Start backing services

   Needs: MySQL, Mail catcher

   # needs Docker Engine: https://docs.docker.com/engine/install/
   docker compose -f docker-compose.yml up -d

   Copy

   If you see Cannot connect to the Docker daemon: start Docker Desktop (or the Docker service) first.
5. 5

   Install dependencies

   npm ci
   composer install

   Copy
6. 6

   Set up the database / app

   php artisan key:generate
   php artisan migrate

   Copy
7. 7

   Run it

   Run each command in its own terminal.

   npm run dev
   php artisan serve

   Copy
8. 8

   Run the tests

   npm test

   Copy