diff --git a/README.md b/README.md index 0eac786..995393e 100644 --- a/README.md +++ b/README.md @@ -77,7 +77,7 @@ docker create \ -e DB_DATABASE=bookstackapp \ -e APP_URL=http://your.site.here.xyz `#optional` \ -p 6875:80 \ - -v :/config \ + -v /path/to/data:/config \ --restart unless-stopped \ linuxserver/bookstack ``` @@ -102,7 +102,7 @@ services: - DB_PASS= - DB_DATABASE=bookstackapp volumes: - - :/config + - /path/to/data:/config ports: - 6875:80 restart: unless-stopped @@ -120,7 +120,7 @@ services: - MYSQL_USER=bookstack - MYSQL_PASSWORD= volumes: - - :/config + - /path/to/data:/config restart: unless-stopped ``` @@ -183,7 +183,7 @@ 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 .env file to /config/www/.env on your host system for you to edit. 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. +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/. diff --git a/readme-vars.yml b/readme-vars.yml index 89e9594..1bac271 100644 --- a/readme-vars.yml +++ b/readme-vars.yml @@ -22,7 +22,7 @@ available_architectures: param_container_name: "{{ project_name }}" param_usage_include_vols: true param_volumes: - - { vol_path: "/config", vol_host_path: "", desc: "this will store any uploaded data on the docker host" } + - { 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: "", desc: "for specifying the database host" } @@ -53,7 +53,7 @@ custom_compose: | - DB_PASS= - DB_DATABASE=bookstackapp volumes: - - :/config + - /path/to/data:/config ports: - 6875:80 restart: unless-stopped @@ -71,7 +71,7 @@ custom_compose: | - MYSQL_USER=bookstack - MYSQL_PASSWORD= volumes: - - :/config + - /path/to/data:/config restart: unless-stopped # application setup block @@ -90,7 +90,7 @@ app_setup_block: | ### 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 .env file to /config/www/.env on your host system for you to edit. 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. + 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/.