Skip to content

Commit 8f7e4da

Browse files
committed
Tidy readme
1 parent 69d9fd1 commit 8f7e4da

File tree

2 files changed

+12
-11
lines changed

2 files changed

+12
-11
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Powered by SQL and including a Markdown editor for those who prefer it, BookStac
4545

4646
For more information on BookStack visit their website and check it out: https://www.bookstackapp.com
4747

48-
[![bookstack](https://s3-us-west-2.amazonaws.com/linuxserver-docs/images/bookstack-logo500x500.png)](https://github.com/BookStackApp/BookStack)
48+
[![bookstack](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/bookstack-logo.png)](https://github.com/BookStackApp/BookStack)
4949

5050
## Supported Architectures
5151

@@ -99,40 +99,41 @@ To help you get started creating a container from this image you can either use
9999

100100
```yaml
101101
---
102-
version: "2"
103102
services:
104103
bookstack:
105104
image: lscr.io/linuxserver/bookstack
106105
container_name: bookstack
107106
environment:
108107
- PUID=1000
109108
- PGID=1000
109+
- TZ=Europe/London
110110
- APP_URL=https://bookstack.example.com
111111
- DB_HOST=bookstack_db
112112
- DB_PORT=3306
113113
- DB_USER=bookstack
114114
- DB_PASS=<yourdbpass>
115115
- DB_DATABASE=bookstackapp
116116
volumes:
117-
- ./bookstack_app_data:/config
117+
- /path/to/bookstack_app_data:/config
118118
ports:
119119
- 6875:80
120120
restart: unless-stopped
121121
depends_on:
122122
- bookstack_db
123+
123124
bookstack_db:
124125
image: lscr.io/linuxserver/mariadb
125126
container_name: bookstack_db
126127
environment:
127128
- PUID=1000
128129
- PGID=1000
129-
- MYSQL_ROOT_PASSWORD=<yourdbpass>
130130
- TZ=Europe/London
131+
- MYSQL_ROOT_PASSWORD=<yourdbpass>
131132
- MYSQL_DATABASE=bookstackapp
132133
- MYSQL_USER=bookstack
133134
- MYSQL_PASSWORD=<yourdbpass>
134135
volumes:
135-
- ./bookstack_db_data:/config
136+
- /path/to/bookstack_db_data:/config
136137
restart: unless-stopped
137138
```
138139

readme-vars.yml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
# project information
44
project_name: bookstack
55
project_url: "https://github.com/BookStackApp/BookStack"
6-
project_logo: "https://s3-us-west-2.amazonaws.com/linuxserver-docs/images/bookstack-logo500x500.png"
6+
project_logo: "https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/bookstack-logo.png"
77
project_lsio_github_repo_url: "https://github.com/linuxserver/docker-{{ project_name }}"
88
project_blurb: |
99
[{{ project_name|capitalize }}]({{ project_url }}) is a free and open source Wiki designed for creating beautiful documentation. Featuring a simple, but powerful WYSIWYG editor it allows for teams to create detailed and useful documentation with ease.
@@ -24,7 +24,6 @@ param_volumes:
2424
- { vol_path: "/config", vol_host_path: "/path/to/{{ project_name }}/config", desc: "Persistent config files" }
2525
param_usage_include_env: true
2626
param_env_vars:
27-
- { env_var: "TZ", env_value: "Europe/London", desc: "Specify a timezone to use EG Europe/London"}
2827
- { env_var: "APP_URL", env_value: "yourbaseurl", desc: "for specifying the IP:port or URL your application will be accessed on (ie. `http://192.168.1.1:6875` or `https://bookstack.mydomain.com`"}
2928
- { env_var: "DB_HOST", env_value: "yourdbhost", desc: "for specifying the database host" }
3029
- { env_var: "DB_PORT", env_value: "yourdbport", desc: "for specifying the database port if not default 3306" }
@@ -42,40 +41,41 @@ opt_param_env_vars:
4241

4342
custom_compose: |
4443
---
45-
version: "2"
4644
services:
4745
bookstack:
4846
image: lscr.io/linuxserver/bookstack
4947
container_name: bookstack
5048
environment:
5149
- PUID=1000
5250
- PGID=1000
51+
- TZ=Europe/London
5352
- APP_URL=https://bookstack.example.com
5453
- DB_HOST=bookstack_db
5554
- DB_PORT=3306
5655
- DB_USER=bookstack
5756
- DB_PASS=<yourdbpass>
5857
- DB_DATABASE=bookstackapp
5958
volumes:
60-
- ./bookstack_app_data:/config
59+
- /path/to/bookstack_app_data:/config
6160
ports:
6261
- 6875:80
6362
restart: unless-stopped
6463
depends_on:
6564
- bookstack_db
65+
6666
bookstack_db:
6767
image: lscr.io/linuxserver/mariadb
6868
container_name: bookstack_db
6969
environment:
7070
- PUID=1000
7171
- PGID=1000
72-
- MYSQL_ROOT_PASSWORD=<yourdbpass>
7372
- TZ=Europe/London
73+
- MYSQL_ROOT_PASSWORD=<yourdbpass>
7474
- MYSQL_DATABASE=bookstackapp
7575
- MYSQL_USER=bookstack
7676
- MYSQL_PASSWORD=<yourdbpass>
7777
volumes:
78-
- ./bookstack_db_data:/config
78+
- /path/to/bookstack_db_data:/config
7979
restart: unless-stopped
8080
8181
# application setup block

0 commit comments

Comments
 (0)