Skip to content

Latest commit

 

History

History
143 lines (106 loc) · 4.33 KB

README.md

File metadata and controls

143 lines (106 loc) · 4.33 KB
Raw

Docker Image For BookStack

Build Status Latest release GitHub contributors

Changes

Versions higher than 23.6.2 no longer use an in-container .env file for environment variable management. Instead, the preferred approach is to manage them directly with the container runtime (e.g. Docker's -e). This is to simplify troubleshooting if and when errors occur. The most important change is that ${APP_KEY} is no longer provided for you, instead it is up to the operator to ensure this value is present. Versions prior to this supplied ${APP_KEY} (with a default of SomeRandomStringWith32Characters. A full reference of available environment variables is available in the Bookstack repository

The version 23.6.0 is broken due to a bad .env configuration created by the entrypoint script. This is fixed in version 23.6.0-1.

In 0.28.0 we changed the container http port from 80 to 8080 to allow root privileges to be dropped

In 0.12.2 we removed DB_PORT . You can now specify the port via DB_HOST like DB_HOST=mysql:3306

Quickstart

With Docker Compose is a Quickstart very easy. Run the following command:

docker-compose up

and after that open your Browser and go to http://localhost:8080 . You can login with username admin@admin.com and password password.

Issues

If you have any issues feel free to create an issue on GitHub.

How to use the Image without Docker compose

Note that if you want to use LDAP, $ has to be escape like \$, i.e. -e "LDAP_USER_FILTER"="(&(uid=\${user}))"

Networking changed in Docker v1.9, so you need to do one of the following steps.

Docker < v1.9

  1. MySQL Container:

    docker run -d \
-p 3306:3306 \
-e MYSQL_ROOT_PASSWORD=secret \
-e MYSQL_DATABASE=bookstack \
-e MYSQL_USER=bookstack \
-e MYSQL_PASSWORD=secret \
--name bookstack_db \
mysql:5.7.21

  2. BookStack Container:

    docker run -d --link bookstack_db_:mysql \
-p 8080:8080 \
--name bookstack_24.2.2 \
solidnerd/bookstack:24.2.2

Docker 1.9+

  1. Create a shared network:

    docker network create bookstack_nw

  2. Run MySQL container :

    docker run -d --net bookstack_nw  \
-e MYSQL_ROOT_PASSWORD=secret \
-e MYSQL_DATABASE=bookstack \
-e MYSQL_USER=bookstack \
-e MYSQL_PASSWORD=secret \
 --name="bookstack_db" \
 mysql:5.7.21

  3. Run BookStack Container

    docker run -d --net bookstack_nw \
-e DB_HOST=bookstack_db:3306 \
-e DB_DATABASE=bookstack \
-e DB_USERNAME=bookstack \
-e DB_PASSWORD=secret \
-e APP_URL=http://example.com \
-p 8080:8080 \
--name="bookstack_24.2.2" \
 solidnerd/bookstack:24.2.2

    The APP_URL parameter should be the base URL for your BookStack instance without a trailing slash. For example:

    APP_URL=http://example.com

    The following environment variables are required for Bookstack to start:

    • APP_KEY
    • APP_URL
    • DB_HOST (in the form ${hostname_or_ip_address}:${port})
    • DB_DATABASE
    • DB_USERNAME
    • DB_PASSWORD

Volumes

To access your .env file and important bookstack folders on your host system change <HOST> in the following line to your host directory and add it then to your run command:

--mount type=bind,source=<HOST>/.env,target=/var/www/bookstack/.env \
-v <HOST>:/var/www/bookstack/public/uploads \
-v <HOST>:/var/www/bookstack/storage/uploads

In case of a windows host machine the .env file has to be already created in the host directory otherwise a folder named .env will be created.

After these steps you can visit http://localhost:8080. You can login with username admin@admin.com and password password.

Inspiration

This is a fork of Kilhog/docker-bookstack. Kilhog did the intial work, but I want to go in a different direction.