mirror of
https://github.com/linuxserver/docker-bookstack.git
synced 2026-02-20 02:30:30 +08:00
115 lines
5.2 KiB
YAML
115 lines
5.2 KiB
YAML
---
|
|
|
|
# project information
|
|
project_name: bookstack
|
|
project_url: "https://github.com/BookStackApp/BookStack"
|
|
project_logo: "https://s3-us-west-2.amazonaws.com/linuxserver-docs/images/bookstack-logo500x500.png"
|
|
project_lsio_github_repo_url: "https://github.com/linuxserver/docker-{{ project_name }}"
|
|
project_blurb: |
|
|
[{{ project_name|capitalize }}]({{ project_url }}) is a free and open source Wiki designed for creating beautiful documentation. Feautring a simple, but powerful WYSIWYG editor it allows for teams to create detailed and useful documentation with ease.
|
|
|
|
Powered by SQL and including a Markdown editor for those who prefer it, BookStack is geared towards making documentation more of a pleasure than a chore.
|
|
|
|
For more information on BookStack visit their website and check it out: https://www.bookstackapp.com
|
|
|
|
# supported architectures
|
|
available_architectures:
|
|
- { arch: "{{ arch_x86_64 }}", tag: "amd64-latest"}
|
|
- { arch: "{{ arch_arm64 }}", tag: "arm64v8-latest"}
|
|
- { arch: "{{ arch_armhf }}", tag: "arm32v7-latest"}
|
|
|
|
# container parameters
|
|
param_container_name: "{{ project_name }}"
|
|
param_usage_include_vols: true
|
|
param_volumes:
|
|
- { vol_path: "/config", vol_host_path: "/path/to/data", desc: "this will store any uploaded data on the docker host" }
|
|
param_usage_include_env: true
|
|
param_env_vars:
|
|
- { env_var: "DB_HOST", env_value: "<yourdbhost>", desc: "for specifying the database host" }
|
|
- { env_var: "DB_USER", env_value: "<yourdbuser>", desc: "for specifying the database user" }
|
|
- { env_var: "DB_PASS", env_value: "<yourdbpass>", desc: "for specifying the database password" }
|
|
- { env_var: "DB_DATABASE", env_value: "bookstackapp", desc: "for specifying the database to be used" }
|
|
|
|
param_usage_include_ports: true
|
|
param_ports:
|
|
- { external_port: "6875", internal_port: "80", port_desc: "will map the container's port 80 to port 6875 on the host" }
|
|
|
|
opt_param_usage_include_env: true
|
|
opt_param_env_vars:
|
|
- { env_var: "APP_URL", env_value: "http://your.site.here.xyz", desc: "for specifying the url your application will be accessed on (required for correct operation of reverse proxy)"}
|
|
|
|
custom_compose: |
|
|
---
|
|
version: "2"
|
|
services:
|
|
bookstack:
|
|
image: linuxserver/bookstack
|
|
container_name: bookstack
|
|
environment:
|
|
- PUID=1000
|
|
- PGID=1000
|
|
- DB_HOST=bookstack_db
|
|
- DB_USER=bookstack
|
|
- DB_PASS=<yourdbpass>
|
|
- DB_DATABASE=bookstackapp
|
|
volumes:
|
|
- /path/to/data:/config
|
|
ports:
|
|
- 6875:80
|
|
restart: unless-stopped
|
|
depends_on:
|
|
- bookstack_db
|
|
bookstack_db:
|
|
image: linuxserver/mariadb
|
|
container_name: bookstack_db
|
|
environment:
|
|
- PUID=1000
|
|
- PGID=1000
|
|
- MYSQL_ROOT_PASSWORD=<yourdbpass>
|
|
- TZ=Europe/London
|
|
- MYSQL_DATABASE=bookstackapp
|
|
- MYSQL_USER=bookstack
|
|
- MYSQL_PASSWORD=<yourdbpass>
|
|
volumes:
|
|
- /path/to/data:/config
|
|
restart: unless-stopped
|
|
|
|
# application setup block
|
|
app_setup_block_enabled: true
|
|
app_setup_block: |
|
|
|
|
The default username is admin@admin.com with the password of **password**, access the container at http://dockerhost:6875.
|
|
|
|
This application is dependent on a MySQL database be it one you already have or a new one. If you do not already have one, set up our MariaDB container here https://hub.docker.com/r/linuxserver/mariadb/.
|
|
|
|
|
|
If you intend to use this application behind a subfolder reverse proxy, such as our LetsEncrypt container or Traefik you will need to make sure that the `APP_URL` environment variable is set, or it will not work
|
|
|
|
Documentation for BookStack can be found at https://www.bookstackapp.com/docs/
|
|
|
|
### Advanced Users (full control over the .env file)
|
|
If you wish to use the extra functionality of BookStack such as email, Memcache, LDAP and so on you will need to make your own .env file with guidance from the BookStack documentation.
|
|
|
|
When you create the container, do not set any arguments for any SQL settings, or APP_URL. The container will copy an exemplary .env file to /config/www/.env on your host system for you to edit.
|
|
|
|
#### PDF Rendering
|
|
[wkhtmltopdf](https://wkhtmltopdf.org/) is available to use as an alternative PDF rendering generator as described at https://www.bookstackapp.com/docs/admin/pdf-rendering/.
|
|
|
|
The path to wkhtmltopdf in this image to include in your .env file is `/usr/bin/wkhtmltopdf`.
|
|
|
|
|
|
# changelog
|
|
changelogs:
|
|
- { date: "19.12.19:", desc: "Rebasing to alpine 3.11." }
|
|
- { date: "26.07.19:", desc: "Use old version of tidyhtml pending upstream fixes." }
|
|
- { date: "28.06.19:", desc: "Rebasing to alpine 3.10." }
|
|
- { date: "14.06.19:", desc: "Add wkhtmltopdf to image for PDF rendering." }
|
|
- { date: "20.04.19:", desc: "Rebase to Alpine 3.9, add MySQL init logic." }
|
|
- { date: "22.03.19:", desc: "Switching to new Base images, shift to arm32v7 tag." }
|
|
- { date: "20.01.19:", desc: "Added php7-curl"}
|
|
- { date: "04.11.18:", desc: "Added php7-ldap"}
|
|
- { date: "15.10.18:", desc: "Changed functionality for advanced users"}
|
|
- { date: "08.10.18:", desc: "Advanced mode, symlink changes, sed fixing, docs updated, added some composer files"}
|
|
- { date: "23.09.28:", desc: "Updates pre-release"}
|
|
- { date: "02.07.18:", desc: "Initial Release." }
|