Skip to content

Commit bcfe590

Browse files
aptalcathelamer
authored andcommitted
update readme
1 parent e356221 commit bcfe590

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ docker create \
7777
-e DB_DATABASE=bookstackapp \
7878
-e APP_URL=http://your.site.here.xyz `#optional` \
7979
-p 6875:80 \
80-
-v <path to data>:/config \
80+
-v /path/to/data:/config \
8181
--restart unless-stopped \
8282
linuxserver/bookstack
8383
```
@@ -102,7 +102,7 @@ services:
102102
- DB_PASS=<yourdbpass>
103103
- DB_DATABASE=bookstackapp
104104
volumes:
105-
- <path to data>:/config
105+
- /path/to/data:/config
106106
ports:
107107
- 6875:80
108108
restart: unless-stopped
@@ -120,7 +120,7 @@ services:
120120
- MYSQL_USER=bookstack
121121
- MYSQL_PASSWORD=<yourdbpass>
122122
volumes:
123-
- <path to data>:/config
123+
- /path/to/data:/config
124124
restart: unless-stopped
125125
126126
```
@@ -183,7 +183,7 @@ Documentation for BookStack can be found at https://www.bookstackapp.com/docs/
183183
### Advanced Users (full control over the .env file)
184184
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.
185185

186-
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.
186+
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.
187187

188188
#### PDF Rendering
189189
[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/.

readme-vars.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ available_architectures:
2222
param_container_name: "{{ project_name }}"
2323
param_usage_include_vols: true
2424
param_volumes:
25-
- { vol_path: "/config", vol_host_path: "<path to data>", desc: "this will store any uploaded data on the docker host" }
25+
- { vol_path: "/config", vol_host_path: "/path/to/data", desc: "this will store any uploaded data on the docker host" }
2626
param_usage_include_env: true
2727
param_env_vars:
2828
- { env_var: "DB_HOST", env_value: "<yourdbhost>", desc: "for specifying the database host" }
@@ -53,7 +53,7 @@ custom_compose: |
5353
- DB_PASS=<yourdbpass>
5454
- DB_DATABASE=bookstackapp
5555
volumes:
56-
- <path to data>:/config
56+
- /path/to/data:/config
5757
ports:
5858
- 6875:80
5959
restart: unless-stopped
@@ -71,7 +71,7 @@ custom_compose: |
7171
- MYSQL_USER=bookstack
7272
- MYSQL_PASSWORD=<yourdbpass>
7373
volumes:
74-
- <path to data>:/config
74+
- /path/to/data:/config
7575
restart: unless-stopped
7676
7777
# application setup block
@@ -90,7 +90,7 @@ app_setup_block: |
9090
### Advanced Users (full control over the .env file)
9191
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.
9292
93-
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.
93+
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.
9494
9595
#### PDF Rendering
9696
[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/.

0 commit comments

Comments
 (0)