You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+25-29
Original file line number
Diff line number
Diff line change
@@ -61,7 +61,7 @@ docker create \
61
61
-e DB_USER=<yourdbuser> \
62
62
-e DB_PASS=<yourdbpass> \
63
63
-e DB_DATABASE=bookstackapp \
64
-
-e APP_URL=your.site.here.xyz \
64
+
-e APP_URL=your.site.here.xyz `#optional` \
65
65
-p 6875:80 \
66
66
-v <path to data>:/config \
67
67
--restart unless-stopped \
@@ -83,16 +83,32 @@ services:
83
83
environment:
84
84
- PUID=1000
85
85
- PGID=1000
86
-
- DB_HOST=<yourdbhost>
87
-
- DB_USER=<yourdbuser>
86
+
- DB_HOST=bookstack_db
87
+
- DB_USER=bookstack
88
88
- DB_PASS=<yourdbpass>
89
89
- DB_DATABASE=bookstackapp
90
-
- APP_URL=your.site.here.xyz
91
90
volumes:
92
91
- <path to data>:/config
93
92
ports:
94
93
- 6875:80
95
94
restart: unless-stopped
95
+
depends_on:
96
+
- bookstack_db
97
+
bookstack_db:
98
+
image: linuxserver/mariadb
99
+
container_name: bookstack_db
100
+
environment:
101
+
- PUID=1000
102
+
- PGID=1000
103
+
- MYSQL_ROOT_PASSWORD=<yourdbpass>
104
+
- TZ=Europe/London
105
+
- MYSQL_DATABASE=bookstackapp
106
+
- MYSQL_USER=bookstack
107
+
- MYSQL_PASSWORD=<yourdbpass>
108
+
volumes:
109
+
- <path to data>:/config
110
+
restart: unless-stopped
111
+
96
112
```
97
113
98
114
## Parameters
@@ -128,39 +144,18 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel
128
144
129
145
## Application Setup
130
146
131
-
This application is dependent on an SQL database be it one you already have or a new one. If you do not already have one, set up our MariaDB container.
132
-
133
-
Once the MariaDB container is deployed, you can enter the following commands into the shell of the MariaDB container to create the user, password and database that the app will then use. Replace myuser/mypassword with your own data.
147
+
Default username is [email protected] with password of **password**, access the container at http://dockerhost:6875.
134
148
135
-
**Note** this will allow any user with these credentials to connect to the server, it is not limited to localhost
149
+
This application is dependent on an 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/.
136
150
137
-
```
138
-
from shell on sql container:
139
-
mysql -u root -p
140
-
CREATE DATABASE bookstackapp;
141
-
GRANT USAGE ON *.* TO 'myuser'@'%' IDENTIFIED BY 'mypassword';
142
-
GRANT ALL privileges ON `bookstackapp`.* TO 'myuser'@'%';
143
-
FLUSH PRIVILEGES;
144
-
```
145
-
146
-
Once you have completed these, you can then use the docker run command to create your BookStack container. Make sure you replace things such as <yourdbuser> with the correct data.
147
-
148
-
Then docker start bookstackapp to start the container. You should then be able to access the container at http://dockerhost:6875
If you intend to use this application behind a 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
151
+
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
153
152
154
153
Documentation for BookStack can be found at https://www.bookstackapp.com/docs/
155
154
156
155
### Advanced Users (full control over the .env file)
157
156
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.
158
157
159
-
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.
160
-
161
-
### Composer
162
-
163
-
Some simple docker-compose files are included for you to get started with. You will still need to manually configure the SQL server, but the compose files will get the stack running for you.
158
+
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.
164
159
165
160
166
161
@@ -205,6 +200,7 @@ Below are the instructions for updating containers:
205
200
206
201
## Versions
207
202
203
+
***20.04.19:** - Rebase to Alpine 3.9, add MySQL init logic.
208
204
***22.03.19:** - Switching to new Base images, shift to arm32v7 tag.
[{{ 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.
9
10
10
11
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.
11
12
12
13
For more information on BookStack visit their website and check it out: https://www.bookstackapp.com
- { env_var: "DB_DATABASE", env_value: "bookstackapp", desc: "for specifying the database to be used" }
32
-
- { env_var: "APP_URL", env_value: "your.site.here.xyz", desc: "for specifying the url your application will be accessed on (required for correct operation of reverse proxy)"}
33
32
34
33
param_usage_include_ports: true
35
34
param_ports:
36
35
- { external_port: "6875", internal_port: "80", port_desc: "will map the container's port 80 to port 6875 on the host" }
37
36
37
+
opt_param_usage_include_env: true
38
+
opt_param_env_vars:
39
+
- { env_var: "APP_URL", env_value: "your.site.here.xyz", desc: "for specifying the url your application will be accessed on (required for correct operation of reverse proxy)"}
40
+
41
+
custom_compose: |
42
+
---
43
+
version: "2"
44
+
services:
45
+
bookstack:
46
+
image: linuxserver/bookstack
47
+
container_name: bookstack
48
+
environment:
49
+
- PUID=1000
50
+
- PGID=1000
51
+
- DB_HOST=bookstack_db
52
+
- DB_USER=bookstack
53
+
- DB_PASS=<yourdbpass>
54
+
- DB_DATABASE=bookstackapp
55
+
volumes:
56
+
- <path to data>:/config
57
+
ports:
58
+
- 6875:80
59
+
restart: unless-stopped
60
+
depends_on:
61
+
- bookstack_db
62
+
bookstack_db:
63
+
image: linuxserver/mariadb
64
+
container_name: bookstack_db
65
+
environment:
66
+
- PUID=1000
67
+
- PGID=1000
68
+
- MYSQL_ROOT_PASSWORD=<yourdbpass>
69
+
- TZ=Europe/London
70
+
- MYSQL_DATABASE=bookstackapp
71
+
- MYSQL_USER=bookstack
72
+
- MYSQL_PASSWORD=<yourdbpass>
73
+
volumes:
74
+
- <path to data>:/config
75
+
restart: unless-stopped
76
+
38
77
# application setup block
39
78
app_setup_block_enabled: true
40
79
app_setup_block: |
41
-
This application is dependent on an SQL database be it one you already have or a new one. If you do not already have one, set up our MariaDB container.
42
-
43
-
Once the MariaDB container is deployed, you can enter the following commands into the shell of the MariaDB container to create the user, password and database that the app will then use. Replace myuser/mypassword with your own data.
80
+
Default username is [email protected] with password of **password**, access the container at http://dockerhost:6875.
44
81
45
-
**Note** this will allow any user with these credentials to connect to the server, it is not limited to localhost
82
+
This application is dependent on an 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/.
46
83
47
-
```
48
-
from shell on sql container:
49
-
mysql -u root -p
50
-
CREATE DATABASE bookstackapp;
51
-
GRANT USAGE ON *.* TO 'myuser'@'%' IDENTIFIED BY 'mypassword';
52
-
GRANT ALL privileges ON `bookstackapp`.* TO 'myuser'@'%';
53
-
FLUSH PRIVILEGES;
54
-
```
55
-
56
-
Once you have completed these, you can then use the docker run command to create your BookStack container. Make sure you replace things such as <yourdbuser> with the correct data.
57
-
58
-
Then docker start bookstackapp to start the container. You should then be able to access the container at http://dockerhost:6875
If you intend to use this application behind a 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
84
+
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
63
85
64
86
Documentation for BookStack can be found at https://www.bookstackapp.com/docs/
65
87
66
88
### Advanced Users (full control over the .env file)
67
89
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.
68
90
69
-
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.
70
-
71
-
### Composer
72
-
73
-
Some simple docker-compose files are included for you to get started with. You will still need to manually configure the SQL server, but the compose files will get the stack running for you.
91
+
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.
74
92
75
93
# changelog
76
94
changelogs:
95
+
- { date: "20.04.19:", desc: "Rebase to Alpine 3.9, add MySQL init logic." }
77
96
- { date: "22.03.19:", desc: "Switching to new Base images, shift to arm32v7 tag." }
0 commit comments