Compare commits

...

265 Commits

Author SHA1 Message Date
LinuxServer-CI
d37b904fb3
Bot Updating Package Versions 2026-02-18 20:03:53 +00:00
Adam
4ea84e9203
Merge pull request #284 from linuxserver/purifier
Add purifier directory to framework symlinks
2026-02-17 17:57:29 +00:00
thespad
4024093611
Add purifier directory to framework symlinks 2026-02-17 17:08:23 +00:00
LinuxServer-CI
08e43edecf
Bot Updating Package Versions 2026-02-17 11:58:52 +00:00
LinuxServer-CI
14da2a0df5
Bot Updating Package Versions 2026-02-16 18:56:11 +00:00
LinuxServer-CI
9d396ec6a2
Bot Updating Templated Files 2026-02-16 18:52:39 +00:00
LinuxServer-CI
f903ab685d
Bot Updating Templated Files 2026-02-16 18:51:03 +00:00
LinuxServer-CI
6bf9340d89
Bot Updating Package Versions 2026-02-09 19:22:11 +00:00
LinuxServer-CI
37c2e6072d
Bot Updating Package Versions 2026-01-29 15:58:10 +00:00
LinuxServer-CI
6d24518f15
Bot Updating Package Versions 2026-01-24 14:42:11 +00:00
LinuxServer-CI
c36bdfb04a
Bot Updating Package Versions 2026-01-12 18:40:02 +00:00
Adam
4f99d38bcb
Merge pull request #278 from pfeyz/patch-1 2026-01-04 23:45:47 +00:00
LinuxServer-CI
c25a48d2b8
Bot Updating Package Versions 2026-01-04 21:23:57 +00:00
LinuxServer-CI
44463da08f
Bot Updating Templated Files 2026-01-04 21:18:25 +00:00
Adam
31a47a879e
Merge pull request #281 from linuxserver/3.23 2026-01-04 21:16:28 +00:00
LinuxServer-CI
c5d0fd7694
Bot Updating Package Versions 2025-12-30 17:42:20 +00:00
thespad
ca7fcb276f
opcache is now builtin 2025-12-28 17:09:44 +00:00
thespad
2904fa92fb
Rebase to 3.23 2025-12-28 17:06:20 +00:00
LinuxServer-CI
f68b027a14
Bot Updating Package Versions 2025-12-24 13:07:22 +00:00
LinuxServer-CI
6bc3180f53
Bot Updating Package Versions 2025-12-22 18:48:21 +00:00
LinuxServer-CI
e9a445379a
Bot Updating Package Versions 2025-12-22 18:43:45 +00:00
LinuxServer-CI
5642cc2080
Bot Updating Package Versions 2025-12-22 18:38:45 +00:00
LinuxServer-CI
3dfc0bda5a
Bot Updating Package Versions 2025-12-15 18:39:11 +00:00
LinuxServer-CI
08370f159d
Bot Updating Package Versions 2025-12-09 21:39:07 +00:00
LinuxServer-CI
dd118d1b46
Bot Updating Package Versions 2025-12-08 18:38:29 +00:00
pfeyz
11152fe266
don't embed ansi escape codes in appkey
given that it's the recommended way to generate the code in the docs, redirecting stdout will produce an appkey that will make bookstack crash when it runs. this will affect anyone who is trying to automate the initial steps of deployment.

i think this is likely the cause of this issue: https://github.com/BookStackApp/BookStack/issues/5289#issuecomment-2453680653
2025-12-06 19:40:32 -05:00
LinuxServer-CI
18bdc16361
Bot Updating Package Versions 2025-12-03 15:44:33 +00:00
LinuxServer-CI
0812ae08e5
Bot Updating Package Versions 2025-12-01 18:40:23 +00:00
LinuxServer-CI
bf431f8f0c
Bot Updating Package Versions 2025-11-25 22:40:41 +00:00
LinuxServer-CI
08a396d042
Bot Updating Package Versions 2025-11-21 14:46:20 +00:00
LinuxServer-CI
eb557cf2a1
Bot Updating Package Versions 2025-11-19 15:39:34 +00:00
LinuxServer-CI
07caa96fee
Bot Updating Templated Files 2025-11-19 15:35:57 +00:00
LinuxServer-CI
be89b0b7aa
Bot Updating Package Versions 2025-11-17 18:34:51 +00:00
LinuxServer-CI
91858f20e9
Bot Updating Package Versions 2025-11-09 13:37:46 +00:00
LinuxServer-CI
f560b74187
Bot Updating Package Versions 2025-10-27 18:36:33 +00:00
LinuxServer-CI
6c4839dfbb
Bot Updating Templated Files 2025-10-27 18:33:13 +00:00
LinuxServer-CI
a4e1054769
Bot Updating Package Versions 2025-10-20 18:37:39 +00:00
LinuxServer-CI
af1bd1bc0e
Bot Updating Templated Files 2025-10-20 18:33:46 +00:00
LinuxServer-CI
091265234d
Bot Updating Package Versions 2025-10-13 18:32:28 +00:00
LinuxServer-CI
57d1d906e3
Bot Updating Package Versions 2025-10-05 15:32:58 +00:00
LinuxServer-CI
f165d5927e
Bot Updating Package Versions 2025-09-29 18:34:25 +00:00
LinuxServer-CI
7834e6be98
Bot Updating Package Versions 2025-09-22 18:32:41 +00:00
LinuxServer-CI
6a6031e70e
Bot Updating Package Versions 2025-08-28 17:37:27 +00:00
LinuxServer-CI
9509dbaa1f
Bot Updating Package Versions 2025-08-25 18:34:56 +00:00
LinuxServer-CI
9fdf1f8e9b
Bot Updating Package Versions 2025-08-18 18:36:53 +00:00
LinuxServer-CI
79e220fe9c
Bot Updating Package Versions 2025-08-11 14:46:42 +00:00
LinuxServer-CI
21c371b198
Bot Updating Package Versions 2025-08-04 18:38:45 +00:00
LinuxServer-CI
f0cdf284eb
Bot Updating Package Versions 2025-07-30 09:54:50 +00:00
LinuxServer-CI
963a439956
Bot Updating Package Versions 2025-07-28 18:39:14 +00:00
LinuxServer-CI
16e0d78dbb
Bot Updating Package Versions 2025-07-15 08:41:12 +00:00
LinuxServer-CI
2d4c63e977
Bot Updating Templated Files 2025-07-15 08:37:56 +00:00
Adam
7a44242a13
Merge pull request #274 from linuxserver/3.22 2025-07-15 09:36:25 +01:00
LinuxServer-CI
fe9a7feb9e
Bot Updating Package Versions 2025-07-14 18:37:50 +00:00
thespad
36f1de6449
Fix || breaking build failures 2025-07-10 19:40:39 +01:00
LinuxServer-CI
0dd8ae9069
Bot Updating Package Versions 2025-07-07 14:47:18 +00:00
LinuxServer-CI
225e05f493
Bot Updating Templated Files 2025-07-07 14:43:47 +00:00
LinuxServer-CI
c422f29971
Bot Updating Templated Files 2025-07-07 14:42:09 +00:00
thespad
001da31552
Rebase to 3.22 2025-07-05 15:26:54 +01:00
LinuxServer-CI
3173d606ef
Bot Updating Package Versions 2025-06-17 14:44:54 +00:00
LinuxServer-CI
e3d106d070
Bot Updating Templated Files 2025-06-16 18:33:01 +00:00
LinuxServer-CI
92ab5632ed
Bot Updating Package Versions 2025-05-31 13:44:53 +00:00
LinuxServer-CI
4cb2d86fd3
Bot Updating Package Versions 2025-05-26 18:33:36 +00:00
LinuxServer-CI
336d5ba3f7
Bot Updating Package Versions 2025-05-17 11:31:42 +00:00
LinuxServer-CI
9c2b40c914
Bot Updating Templated Files 2025-05-17 11:28:57 +00:00
LinuxServer-CI
481bdb6a8b
Bot Updating Package Versions 2025-05-08 15:41:50 +00:00
LinuxServer-CI
5eb50e7294
Bot Updating Package Versions 2025-05-05 18:30:18 +00:00
LinuxServer-CI
f92adde813
Bot Updating Package Versions 2025-04-21 18:31:56 +00:00
LinuxServer-CI
aab1799cae
Bot Updating Package Versions 2025-04-14 18:32:19 +00:00
LinuxServer-CI
bee364899e
Bot Updating Package Versions 2025-04-07 18:31:37 +00:00
LinuxServer-CI
4c90655485
Bot Updating Package Versions 2025-04-02 16:48:13 +00:00
LinuxServer-CI
0c1bdf7b07
Bot Updating Package Versions 2025-03-31 18:31:29 +00:00
LinuxServer-CI
6006704576
Bot Updating Package Versions 2025-03-17 18:30:33 +00:00
LinuxServer-CI
cb76bd3838
Bot Updating Package Versions 2025-03-16 12:55:56 +00:00
LinuxServer-CI
c833bc46c2
Bot Updating Package Versions 2025-03-09 13:52:08 +00:00
Adam
6bda8c360a
Merge pull request #266 from linuxserver/backup-symlink
Fix backup symlink
2025-03-09 13:49:05 +00:00
thespad
06da7f0e0b
Fix backup symlink 2025-03-08 20:23:21 +00:00
LinuxServer-CI
80ee30e747
Bot Updating Package Versions 2025-02-26 15:37:51 +00:00
LinuxServer-CI
feb8032b97
Bot Updating Package Versions 2025-02-24 18:31:54 +00:00
LinuxServer-CI
9e330f4396
Bot Updating Package Versions 2025-02-17 18:28:26 +00:00
LinuxServer-CI
167e0a0cf2
Bot Updating Templated Files 2025-02-10 18:27:36 +00:00
LinuxServer-CI
4c041344f8
Bot Updating Templated Files 2025-02-03 18:29:33 +00:00
LinuxServer-CI
30ec902a3a
Bot Updating Templated Files 2025-02-03 18:28:39 +00:00
LinuxServer-CI
a31d51a1cd
Bot Updating Package Versions 2025-01-22 00:20:52 +00:00
quietsy
63ab103e8b
Merge pull request #259 from linuxserver/add-project-categories
Add categories to readme-vars.yml
2025-01-21 04:42:07 +02:00
LinuxServer-CI
dcb27aab58
Bot Updating Package Versions 2025-01-20 18:27:33 +00:00
quietsy
ef5d337e4d Add categories to readme-vars.yml 2025-01-20 17:21:03 +02:00
LinuxServer-CI
9be39e5c49
Bot Updating Package Versions 2025-01-15 14:00:27 +00:00
Adam
44544d05ee
Merge pull request #258 from linuxserver/sessions 2025-01-15 13:57:02 +00:00
thespad
17961c4c24
Only clear cache, sessions, views on container update 2025-01-15 10:04:46 +00:00
LinuxServer-CI
4efb651e21
Bot Updating Package Versions 2025-01-05 10:10:52 +00:00
LinuxServer-CI
29778a5321
Bot Updating Templated Files 2025-01-05 10:06:14 +00:00
Adam
3236a68411
Merge pull request #254 from linuxserver/opcache 2025-01-05 10:04:57 +00:00
LinuxServer-CI
32a45a9d61
Bot Updating Package Versions 2025-01-04 23:31:05 +00:00
thespad
72f406373b
Add php83-opcache 2025-01-04 22:28:25 +00:00
LinuxServer-CI
c705a81c1c
Bot Updating Package Versions 2024-12-23 12:56:46 +00:00
Adam
244c619c77
Merge pull request #248 from linuxserver/master-fix-keygen 2024-12-22 22:22:11 +00:00
thespad
d283e53018
Fix appkey gen with new symlinks 2024-12-22 21:59:37 +00:00
LinuxServer-CI
ee61205ece
Bot Updating Package Versions 2024-12-21 13:34:54 +00:00
LinuxServer-CI
15af885805
Bot Updating Templated Files 2024-12-21 13:31:47 +00:00
Adam
fb50f788b2
Merge pull request #247 from linuxserver/3.21 2024-12-21 13:30:14 +00:00
thespad
5fd60b393b
Improve symlink creation 2024-12-18 15:45:06 +00:00
thespad
fdf34906e5
Use /tmp as we need it anyway 2024-12-17 17:58:35 +00:00
thespad
476e0463b1
Rebase to 3.21, support read-only operation 2024-12-17 17:55:20 +00:00
LinuxServer-CI
9a88ade8e1
Bot Updating Package Versions 2024-12-16 18:38:51 +00:00
LinuxServer-CI
10aca3f421
Bot Updating Templated Files 2024-12-16 18:32:26 +00:00
LinuxServer-CI
15092cd768
Bot Updating Templated Files 2024-12-16 18:29:47 +00:00
LinuxServer-CI
b704ebdd25
Bot Updating Templated Files 2024-12-09 18:30:53 +00:00
LinuxServer-CI
b52e28a1a2
Bot Updating Templated Files 2024-12-02 18:34:35 +00:00
LinuxServer-CI
3955a5ceab
Bot Updating Templated Files 2024-12-02 18:31:56 +00:00
LinuxServer-CI
85e3b1a0a5
Bot Updating Templated Files 2024-12-02 18:30:44 +00:00
LinuxServer-CI
a96801f392
Bot Updating Templated Files 2024-12-02 18:29:18 +00:00
LinuxServer-CI
f719a0c2f5
Bot Updating Package Versions 2024-11-29 14:38:43 +00:00
LinuxServer-CI
241c57b7f9
Bot Updating Package Versions 2024-11-25 18:28:59 +00:00
Adam
5f0dbc08f7
Merge pull request #242 from linuxserver/be-unambiguous 2024-11-20 20:43:50 +00:00
thespad
04589bb8ae
Attempt to remove any and all ambiguity from the readme instructions. 2024-11-20 20:31:19 +00:00
LinuxServer-CI
47165fc43d
Bot Updating Package Versions 2024-11-13 12:57:23 +00:00
LinuxServer-CI
a9d2ee5a88
Bot Updating Templated Files 2024-11-11 18:27:36 +00:00
LinuxServer-CI
0bdb37bf4f
Bot Updating Templated Files 2024-11-11 18:26:36 +00:00
LinuxServer-CI
b8fba7f08b
Bot Updating Package Versions 2024-11-08 15:04:57 +00:00
LinuxServer-CI
00a782d8ae
Bot Updating Package Versions 2024-11-04 18:29:11 +00:00
LinuxServer-CI
c7819efba7
Bot Updating Package Versions 2024-10-28 18:30:00 +00:00
LinuxServer-CI
1eb8aa7e86
Bot Updating Package Versions 2024-10-21 18:28:43 +00:00
Adam
5a58d58419
Merge pull request #234 from linuxserver/fix-appkey 2024-10-14 16:21:36 +01:00
thespad
c84517086c
Fix appkey check + add helper 2024-10-14 16:12:46 +01:00
Adam
2c3eb82848
Merge pull request #231 from linuxserver/env-consolidation 2024-10-14 09:13:03 +01:00
thespad
be960b455b
Add update-url note to readme 2024-10-14 09:07:27 +01:00
thespad
448b16865f
Fix unhelpful default values 2024-10-12 20:19:24 +01:00
thespad
4cb4610150
Simplify init, prefer envs, make fewer assumptions 2024-10-12 19:28:51 +01:00
LinuxServer-CI
e32e3ce745
Bot Updating Package Versions 2024-10-09 10:42:32 +00:00
LinuxServer-CI
23e32dc35e
Bot Updating Package Versions 2024-09-30 18:33:03 +00:00
LinuxServer-CI
1ecb3fb7a2
Bot Updating Templated Files 2024-09-30 18:30:03 +00:00
LinuxServer-CI
bd625285f7
Bot Updating Templated Files 2024-09-30 18:28:48 +00:00
LinuxServer-CI
ef194d4e9c
Bot Updating Templated Files 2024-09-30 18:27:18 +00:00
LinuxServer-CI
c42dd81847
Bot Updating Package Versions 2024-09-23 18:27:58 +00:00
LinuxServer-CI
9e5e0c3fbb
Bot Updating Package Versions 2024-09-16 18:28:54 +00:00
LinuxServer-CI
d4a11792b7
Bot Updating Package Versions 2024-09-06 15:21:51 +00:00
LinuxServer-CI
2fa72de4df
Bot Updating Templated Files 2024-09-06 15:18:59 +00:00
LinuxServer-CI
fc8f5ee61f
Bot Updating Templated Files 2024-09-06 15:16:49 +00:00
Adam
6a43dbf24f
Merge pull request #224 from linuxserver/php-exif 2024-09-06 16:15:22 +01:00
thespad
248b8769b4
Add php83-exif for reading image EXIF data 2024-09-06 16:03:32 +01:00
LinuxServer-CI
9c224f5eb5
Bot Updating Package Versions 2024-08-29 15:36:53 +00:00
LinuxServer-CI
dfc1d3192f
Bot Updating Package Versions 2024-08-26 18:25:50 +00:00
LinuxServer-CI
951399bd49
Bot Updating Package Versions 2024-08-19 18:30:42 +00:00
LinuxServer-CI
e682e1aaa1
Bot Updating Templated Files 2024-08-19 18:26:56 +00:00
LinuxServer-CI
80de27102c Bot Updating Templated Files 2024-08-19 18:24:50 +00:00
Adam
6790cfae23
Merge pull request #221 from linuxserver/migrations-x 2024-08-13 16:17:52 +01:00
thespad
8b6b85d1a3
Make migrations executable 2024-08-13 15:15:45 +01:00
LinuxServer-CI
c8ffa209f1 Bot Updating Package Versions 2024-08-12 18:27:12 +00:00
LinuxServer-CI
c6b23e665f Bot Updating Package Versions 2024-08-05 18:26:40 +00:00
LinuxServer-CI
25f8bddc4e Bot Updating Package Versions 2024-07-29 18:27:13 +00:00
LinuxServer-CI
c17a8d6dbd Bot Updating Package Versions 2024-07-19 21:37:25 +00:00
Eric Nemchik
7745e1c0d7
Merge pull request #218 from linuxserver/delete-default-conf
Delete root/defaults/nginx/site-confs/default.conf.sample
2024-07-19 16:33:49 -05:00
Eric Nemchik
1c26d28291
Delete root/defaults/nginx/site-confs/default.conf.sample
redundant to base
2024-07-16 20:44:27 -05:00
LinuxServer-CI
f7b4f2442e Bot Updating Package Versions 2024-07-14 16:54:28 +00:00
LinuxServer-CI
ac8cb7a796 Bot Updating Templated Files 2024-07-14 16:51:04 +00:00
LinuxServer-CI
76bc27286e Bot Updating Templated Files 2024-07-14 16:49:26 +00:00
LinuxServer-CI
c4732bf86a Bot Updating Package Versions 2024-07-08 18:26:18 +00:00
LinuxServer-CI
83ce5bd30b Bot Updating Package Versions 2024-07-01 18:27:15 +00:00
LinuxServer-CI
82e27df972 Bot Updating Package Versions 2024-06-17 18:25:01 +00:00
LinuxServer-CI
9458f760ca Bot Updating Package Versions 2024-06-10 11:28:59 +00:00
LinuxServer-CI
721ace2bca Bot Updating Package Versions 2024-06-01 20:34:56 +00:00
Adam
66bb63ab5c
Merge pull request #215 from linuxserver/readme-tidy
Tidy readme
2024-06-01 21:30:44 +01:00
thespad
8f7e4da277
Tidy readme 2024-06-01 17:48:04 +01:00
LinuxServer-CI
69d9fd1452 Bot Updating Package Versions 2024-05-29 13:56:47 +00:00
LinuxServer-CI
b1e2b2ee4f Bot Updating Templated Files 2024-05-29 13:54:01 +00:00
Adam
aa40100bb2
Merge pull request #213 from linuxserver/3.20
Rebase to 3.20
2024-05-29 14:52:40 +01:00
thespad
223740182f
Use wildcard listener 2024-05-29 13:58:02 +01:00
thespad
1078bd4dfb
Update http2 wording 2024-05-28 20:11:12 +01:00
thespad
40fdb1058e
Rebase to 3.20 2024-05-28 20:01:03 +01:00
LinuxServer-CI
0e6c35ab2d Bot Updating Package Versions 2024-05-27 18:23:23 +00:00
LinuxServer-CI
51d49e40ba Bot Updating Package Versions 2024-05-21 10:55:30 +00:00
LinuxServer-CI
0c4f018f41 Bot Updating Templated Files 2024-05-21 10:52:26 +00:00
LinuxServer-CI
9aeff1a1d0 Bot Updating Templated Files 2024-05-21 10:50:51 +00:00
LinuxServer-CI
0836983544 Bot Updating Templated Files 2024-05-21 10:49:09 +00:00
LinuxServer-CI
e78d02587b Bot Updating Package Versions 2024-05-20 18:23:49 +00:00
LinuxServer-CI
072e39ee06 Bot Updating Package Versions 2024-05-13 18:23:07 +00:00
LinuxServer-CI
e03366e936 Bot Updating Package Versions 2024-05-11 15:31:12 +00:00
LinuxServer-CI
bd9f41e793 Bot Updating Templated Files 2024-05-11 15:28:25 +00:00
LinuxServer-CI
4864ce1d1e Bot Updating Templated Files 2024-05-06 18:24:36 +00:00
LinuxServer-CI
93878ef585 Bot Updating Package Versions 2024-04-29 18:22:17 +00:00
LinuxServer-CI
263fc81952 Bot Updating Package Versions 2024-04-22 18:23:05 +00:00
LinuxServer-CI
8fddd56c0c Bot Updating Package Versions 2024-04-15 18:23:15 +00:00
LinuxServer-CI
efa77507f3 Bot Updating Package Versions 2024-04-05 14:34:15 +00:00
LinuxServer-CI
248b7be397 Bot Updating Package Versions 2024-04-01 18:21:02 +00:00
LinuxServer-CI
ef62a56bab Bot Updating Package Versions 2024-03-25 18:24:37 +00:00
LinuxServer-CI
b24b21f21c Bot Updating Package Versions 2024-03-18 18:23:08 +00:00
LinuxServer-CI
ef1f4e2139 Bot Updating Templated Files 2024-03-18 18:20:07 +00:00
LinuxServer-CI
22289ce96f Bot Updating Package Versions 2024-03-04 18:20:31 +00:00
LinuxServer-CI
4e1861dc95 Bot Updating Package Versions 2024-02-28 14:31:22 +00:00
LinuxServer-CI
63d71fde37 Bot Updating Package Versions 2024-02-26 12:48:11 +00:00
LinuxServer-CI
580623db9d Bot Updating Templated Files 2024-02-26 12:45:04 +00:00
LinuxServer-CI
4d41ca9239 Bot Updating Templated Files 2024-02-26 12:43:20 +00:00
LinuxServer-CI
15127d9e4c Bot Updating Package Versions 2024-02-19 18:24:23 +00:00
LinuxServer-CI
ffd2adc9dd Bot Updating Package Versions 2024-02-12 18:20:17 +00:00
LinuxServer-CI
a22f015ceb Bot Updating Package Versions 2024-02-05 18:22:46 +00:00
LinuxServer-CI
dc638a54d8 Bot Updating Package Versions 2024-01-29 18:21:02 +00:00
LinuxServer-CI
6a1308143b Bot Updating Templated Files 2024-01-25 18:50:49 +00:00
Eric Nemchik
3d1656966a
Merge pull request #201 from linuxserver/nginx-cleanup
Cleanup default site conf
2024-01-25 12:45:45 -06:00
Eric Nemchik
0de4fc064f
Merge branch 'master' into nginx-cleanup 2024-01-25 12:45:40 -06:00
LinuxServer-CI
a2089be82d Bot Updating Package Versions 2024-01-24 11:30:55 +00:00
LinuxServer-CI
8386f7a90b Bot Updating Package Versions 2024-01-22 18:23:20 +00:00
LinuxServer-CI
9f99c7fef9 Bot Updating Package Versions 2024-01-15 18:26:43 +00:00
LinuxServer-CI
c86c8298a6 Bot Updating Templated Files 2024-01-15 18:22:59 +00:00
LinuxServer-CI
755270f475 Bot Updating Templated Files 2024-01-15 18:21:12 +00:00
LinuxServer-CI
e1e6dd2a30 Bot Updating Package Versions 2024-01-08 18:22:31 +00:00
LinuxServer-CI
cc18bc0f84 Bot Updating Package Versions 2023-12-29 12:48:05 +00:00
LinuxServer-CI
de6b81a975 Bot Updating Package Versions 2023-12-28 18:34:11 +00:00
LinuxServer-CI
72b2f7dacb Bot Updating Templated Files 2023-12-28 18:29:25 +00:00
Eric Nemchik
bcf329ba07
Merge pull request #200 from linuxserver/3.19
Rebase to Alpine 3.19
2023-12-28 12:27:57 -06:00
Eric Nemchik
4f569dfdf8
Cleanup default site conf
Signed-off-by: Eric Nemchik <eric@nemchik.com>
2023-12-25 14:16:11 -06:00
LinuxServer-CI
92901fa2a3 Bot Updating Package Versions 2023-12-25 18:21:56 +00:00
Eric Nemchik
ba22acfa48
Rebase to Alpine 3.19
Signed-off-by: Eric Nemchik <eric@nemchik.com>
2023-12-23 18:08:37 -06:00
LinuxServer-CI
ca614519d4 Bot Updating Package Versions 2023-12-11 18:23:46 +00:00
LinuxServer-CI
1a0feb718c Bot Updating Package Versions 2023-12-04 18:23:33 +00:00
LinuxServer-CI
c645e46843 Bot Updating Package Versions 2023-11-27 18:22:06 +00:00
Eric Nemchik
976de47cd0
Merge pull request #197 from linuxserver/quiet-migration
only run migration if conf exists
2023-11-25 18:12:51 -06:00
Eric Nemchik
a6801f27f0
only run migration if conf exists
redirect stderr to /dev/null

Signed-off-by: Eric Nemchik <eric@nemchik.com>
2023-11-25 10:42:40 -06:00
LinuxServer-CI
152f64b6f9 Bot Updating Package Versions 2023-11-25 12:18:06 +00:00
Adam
586c3d8751
Merge pull request #196 from linuxserver/init-fix
Symlink all logs to avoid defer error on new install
2023-11-25 12:15:15 +00:00
TheSpad
78d685a31f
Symlink logs and backups outside of www 2023-11-24 14:11:04 +00:00
TheSpad
7759d52c25
Symlink all logs to avoid defer error on new install 2023-11-24 13:54:02 +00:00
LinuxServer-CI
acda76ad08 Bot Updating Package Versions 2023-11-17 15:56:12 +00:00
LinuxServer-CI
40ee80c5d8 Bot Updating Templated Files 2023-11-17 15:53:15 +00:00
aptalca
28b6c968f2
Merge pull request #195 from linuxserver/sedescape
further sanitize sed replace
2023-11-17 10:51:41 -05:00
LinuxServer-CI
99e2bec1bc Bot Updating Package Versions 2023-11-13 18:21:49 +00:00
LinuxServer-CI
b9909c9323 Bot Updating Package Versions 2023-11-02 15:29:16 +00:00
aptalca
e0f1e7cf13
further sanitize sed replace 2023-10-31 17:35:24 -04:00
LinuxServer-CI
0da4f3e270 Bot Updating Package Versions 2023-10-30 12:47:46 +00:00
LinuxServer-CI
833d57cfed Bot Updating Package Versions 2023-10-23 18:21:00 +00:00
LinuxServer-CI
9a4494667a Bot Updating Package Versions 2023-10-16 18:24:42 +00:00
LinuxServer-CI
0b32a2a4c3 Bot Updating Package Versions 2023-10-09 18:26:31 +00:00
LinuxServer-CI
7a787f9c5b Bot Updating Templated Files 2023-10-09 18:22:41 +00:00
LinuxServer-CI
32c7e152fa Bot Updating Templated Files 2023-10-09 18:21:05 +00:00
LinuxServer-CI
4f7bd3761e Bot Updating Package Versions 2023-10-02 18:21:57 +00:00
LinuxServer-CI
a62a72c757 Bot Updating Package Versions 2023-09-25 18:22:15 +00:00
LinuxServer-CI
cf00b4b528 Bot Updating Package Versions 2023-09-15 13:30:57 +00:00
LinuxServer-CI
0e1f787d64 Bot Updating Package Versions 2023-09-11 18:21:19 +00:00
LinuxServer-CI
48590fc969 Bot Updating Templated Files 2023-09-04 11:03:26 +00:00
Adam
b979032c09
Merge pull request #187 from linuxserver/queues 2023-09-04 12:01:45 +01:00
TheSpad
7245559a00
Add link for async actions 2023-09-04 09:25:52 +01:00
TheSpad
869d618156
Add async action support 2023-09-04 09:22:10 +01:00
LinuxServer-CI
e3bcaad822 Bot Updating Package Versions 2023-09-03 17:32:40 +00:00
LinuxServer-CI
3ee35b4d79 Bot Updating Package Versions 2023-08-30 12:48:59 +00:00
LinuxServer-CI
1f7441a512 Bot Updating Package Versions 2023-08-28 18:22:14 +00:00
LinuxServer-CI
620c519455 Bot Updating Package Versions 2023-08-21 18:20:01 +00:00
LinuxServer-CI
e06fd86bc1 Bot Updating Package Versions 2023-08-14 18:30:13 +00:00
LinuxServer-CI
c0042bd7c6 Bot Updating Package Versions 2023-08-14 18:26:24 +00:00
LinuxServer-CI
6b7063dbbd Bot Updating Package Versions 2023-08-14 18:22:44 +00:00
LinuxServer-CI
8cba53dfe8 Bot Updating Package Versions 2023-08-14 18:19:52 +00:00
LinuxServer-CI
a8c6d4b653 Bot Updating Package Versions 2023-08-11 00:05:38 +00:00
LinuxServer-CI
9f149726fd Bot Updating Templated Files 2023-08-11 00:02:00 +00:00
Eric Nemchik
0f7b665962
Merge pull request #183 from jasonyang-ee/master
Update password restriction matching to db image manual
2023-08-10 18:59:39 -05:00
LinuxServer-CI
fd52002a3d Bot Updating Package Versions 2023-08-07 18:21:10 +00:00
Jason Teng
51c954c18b
Edit: moving change to readme-vars.yml 2023-08-06 23:32:53 -07:00
Jason Teng
bb3a6b4f05
Revert "Add: password restriction match to db image manual"
This reverts commit b270eaf8a27a2f3b96710498c1b005e97de577b0.
2023-08-06 23:30:33 -07:00
Jason Teng
b270eaf8a2
Add: password restriction match to db image manual
per linuxserver/mariadb/, the required DATABASE_PASSWORD must > 4
2023-08-06 23:11:03 -07:00
LinuxServer-CI
e654f6ca12 Bot Updating Package Versions 2023-07-31 18:22:24 +00:00
LinuxServer-CI
078e1512ed Bot Updating Package Versions 2023-07-24 18:22:42 +00:00
LinuxServer-CI
54488670f1 Bot Updating Package Versions 2023-07-17 18:25:56 +00:00
LinuxServer-CI
914301a9ea Bot Updating Package Versions 2023-07-11 13:20:42 +00:00
Adam
2e802e7231
Merge pull request #179 from linuxserver/drizuid-patch-1 2023-07-11 14:16:45 +01:00
LinuxServer-CI
70c02cc704 Bot Updating Package Versions 2023-07-10 18:23:30 +00:00
driz
edd48f8708
Update readme-vars.yml 2023-07-06 08:48:42 -04:00
driz
01114edaa3
remove wkhtmltopdf section of readme 2023-07-06 08:47:30 -04:00
LinuxServer-CI
8cacf766f6 Bot Updating Package Versions 2023-07-05 13:00:40 +00:00
30 changed files with 1406 additions and 1068 deletions

0
.editorconfig Executable file → Normal file
View File

6
.github/CONTRIBUTING.md vendored Executable file → Normal file
View File

@ -6,7 +6,7 @@
* Read, and fill the Pull Request template * Read, and fill the Pull Request template
* If this is a fix for a typo (in code, documentation, or the README) please file an issue and let us sort it out. We do not need a PR * If this is a fix for a typo (in code, documentation, or the README) please file an issue and let us sort it out. We do not need a PR
* If the PR is addressing an existing issue include, closes #\<issue number>, in the body of the PR commit message * If the PR is addressing an existing issue include, closes #\<issue number>, in the body of the PR commit message
* If you want to discuss changes, you can also bring it up in [#dev-talk](https://discordapp.com/channels/354974912613449730/757585807061155840) in our [Discord server](https://discord.gg/YWrKVTn) * If you want to discuss changes, you can also bring it up in [#dev-talk](https://discordapp.com/channels/354974912613449730/757585807061155840) in our [Discord server](https://linuxserver.io/discord)
## Common files ## Common files
@ -105,10 +105,10 @@ docker build \
-t linuxserver/bookstack:latest . -t linuxserver/bookstack:latest .
``` ```
The ARM variants can be built on x86_64 hardware using `multiarch/qemu-user-static` The ARM variants can be built on x86_64 hardware and vice versa using `lscr.io/linuxserver/qemu-static`
```bash ```bash
docker run --rm --privileged multiarch/qemu-user-static:register --reset docker run --rm --privileged lscr.io/linuxserver/qemu-static --reset
``` ```
Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64`. Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64`.

0
.github/FUNDING.yml vendored Executable file → Normal file
View File

2
.github/ISSUE_TEMPLATE/config.yml vendored Executable file → Normal file
View File

@ -1,7 +1,7 @@
blank_issues_enabled: false blank_issues_enabled: false
contact_links: contact_links:
- name: Discord chat support - name: Discord chat support
url: https://discord.gg/YWrKVTn url: https://linuxserver.io/discord
about: Realtime support / chat with the community and the team. about: Realtime support / chat with the community and the team.
- name: Discourse discussion forum - name: Discourse discussion forum

4
.github/ISSUE_TEMPLATE/issue.bug.yml vendored Executable file → Normal file
View File

@ -67,10 +67,10 @@ body:
- type: textarea - type: textarea
attributes: attributes:
description: | description: |
Provide a full docker log, output of "docker logs linuxserver.io" Provide a full docker log, output of "docker logs bookstack"
label: Container logs label: Container logs
placeholder: | placeholder: |
Output of `docker logs linuxserver.io` Output of `docker logs bookstack`
render: bash render: bash
validations: validations:
required: true required: true

0
.github/ISSUE_TEMPLATE/issue.feature.yml vendored Executable file → Normal file
View File

3
.github/workflows/call_issue_pr_tracker.yml vendored Executable file → Normal file
View File

@ -8,6 +8,9 @@ on:
pull_request_review: pull_request_review:
types: [submitted,edited,dismissed] types: [submitted,edited,dismissed]
permissions:
contents: read
jobs: jobs:
manage-project: manage-project:
permissions: permissions:

3
.github/workflows/call_issues_cron.yml vendored Executable file → Normal file
View File

@ -4,6 +4,9 @@ on:
- cron: '3 9 * * *' - cron: '3 9 * * *'
workflow_dispatch: workflow_dispatch:
permissions:
contents: read
jobs: jobs:
stale: stale:
permissions: permissions:

145
.github/workflows/external_trigger.yml vendored Executable file → Normal file
View File

@ -3,26 +3,42 @@ name: External Trigger Main
on: on:
workflow_dispatch: workflow_dispatch:
permissions:
contents: read
jobs: jobs:
external-trigger-master: external-trigger-master:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v3.1.0 - uses: actions/checkout@v4.1.1
- name: External Trigger - name: External Trigger
if: github.ref == 'refs/heads/master' if: github.ref == 'refs/heads/master'
env:
SKIP_EXTERNAL_TRIGGER: ${{ vars.SKIP_EXTERNAL_TRIGGER }}
run: | run: |
if [ -n "${{ secrets.PAUSE_EXTERNAL_TRIGGER_BOOKSTACK_MASTER }}" ]; then printf "# External trigger for docker-bookstack\n\n" >> $GITHUB_STEP_SUMMARY
echo "**** Github secret PAUSE_EXTERNAL_TRIGGER_BOOKSTACK_MASTER is set; skipping trigger. ****" if grep -q "^bookstack_master_" <<< "${SKIP_EXTERNAL_TRIGGER}"; then
echo "Github secret \`PAUSE_EXTERNAL_TRIGGER_BOOKSTACK_MASTER\` is set; skipping trigger." >> $GITHUB_STEP_SUMMARY echo "> [!NOTE]" >> $GITHUB_STEP_SUMMARY
echo "> Github organizational variable \`SKIP_EXTERNAL_TRIGGER\` contains \`bookstack_master_\`; will skip trigger if version matches." >> $GITHUB_STEP_SUMMARY
elif grep -q "^bookstack_master" <<< "${SKIP_EXTERNAL_TRIGGER}"; then
echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY
echo "> Github organizational variable \`SKIP_EXTERNAL_TRIGGER\` contains \`bookstack_master\`; skipping trigger." >> $GITHUB_STEP_SUMMARY
exit 0 exit 0
fi fi
echo "**** External trigger running off of master branch. To disable this trigger, set a Github secret named \"PAUSE_EXTERNAL_TRIGGER_BOOKSTACK_MASTER\". ****" echo "> [!NOTE]" >> $GITHUB_STEP_SUMMARY
echo "External trigger running off of master branch. To disable this trigger, set a Github secret named \`PAUSE_EXTERNAL_TRIGGER_BOOKSTACK_MASTER\`" >> $GITHUB_STEP_SUMMARY echo "> External trigger running off of master branch. To disable this trigger, add \`bookstack_master\` into the Github organizational variable \`SKIP_EXTERNAL_TRIGGER\`." >> $GITHUB_STEP_SUMMARY
echo "**** Retrieving external version ****" printf "\n## Retrieving external version\n\n" >> $GITHUB_STEP_SUMMARY
EXT_RELEASE=$(curl -u "${{ secrets.CR_USER }}:${{ secrets.CR_PAT }}" -sX GET "https://api.github.com/repos/bookstackapp/bookstack/releases/latest" | jq -r '. | .tag_name') EXT_RELEASE=$(curl -u "${{ secrets.CR_USER }}:${{ secrets.CR_PAT }}" -sX GET "https://api.github.com/repos/bookstackapp/bookstack/releases/latest" | jq -r '. | .tag_name')
echo "Type is \`github_stable\`" >> $GITHUB_STEP_SUMMARY
if grep -q "^bookstack_master_${EXT_RELEASE}" <<< "${SKIP_EXTERNAL_TRIGGER}"; then
echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY
echo "> Github organizational variable \`SKIP_EXTERNAL_TRIGGER\` matches current external release; skipping trigger." >> $GITHUB_STEP_SUMMARY
exit 0
fi
if [ -z "${EXT_RELEASE}" ] || [ "${EXT_RELEASE}" == "null" ]; then if [ -z "${EXT_RELEASE}" ] || [ "${EXT_RELEASE}" == "null" ]; then
echo "**** Can't retrieve external version, exiting ****" echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY
echo "> Can't retrieve external version, exiting" >> $GITHUB_STEP_SUMMARY
FAILURE_REASON="Can't retrieve external version for bookstack branch master" FAILURE_REASON="Can't retrieve external version for bookstack branch master"
GHA_TRIGGER_URL="https://github.com/linuxserver/docker-bookstack/actions/runs/${{ github.run_id }}" GHA_TRIGGER_URL="https://github.com/linuxserver/docker-bookstack/actions/runs/${{ github.run_id }}"
curl -X POST -H "Content-Type: application/json" --data '{"avatar_url": "https://cdn.discordapp.com/avatars/354986384542662657/df91181b3f1cf0ef1592fbe18e0962d7.png","embeds": [{"color": 16711680, curl -X POST -H "Content-Type: application/json" --data '{"avatar_url": "https://cdn.discordapp.com/avatars/354986384542662657/df91181b3f1cf0ef1592fbe18e0962d7.png","embeds": [{"color": 16711680,
@ -30,25 +46,43 @@ jobs:
"username": "Github Actions"}' ${{ secrets.DISCORD_WEBHOOK }} "username": "Github Actions"}' ${{ secrets.DISCORD_WEBHOOK }}
exit 1 exit 1
fi fi
EXT_RELEASE=$(echo ${EXT_RELEASE} | sed 's/[~,%@+;:/]//g') EXT_RELEASE_SANITIZED=$(echo ${EXT_RELEASE} | sed 's/[~,%@+;:/]//g')
echo "**** External version: ${EXT_RELEASE} ****" echo "Sanitized external version: \`${EXT_RELEASE_SANITIZED}\`" >> $GITHUB_STEP_SUMMARY
echo "External version: ${EXT_RELEASE}" >> $GITHUB_STEP_SUMMARY echo "Retrieving last pushed version" >> $GITHUB_STEP_SUMMARY
echo "**** Retrieving last pushed version ****"
image="linuxserver/bookstack" image="linuxserver/bookstack"
tag="latest" tag="latest"
token=$(curl -sX GET \ token=$(curl -sX GET \
"https://ghcr.io/token?scope=repository%3Alinuxserver%2Fbookstack%3Apull" \ "https://ghcr.io/token?scope=repository%3Alinuxserver%2Fbookstack%3Apull" \
| jq -r '.token') | jq -r '.token')
multidigest=$(curl -s \ multidigest=$(curl -s \
--header "Accept: application/vnd.docker.distribution.manifest.v2+json" \
--header "Accept: application/vnd.oci.image.index.v1+json" \
--header "Authorization: Bearer ${token}" \
"https://ghcr.io/v2/${image}/manifests/${tag}")
if jq -e '.layers // empty' <<< "${multidigest}" >/dev/null 2>&1; then
# If there's a layer element it's a single-arch manifest so just get that digest
digest=$(jq -r '.config.digest' <<< "${multidigest}")
else
# Otherwise it's multi-arch or has manifest annotations
if jq -e '.manifests[]?.annotations // empty' <<< "${multidigest}" >/dev/null 2>&1; then
# Check for manifest annotations and delete if found
multidigest=$(jq 'del(.manifests[] | select(.annotations))' <<< "${multidigest}")
fi
if [[ $(jq '.manifests | length' <<< "${multidigest}") -gt 1 ]]; then
# If there's still more than one digest, it's multi-arch
multidigest=$(jq -r ".manifests[] | select(.platform.architecture == \"amd64\").digest?" <<< "${multidigest}")
else
# Otherwise it's single arch
multidigest=$(jq -r ".manifests[].digest?" <<< "${multidigest}")
fi
if digest=$(curl -s \
--header "Accept: application/vnd.docker.distribution.manifest.v2+json" \ --header "Accept: application/vnd.docker.distribution.manifest.v2+json" \
--header "Accept: application/vnd.oci.image.manifest.v1+json" \
--header "Authorization: Bearer ${token}" \ --header "Authorization: Bearer ${token}" \
"https://ghcr.io/v2/${image}/manifests/${tag}" \ "https://ghcr.io/v2/${image}/manifests/${multidigest}"); then
| jq -r 'first(.manifests[].digest)') digest=$(jq -r '.config.digest' <<< "${digest}");
digest=$(curl -s \ fi
--header "Accept: application/vnd.docker.distribution.manifest.v2+json" \ fi
--header "Authorization: Bearer ${token}" \
"https://ghcr.io/v2/${image}/manifests/${multidigest}" \
| jq -r '.config.digest')
image_info=$(curl -sL \ image_info=$(curl -sL \
--header "Authorization: Bearer ${token}" \ --header "Authorization: Bearer ${token}" \
"https://ghcr.io/v2/${image}/blobs/${digest}") "https://ghcr.io/v2/${image}/blobs/${digest}")
@ -60,45 +94,54 @@ jobs:
IMAGE_RELEASE=$(echo ${image_info} | jq -r '.Labels.build_version' | awk '{print $3}') IMAGE_RELEASE=$(echo ${image_info} | jq -r '.Labels.build_version' | awk '{print $3}')
IMAGE_VERSION=$(echo ${IMAGE_RELEASE} | awk -F'-ls' '{print $1}') IMAGE_VERSION=$(echo ${IMAGE_RELEASE} | awk -F'-ls' '{print $1}')
if [ -z "${IMAGE_VERSION}" ]; then if [ -z "${IMAGE_VERSION}" ]; then
echo "**** Can't retrieve last pushed version, exiting ****" echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY
echo "Can't retrieve last pushed version, exiting" >> $GITHUB_STEP_SUMMARY
FAILURE_REASON="Can't retrieve last pushed version for bookstack tag latest" FAILURE_REASON="Can't retrieve last pushed version for bookstack tag latest"
curl -X POST -H "Content-Type: application/json" --data '{"avatar_url": "https://cdn.discordapp.com/avatars/354986384542662657/df91181b3f1cf0ef1592fbe18e0962d7.png","embeds": [{"color": 16711680, curl -X POST -H "Content-Type: application/json" --data '{"avatar_url": "https://cdn.discordapp.com/avatars/354986384542662657/df91181b3f1cf0ef1592fbe18e0962d7.png","embeds": [{"color": 16711680,
"description": "**Trigger Failed** \n**Reason:** '"${FAILURE_REASON}"' \n"}], "description": "**Trigger Failed** \n**Reason:** '"${FAILURE_REASON}"' \n"}],
"username": "Github Actions"}' ${{ secrets.DISCORD_WEBHOOK }} "username": "Github Actions"}' ${{ secrets.DISCORD_WEBHOOK }}
exit 1 exit 1
fi fi
echo "**** Last pushed version: ${IMAGE_VERSION} ****" echo "Last pushed version: \`${IMAGE_VERSION}\`" >> $GITHUB_STEP_SUMMARY
echo "Last pushed version: ${IMAGE_VERSION}" >> $GITHUB_STEP_SUMMARY if [ "${EXT_RELEASE_SANITIZED}" == "${IMAGE_VERSION}" ]; then
if [ "${EXT_RELEASE}" == "${IMAGE_VERSION}" ]; then echo "Sanitized version \`${EXT_RELEASE_SANITIZED}\` already pushed, exiting" >> $GITHUB_STEP_SUMMARY
echo "**** Version ${EXT_RELEASE} already pushed, exiting ****"
echo "Version ${EXT_RELEASE} already pushed, exiting" >> $GITHUB_STEP_SUMMARY
exit 0 exit 0
elif [ $(curl -s https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-bookstack/job/master/lastBuild/api/json | jq -r '.building') == "true" ]; then elif [ $(curl -s https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-bookstack/job/master/lastBuild/api/json | jq -r '.building') == "true" ]; then
echo "**** New version ${EXT_RELEASE} found; but there already seems to be an active build on Jenkins; exiting ****" echo "New version \`${EXT_RELEASE}\` found; but there already seems to be an active build on Jenkins; exiting" >> $GITHUB_STEP_SUMMARY
echo "New version ${EXT_RELEASE} found; but there already seems to be an active build on Jenkins; exiting" >> $GITHUB_STEP_SUMMARY
exit 0 exit 0
else else
echo "**** New version ${EXT_RELEASE} found; old version was ${IMAGE_VERSION}. Triggering new build ****" if [[ "${artifacts_found}" == "false" ]]; then
echo "New version ${EXT_RELEASE} found; old version was ${IMAGE_VERSION}. Triggering new build" >> $GITHUB_STEP_SUMMARY echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY
response=$(curl -iX POST \ echo "> New version detected, but not all artifacts are published yet; skipping trigger" >> $GITHUB_STEP_SUMMARY
https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-bookstack/job/master/buildWithParameters?PACKAGE_CHECK=false \ FAILURE_REASON="New version ${EXT_RELEASE} for bookstack tag latest is detected, however not all artifacts are uploaded to upstream release yet. Will try again later."
--user ${{ secrets.JENKINS_USER }}:${{ secrets.JENKINS_TOKEN }} | grep -i location | sed "s|^[L|l]ocation: \(.*\)|\1|") curl -X POST -H "Content-Type: application/json" --data '{"avatar_url": "https://cdn.discordapp.com/avatars/354986384542662657/df91181b3f1cf0ef1592fbe18e0962d7.png","embeds": [{"color": 9802903,
echo "**** Jenkins job queue url: ${response%$'\r'} ****" "description": "**Trigger Failed** \n**Reason:** '"${FAILURE_REASON}"' \n"}],
echo "**** Sleeping 10 seconds until job starts ****" "username": "Github Actions"}' ${{ secrets.DISCORD_WEBHOOK }}
sleep 10 else
buildurl=$(curl -s "${response%$'\r'}api/json" | jq -r '.executable.url') printf "\n## Trigger new build\n\n" >> $GITHUB_STEP_SUMMARY
buildurl="${buildurl%$'\r'}" echo "New sanitized version \`${EXT_RELEASE_SANITIZED}\` found; old version was \`${IMAGE_VERSION}\`. Triggering new build" >> $GITHUB_STEP_SUMMARY
echo "**** Jenkins job build url: ${buildurl} ****" if [[ "${artifacts_found}" == "true" ]]; then
echo "Jenkins job build url: ${buildurl}" >> $GITHUB_STEP_SUMMARY echo "All artifacts seem to be uploaded." >> $GITHUB_STEP_SUMMARY
echo "**** Attempting to change the Jenkins job description ****" fi
curl -iX POST \ response=$(curl -iX POST \
"${buildurl}submitDescription" \ https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-bookstack/job/master/buildWithParameters?PACKAGE_CHECK=false \
--user ${{ secrets.JENKINS_USER }}:${{ secrets.JENKINS_TOKEN }} \ --user ${{ secrets.JENKINS_USER }}:${{ secrets.JENKINS_TOKEN }} | grep -i location | sed "s|^[L|l]ocation: \(.*\)|\1|")
--data-urlencode "description=GHA external trigger https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}" \ echo "Jenkins [job queue url](${response%$'\r'})" >> $GITHUB_STEP_SUMMARY
--data-urlencode "Submit=Submit" echo "Sleeping 10 seconds until job starts" >> $GITHUB_STEP_SUMMARY
echo "**** Notifying Discord ****" sleep 10
TRIGGER_REASON="A version change was detected for bookstack tag latest. Old version:${IMAGE_VERSION} New version:${EXT_RELEASE}" buildurl=$(curl -s "${response%$'\r'}api/json" | jq -r '.executable.url')
curl -X POST -H "Content-Type: application/json" --data '{"avatar_url": "https://cdn.discordapp.com/avatars/354986384542662657/df91181b3f1cf0ef1592fbe18e0962d7.png","embeds": [{"color": 9802903, buildurl="${buildurl%$'\r'}"
"description": "**Build Triggered** \n**Reason:** '"${TRIGGER_REASON}"' \n**Build URL:** '"${buildurl}display/redirect"' \n"}], echo "Jenkins job [build url](${buildurl})" >> $GITHUB_STEP_SUMMARY
"username": "Github Actions"}' ${{ secrets.DISCORD_WEBHOOK }} echo "Attempting to change the Jenkins job description" >> $GITHUB_STEP_SUMMARY
curl -iX POST \
"${buildurl}submitDescription" \
--user ${{ secrets.JENKINS_USER }}:${{ secrets.JENKINS_TOKEN }} \
--data-urlencode "description=GHA external trigger https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}" \
--data-urlencode "Submit=Submit"
echo "**** Notifying Discord ****"
TRIGGER_REASON="A version change was detected for bookstack tag latest. Old version:${IMAGE_VERSION} New version:${EXT_RELEASE_SANITIZED}"
curl -X POST -H "Content-Type: application/json" --data '{"avatar_url": "https://cdn.discordapp.com/avatars/354986384542662657/df91181b3f1cf0ef1592fbe18e0962d7.png","embeds": [{"color": 9802903,
"description": "**Build Triggered** \n**Reason:** '"${TRIGGER_REASON}"' \n**Build URL:** '"${buildurl}display/redirect"' \n"}],
"username": "Github Actions"}' ${{ secrets.DISCORD_WEBHOOK }}
fi
fi fi

29
.github/workflows/external_trigger_scheduler.yml vendored Executable file → Normal file
View File

@ -5,41 +5,44 @@ on:
- cron: '19 * * * *' - cron: '19 * * * *'
workflow_dispatch: workflow_dispatch:
permissions:
contents: read
jobs: jobs:
external-trigger-scheduler: external-trigger-scheduler:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v3.1.0 - uses: actions/checkout@v4.1.1
with: with:
fetch-depth: '0' fetch-depth: '0'
- name: External Trigger Scheduler - name: External Trigger Scheduler
run: | run: |
echo "**** Branches found: ****" printf "# External trigger scheduler for docker-bookstack\n\n" >> $GITHUB_STEP_SUMMARY
git for-each-ref --format='%(refname:short)' refs/remotes printf "Found the branches:\n\n%s\n" "$(git for-each-ref --format='- %(refname:lstrip=3)' refs/remotes)" >> $GITHUB_STEP_SUMMARY
for br in $(git for-each-ref --format='%(refname:short)' refs/remotes) for br in $(git for-each-ref --format='%(refname:lstrip=3)' refs/remotes)
do do
br=$(echo "$br" | sed 's|origin/||g') if [[ "${br}" == "HEAD" ]]; then
echo "**** Evaluating branch ${br} ****" printf "\nSkipping %s.\n" ${br} >> $GITHUB_STEP_SUMMARY
continue
fi
printf "\n## Evaluating \`%s\`\n\n" ${br} >> $GITHUB_STEP_SUMMARY
ls_jenkins_vars=$(curl -sX GET https://raw.githubusercontent.com/linuxserver/docker-bookstack/${br}/jenkins-vars.yml) ls_jenkins_vars=$(curl -sX GET https://raw.githubusercontent.com/linuxserver/docker-bookstack/${br}/jenkins-vars.yml)
ls_branch=$(echo "${ls_jenkins_vars}" | yq -r '.ls_branch') ls_branch=$(echo "${ls_jenkins_vars}" | yq -r '.ls_branch')
ls_trigger=$(echo "${ls_jenkins_vars}" | yq -r '.external_type') ls_trigger=$(echo "${ls_jenkins_vars}" | yq -r '.external_type')
if [[ "${br}" == "${ls_branch}" ]] && [[ "${ls_trigger}" != "os" ]]; then if [[ "${br}" == "${ls_branch}" ]] && [[ "${ls_trigger}" != "os" ]]; then
echo "**** Branch ${br} appears to be live and trigger is not os; checking workflow. ****" echo "Branch appears to be live and trigger is not os; checking workflow." >> $GITHUB_STEP_SUMMARY
if curl -sfX GET https://raw.githubusercontent.com/linuxserver/docker-bookstack/${br}/.github/workflows/external_trigger.yml > /dev/null 2>&1; then if curl -sfX GET https://raw.githubusercontent.com/linuxserver/docker-bookstack/${br}/.github/workflows/external_trigger.yml > /dev/null 2>&1; then
echo "**** Workflow exists. Triggering external trigger workflow for branch ${br} ****." echo "Triggering external trigger workflow for branch." >> $GITHUB_STEP_SUMMARY
echo "Triggering external trigger workflow for branch ${br}" >> $GITHUB_STEP_SUMMARY
curl -iX POST \ curl -iX POST \
-H "Authorization: token ${{ secrets.CR_PAT }}" \ -H "Authorization: token ${{ secrets.CR_PAT }}" \
-H "Accept: application/vnd.github.v3+json" \ -H "Accept: application/vnd.github.v3+json" \
-d "{\"ref\":\"refs/heads/${br}\"}" \ -d "{\"ref\":\"refs/heads/${br}\"}" \
https://api.github.com/repos/linuxserver/docker-bookstack/actions/workflows/external_trigger.yml/dispatches https://api.github.com/repos/linuxserver/docker-bookstack/actions/workflows/external_trigger.yml/dispatches
else else
echo "**** Workflow doesn't exist; skipping trigger. ****" echo "Skipping branch due to no external trigger workflow present." >> $GITHUB_STEP_SUMMARY
echo "Skipping branch ${br} due to no external trigger workflow present." >> $GITHUB_STEP_SUMMARY
fi fi
else else
echo "**** ${br} is either a dev branch, or has no external version; skipping trigger. ****" echo "Skipping branch due to being detected as dev branch or having no external version." >> $GITHUB_STEP_SUMMARY
echo "Skipping branch ${br} due to being detected as dev branch or having no external version." >> $GITHUB_STEP_SUMMARY
fi fi
done done

6
.github/workflows/greetings.yml vendored Executable file → Normal file
View File

@ -2,8 +2,14 @@ name: Greetings
on: [pull_request_target, issues] on: [pull_request_target, issues]
permissions:
contents: read
jobs: jobs:
greeting: greeting:
permissions:
issues: write
pull-requests: write
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/first-interaction@v1 - uses: actions/first-interaction@v1

View File

@ -1,42 +0,0 @@
name: Package Trigger Main
on:
workflow_dispatch:
jobs:
package-trigger-master:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3.1.0
- name: Package Trigger
if: github.ref == 'refs/heads/master'
run: |
if [ -n "${{ secrets.PAUSE_PACKAGE_TRIGGER_BOOKSTACK_MASTER }}" ]; then
echo "**** Github secret PAUSE_PACKAGE_TRIGGER_BOOKSTACK_MASTER is set; skipping trigger. ****"
echo "Github secret \`PAUSE_PACKAGE_TRIGGER_BOOKSTACK_MASTER\` is set; skipping trigger." >> $GITHUB_STEP_SUMMARY
exit 0
fi
if [ $(curl -s https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-bookstack/job/master/lastBuild/api/json | jq -r '.building') == "true" ]; then
echo "**** There already seems to be an active build on Jenkins; skipping package trigger ****"
echo "There already seems to be an active build on Jenkins; skipping package trigger" >> $GITHUB_STEP_SUMMARY
exit 0
fi
echo "**** Package trigger running off of master branch. To disable, set a Github secret named \"PAUSE_PACKAGE_TRIGGER_BOOKSTACK_MASTER\". ****"
echo "Package trigger running off of master branch. To disable, set a Github secret named \`PAUSE_PACKAGE_TRIGGER_BOOKSTACK_MASTER\`" >> $GITHUB_STEP_SUMMARY
response=$(curl -iX POST \
https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-bookstack/job/master/buildWithParameters?PACKAGE_CHECK=true \
--user ${{ secrets.JENKINS_USER }}:${{ secrets.JENKINS_TOKEN }} | grep -i location | sed "s|^[L|l]ocation: \(.*\)|\1|")
echo "**** Jenkins job queue url: ${response%$'\r'} ****"
echo "**** Sleeping 10 seconds until job starts ****"
sleep 10
buildurl=$(curl -s "${response%$'\r'}api/json" | jq -r '.executable.url')
buildurl="${buildurl%$'\r'}"
echo "**** Jenkins job build url: ${buildurl} ****"
echo "Jenkins job build url: ${buildurl}" >> $GITHUB_STEP_SUMMARY
echo "**** Attempting to change the Jenkins job description ****"
curl -iX POST \
"${buildurl}submitDescription" \
--user ${{ secrets.JENKINS_USER }}:${{ secrets.JENKINS_TOKEN }} \
--data-urlencode "description=GHA package trigger https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}" \
--data-urlencode "Submit=Submit"

107
.github/workflows/package_trigger_scheduler.yml vendored Executable file → Normal file
View File

@ -5,46 +5,99 @@ on:
- cron: '4 18 * * 1' - cron: '4 18 * * 1'
workflow_dispatch: workflow_dispatch:
permissions:
contents: read
jobs: jobs:
package-trigger-scheduler: package-trigger-scheduler:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v3.1.0 - uses: actions/checkout@v4.1.1
with: with:
fetch-depth: '0' fetch-depth: '0'
- name: Package Trigger Scheduler - name: Package Trigger Scheduler
env:
SKIP_PACKAGE_TRIGGER: ${{ vars.SKIP_PACKAGE_TRIGGER }}
run: | run: |
echo "**** Branches found: ****" printf "# Package trigger scheduler for docker-bookstack\n\n" >> $GITHUB_STEP_SUMMARY
git for-each-ref --format='%(refname:short)' refs/remotes printf "Found the branches:\n\n%s\n" "$(git for-each-ref --format='- %(refname:lstrip=3)' refs/remotes)" >> $GITHUB_STEP_SUMMARY
for br in $(git for-each-ref --format='%(refname:short)' refs/remotes) for br in $(git for-each-ref --format='%(refname:lstrip=3)' refs/remotes)
do do
br=$(echo "$br" | sed 's|origin/||g') if [[ "${br}" == "HEAD" ]]; then
echo "**** Evaluating branch ${br} ****" printf "\nSkipping %s.\n" ${br} >> $GITHUB_STEP_SUMMARY
ls_branch=$(curl -sX GET https://raw.githubusercontent.com/linuxserver/docker-bookstack/${br}/jenkins-vars.yml | yq -r '.ls_branch') continue
if [ "${br}" == "${ls_branch}" ]; then fi
echo "**** Branch ${br} appears to be live; checking workflow. ****" printf "\n## Evaluating \`%s\`\n\n" ${br} >> $GITHUB_STEP_SUMMARY
if curl -sfX GET https://raw.githubusercontent.com/linuxserver/docker-bookstack/${br}/.github/workflows/package_trigger.yml > /dev/null 2>&1; then JENKINS_VARS=$(curl -sX GET https://raw.githubusercontent.com/linuxserver/docker-bookstack/${br}/jenkins-vars.yml)
echo "**** Workflow exists. Triggering package trigger workflow for branch ${br}. ****" if ! curl -sfX GET https://raw.githubusercontent.com/linuxserver/docker-bookstack/${br}/Jenkinsfile >/dev/null 2>&1; then
echo "Triggering package trigger workflow for branch ${br}" >> $GITHUB_STEP_SUMMARY echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY
triggered_branches="${triggered_branches}${br} " echo "> No Jenkinsfile found. Branch is either deprecated or is an early dev branch." >> $GITHUB_STEP_SUMMARY
curl -iX POST \ skipped_branches="${skipped_branches}${br} "
-H "Authorization: token ${{ secrets.CR_PAT }}" \ elif [[ "${br}" == $(yq -r '.ls_branch' <<< "${JENKINS_VARS}") ]]; then
-H "Accept: application/vnd.github.v3+json" \ echo "Branch appears to be live; checking workflow." >> $GITHUB_STEP_SUMMARY
-d "{\"ref\":\"refs/heads/${br}\"}" \ README_VARS=$(curl -sX GET https://raw.githubusercontent.com/linuxserver/docker-bookstack/${br}/readme-vars.yml)
https://api.github.com/repos/linuxserver/docker-bookstack/actions/workflows/package_trigger.yml/dispatches if [[ $(yq -r '.project_deprecation_status' <<< "${README_VARS}") == "true" ]]; then
sleep 30 echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY
echo "> Branch appears to be deprecated; skipping trigger." >> $GITHUB_STEP_SUMMARY
skipped_branches="${skipped_branches}${br} "
elif [[ $(yq -r '.skip_package_check' <<< "${JENKINS_VARS}") == "true" ]]; then
echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY
echo "> Skipping branch ${br} due to \`skip_package_check\` being set in \`jenkins-vars.yml\`." >> $GITHUB_STEP_SUMMARY
skipped_branches="${skipped_branches}${br} "
elif grep -q "^bookstack_${br}" <<< "${SKIP_PACKAGE_TRIGGER}"; then
echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY
echo "> Github organizational variable \`SKIP_PACKAGE_TRIGGER\` contains \`bookstack_${br}\`; skipping trigger." >> $GITHUB_STEP_SUMMARY
skipped_branches="${skipped_branches}${br} "
elif [ $(curl -s https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-bookstack/job/${br}/lastBuild/api/json | jq -r '.building' 2>/dev/null) == "true" ]; then
echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY
echo "> There already seems to be an active build on Jenkins; skipping package trigger for ${br}" >> $GITHUB_STEP_SUMMARY
skipped_branches="${skipped_branches}${br} "
else else
echo "**** Workflow doesn't exist; skipping trigger. ****" echo "> [!NOTE]" >> $GITHUB_STEP_SUMMARY
echo "Skipping branch ${br} due to no package trigger workflow present." >> $GITHUB_STEP_SUMMARY echo "> Triggering package trigger for branch ${br}" >> $GITHUB_STEP_SUMMARY
printf "> To disable, add \`bookstack_%s\` into the Github organizational variable \`SKIP_PACKAGE_TRIGGER\`.\n\n" "${br}" >> $GITHUB_STEP_SUMMARY
triggered_branches="${triggered_branches}${br} "
response=$(curl -iX POST \
https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-bookstack/job/${br}/buildWithParameters?PACKAGE_CHECK=true \
--user ${{ secrets.JENKINS_USER }}:${{ secrets.JENKINS_TOKEN }} | grep -i location | sed "s|^[L|l]ocation: \(.*\)|\1|")
if [[ -z "${response}" ]]; then
echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY
echo "> Jenkins build could not be triggered. Skipping branch."
continue
fi
echo "Jenkins [job queue url](${response%$'\r'})" >> $GITHUB_STEP_SUMMARY
echo "Sleeping 10 seconds until job starts" >> $GITHUB_STEP_SUMMARY
sleep 10
buildurl=$(curl -s "${response%$'\r'}api/json" | jq -r '.executable.url')
buildurl="${buildurl%$'\r'}"
echo "Jenkins job [build url](${buildurl})" >> $GITHUB_STEP_SUMMARY
echo "Attempting to change the Jenkins job description" >> $GITHUB_STEP_SUMMARY
if ! curl -ifX POST \
"${buildurl}submitDescription" \
--user ${{ secrets.JENKINS_USER }}:${{ secrets.JENKINS_TOKEN }} \
--data-urlencode "description=GHA package trigger https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}" \
--data-urlencode "Submit=Submit"; then
echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY
echo "> Unable to change the Jenkins job description."
fi
sleep 20
fi fi
else else
echo "**** ${br} appears to be a dev branch; skipping trigger. ****"
echo "Skipping branch ${br} due to being detected as dev branch." >> $GITHUB_STEP_SUMMARY echo "Skipping branch ${br} due to being detected as dev branch." >> $GITHUB_STEP_SUMMARY
fi fi
done done
echo "**** Package check build(s) triggered for branch(es): ${triggered_branches} ****" if [[ -n "${triggered_branches}" ]] || [[ -n "${skipped_branches}" ]]; then
echo "**** Notifying Discord ****" if [[ -n "${triggered_branches}" ]]; then
curl -X POST -H "Content-Type: application/json" --data '{"avatar_url": "https://cdn.discordapp.com/avatars/354986384542662657/df91181b3f1cf0ef1592fbe18e0962d7.png","embeds": [{"color": 9802903, NOTIFY_BRANCHES="**Triggered:** ${triggered_branches} \n"
"description": "**Package Check Build(s) Triggered for bookstack** \n**Branch(es):** '"${triggered_branches}"' \n**Build URL:** '"https://ci.linuxserver.io/blue/organizations/jenkins/Docker-Pipeline-Builders%2Fdocker-bookstack/activity/"' \n"}], NOTIFY_BUILD_URL="**Build URL:** https://ci.linuxserver.io/blue/organizations/jenkins/Docker-Pipeline-Builders%2Fdocker-bookstack/activity/ \n"
"username": "Github Actions"}' ${{ secrets.DISCORD_WEBHOOK }} echo "**** Package check build(s) triggered for branch(es): ${triggered_branches} ****"
fi
if [[ -n "${skipped_branches}" ]]; then
NOTIFY_BRANCHES="${NOTIFY_BRANCHES}**Skipped:** ${skipped_branches} \n"
fi
echo "**** Notifying Discord ****"
curl -X POST -H "Content-Type: application/json" --data '{"avatar_url": "https://cdn.discordapp.com/avatars/354986384542662657/df91181b3f1cf0ef1592fbe18e0962d7.png","embeds": [{"color": 9802903,
"description": "**Package Check Build(s) for bookstack** \n'"${NOTIFY_BRANCHES}"''"${NOTIFY_BUILD_URL}"'"}],
"username": "Github Actions"}' ${{ secrets.DISCORD_WEBHOOK }}
fi

2
.github/workflows/permissions.yml vendored Executable file → Normal file
View File

@ -5,6 +5,8 @@ on:
- '**/run' - '**/run'
- '**/finish' - '**/finish'
- '**/check' - '**/check'
- 'root/migrations/*'
jobs: jobs:
permission_check: permission_check:
uses: linuxserver/github-workflows/.github/workflows/init-svc-executable-permissions.yml@v1 uses: linuxserver/github-workflows/.github/workflows/init-svc-executable-permissions.yml@v1

View File

@ -1,16 +1,15 @@
# syntax=docker/dockerfile:1 # syntax=docker/dockerfile:1
FROM ghcr.io/linuxserver/baseimage-alpine-nginx:3.18 FROM ghcr.io/linuxserver/baseimage-alpine-nginx:3.23
# set version label # set version label
ARG BUILD_DATE ARG BUILD_DATE
ARG VERSION ARG VERSION
ARG BOOKSTACK_RELEASE ARG BOOKSTACK_RELEASE
LABEL build_version="Linuxserver.io version:- ${VERSION} Build-date:- ${BUILD_DATE}" LABEL build_version="Linuxserver.io version:- ${VERSION} Build-date:- ${BUILD_DATE}"
LABEL maintainer="homerr" LABEL maintainer="thespad"
# package versions ENV S6_STAGE2_HOOK="/init-hook"
ARG BOOKSTACK_RELEASE
RUN \ RUN \
echo "**** install runtime packages ****" && \ echo "**** install runtime packages ****" && \
@ -18,19 +17,20 @@ RUN \
fontconfig \ fontconfig \
mariadb-client \ mariadb-client \
memcached \ memcached \
php82-dom \ php85-dom \
php82-gd \ php85-exif \
php82-ldap \ php85-gd \
php82-mysqlnd \ php85-ldap \
php82-pdo_mysql \ php85-mysqlnd \
php82-pecl-memcached \ php85-pdo_mysql \
php82-tokenizer \ php85-pecl-memcached \
php85-tokenizer \
qt5-qtbase \ qt5-qtbase \
ttf-freefont && \ ttf-freefont && \
echo "**** configure php-fpm to pass env vars ****" && \ echo "**** configure php-fpm to pass env vars ****" && \
sed -E -i 's/^;?clear_env ?=.*$/clear_env = no/g' /etc/php82/php-fpm.d/www.conf && \ sed -E -i 's/^;?clear_env ?=.*$/clear_env = no/g' /etc/php85/php-fpm.d/www.conf && \
grep -qxF 'clear_env = no' /etc/php82/php-fpm.d/www.conf || echo 'clear_env = no' >> /etc/php82/php-fpm.d/www.conf && \ if ! grep -qxF 'clear_env = no' /etc/php85/php-fpm.d/www.conf; then echo 'clear_env = no' >> /etc/php85/php-fpm.d/www.conf; fi && \
echo "env[PATH] = /usr/local/bin:/usr/bin:/bin" >> /etc/php82/php-fpm.conf && \ echo "env[PATH] = /usr/local/bin:/usr/bin:/bin" >> /etc/php85/php-fpm.conf && \
echo "**** fetch bookstack ****" && \ echo "**** fetch bookstack ****" && \
mkdir -p\ mkdir -p\
/app/www && \ /app/www && \
@ -46,6 +46,12 @@ RUN \
/app/www/ --strip-components=1 && \ /app/www/ --strip-components=1 && \
echo "**** install composer dependencies ****" && \ echo "**** install composer dependencies ****" && \
composer install -d /app/www/ && \ composer install -d /app/www/ && \
printf "Linuxserver.io version: ${VERSION}\nBuild-date: ${BUILD_DATE}" > /build_version && \
echo "**** create symlinks ****" && \
/bin/bash -c \
'dst=(www/themes www/files www/images www/uploads backups www/framework/cache www/framework/sessions www/framework/views www/framework/purifier log/bookstack/laravel.log www/.env); \
src=(themes storage/uploads/files storage/uploads/images public/uploads storage/backups storage/framework/cache storage/framework/sessions storage/framework/views storage/framework/purifier storage/logs/laravel.log .env); \
for i in "${!src[@]}"; do rm -rf /app/www/"${src[i]}" && ln -s /config/"${dst[i]}" /app/www/"${src[i]}"; done' && \
echo "**** cleanup ****" && \ echo "**** cleanup ****" && \
rm -rf \ rm -rf \
/tmp/* \ /tmp/* \

View File

@ -1,16 +1,15 @@
# syntax=docker/dockerfile:1 # syntax=docker/dockerfile:1
FROM ghcr.io/linuxserver/baseimage-alpine-nginx:arm64v8-3.18 FROM ghcr.io/linuxserver/baseimage-alpine-nginx:arm64v8-3.23
# set version label # set version label
ARG BUILD_DATE ARG BUILD_DATE
ARG VERSION ARG VERSION
ARG BOOKSTACK_RELEASE ARG BOOKSTACK_RELEASE
LABEL build_version="Linuxserver.io version:- ${VERSION} Build-date:- ${BUILD_DATE}" LABEL build_version="Linuxserver.io version:- ${VERSION} Build-date:- ${BUILD_DATE}"
LABEL maintainer="homerr" LABEL maintainer="thespad"
# package versions ENV S6_STAGE2_HOOK="/init-hook"
ARG BOOKSTACK_RELEASE
RUN \ RUN \
echo "**** install runtime packages ****" && \ echo "**** install runtime packages ****" && \
@ -18,19 +17,20 @@ RUN \
fontconfig \ fontconfig \
mariadb-client \ mariadb-client \
memcached \ memcached \
php82-dom \ php85-dom \
php82-gd \ php85-exif \
php82-ldap \ php85-gd \
php82-mysqlnd \ php85-ldap \
php82-pdo_mysql \ php85-mysqlnd \
php82-pecl-memcached \ php85-pdo_mysql \
php82-tokenizer \ php85-pecl-memcached \
php85-tokenizer \
qt5-qtbase \ qt5-qtbase \
ttf-freefont && \ ttf-freefont && \
echo "**** configure php-fpm to pass env vars ****" && \ echo "**** configure php-fpm to pass env vars ****" && \
sed -E -i 's/^;?clear_env ?=.*$/clear_env = no/g' /etc/php82/php-fpm.d/www.conf && \ sed -E -i 's/^;?clear_env ?=.*$/clear_env = no/g' /etc/php85/php-fpm.d/www.conf && \
grep -qxF 'clear_env = no' /etc/php82/php-fpm.d/www.conf || echo 'clear_env = no' >> /etc/php82/php-fpm.d/www.conf && \ if ! grep -qxF 'clear_env = no' /etc/php85/php-fpm.d/www.conf; then echo 'clear_env = no' >> /etc/php85/php-fpm.d/www.conf; fi && \
echo "env[PATH] = /usr/local/bin:/usr/bin:/bin" >> /etc/php82/php-fpm.conf && \ echo "env[PATH] = /usr/local/bin:/usr/bin:/bin" >> /etc/php85/php-fpm.conf && \
echo "**** fetch bookstack ****" && \ echo "**** fetch bookstack ****" && \
mkdir -p\ mkdir -p\
/app/www && \ /app/www && \
@ -46,6 +46,12 @@ RUN \
/app/www/ --strip-components=1 && \ /app/www/ --strip-components=1 && \
echo "**** install composer dependencies ****" && \ echo "**** install composer dependencies ****" && \
composer install -d /app/www/ && \ composer install -d /app/www/ && \
printf "Linuxserver.io version: ${VERSION}\nBuild-date: ${BUILD_DATE}" > /build_version && \
echo "**** create symlinks ****" && \
/bin/bash -c \
'dst=(www/themes www/files www/images www/uploads backups www/framework/cache www/framework/sessions www/framework/views www/framework/purifier log/bookstack/laravel.log www/.env); \
src=(themes storage/uploads/files storage/uploads/images public/uploads storage/backups storage/framework/cache storage/framework/sessions storage/framework/views storage/framework/purifier storage/logs/laravel.log .env); \
for i in "${!src[@]}"; do rm -rf /app/www/"${src[i]}" && ln -s /config/"${dst[i]}" /app/www/"${src[i]}"; done' && \
echo "**** cleanup ****" && \ echo "**** cleanup ****" && \
rm -rf \ rm -rf \
/tmp/* \ /tmp/* \

775
Jenkinsfile vendored

File diff suppressed because it is too large Load Diff

0
LICENSE Executable file → Normal file
View File

272
README.md
View File

@ -1,12 +1,10 @@
<!-- DO NOT EDIT THIS FILE MANUALLY --> <!-- DO NOT EDIT THIS FILE MANUALLY -->
<!-- Please read the https://github.com/linuxserver/docker-bookstack/blob/master/.github/CONTRIBUTING.md --> <!-- Please read https://github.com/linuxserver/docker-bookstack/blob/master/.github/CONTRIBUTING.md -->
[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)](https://linuxserver.io) [![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)](https://linuxserver.io)
[![Blog](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=Blog)](https://blog.linuxserver.io "all the things you can do with our containers including How-To guides, opinions and much more!") [![Blog](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=Blog)](https://blog.linuxserver.io "all the things you can do with our containers including How-To guides, opinions and much more!")
[![Discord](https://img.shields.io/discord/354974912613449730.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=Discord&logo=discord)](https://discord.gg/YWrKVTn "realtime support / chat with the community and the team.") [![Discord](https://img.shields.io/discord/354974912613449730.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=Discord&logo=discord)](https://linuxserver.io/discord "realtime support / chat with the community and the team.")
[![Discourse](https://img.shields.io/discourse/https/discourse.linuxserver.io/topics.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=discourse)](https://discourse.linuxserver.io "post on our community forum.") [![Discourse](https://img.shields.io/discourse/https/discourse.linuxserver.io/topics.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=discourse)](https://discourse.linuxserver.io "post on our community forum.")
[![Fleet](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=Fleet)](https://fleet.linuxserver.io "an online web interface which displays all of our maintained images.")
[![GitHub](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitHub&logo=github)](https://github.com/linuxserver "view the source for all of our repositories.") [![GitHub](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitHub&logo=github)](https://github.com/linuxserver "view the source for all of our repositories.")
[![Open Collective](https://img.shields.io/opencollective/all/linuxserver.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=Supporters&logo=open%20collective)](https://opencollective.com/linuxserver "please consider helping us by either donating or contributing to our budget") [![Open Collective](https://img.shields.io/opencollective/all/linuxserver.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=Supporters&logo=open%20collective)](https://opencollective.com/linuxserver "please consider helping us by either donating or contributing to our budget")
@ -21,15 +19,14 @@ The [LinuxServer.io](https://linuxserver.io) team brings you another container r
Find us at: Find us at:
* [Blog](https://blog.linuxserver.io) - all the things you can do with our containers including How-To guides, opinions and much more! * [Blog](https://blog.linuxserver.io) - all the things you can do with our containers including How-To guides, opinions and much more!
* [Discord](https://discord.gg/YWrKVTn) - realtime support / chat with the community and the team. * [Discord](https://linuxserver.io/discord) - realtime support / chat with the community and the team.
* [Discourse](https://discourse.linuxserver.io) - post on our community forum. * [Discourse](https://discourse.linuxserver.io) - post on our community forum.
* [Fleet](https://fleet.linuxserver.io) - an online web interface which displays all of our maintained images.
* [GitHub](https://github.com/linuxserver) - view the source for all of our repositories. * [GitHub](https://github.com/linuxserver) - view the source for all of our repositories.
* [Open Collective](https://opencollective.com/linuxserver) - please consider helping us by either donating or contributing to our budget * [Open Collective](https://opencollective.com/linuxserver) - please consider helping us by either donating or contributing to our budget
# [linuxserver/bookstack](https://github.com/linuxserver/docker-bookstack) # [linuxserver/bookstack](https://github.com/linuxserver/docker-bookstack)
[![Scarf.io pulls](https://scarf.sh/installs-badge/linuxserver-ci/linuxserver%2Fbookstack?color=94398d&label-color=555555&logo-color=ffffff&style=for-the-badge&package-type=docker)](https://scarf.sh/gateway/linuxserver-ci/docker/linuxserver%2Fbookstack) [![Scarf.io pulls](https://scarf.sh/installs-badge/linuxserver-ci/linuxserver%2Fbookstack?color=94398d&label-color=555555&logo-color=ffffff&style=for-the-badge&package-type=docker)](https://scarf.sh)
[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-bookstack.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-bookstack) [![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-bookstack.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-bookstack)
[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-bookstack.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-bookstack/releases) [![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-bookstack.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-bookstack/releases)
[![GitHub Package Repository](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitHub%20Package&logo=github)](https://github.com/linuxserver/docker-bookstack/packages) [![GitHub Package Repository](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitHub%20Package&logo=github)](https://github.com/linuxserver/docker-bookstack/packages)
@ -38,7 +35,6 @@ Find us at:
[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/bookstack.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker)](https://hub.docker.com/r/linuxserver/bookstack) [![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/bookstack.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker)](https://hub.docker.com/r/linuxserver/bookstack)
[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/bookstack.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=stars&logo=docker)](https://hub.docker.com/r/linuxserver/bookstack) [![Docker Stars](https://img.shields.io/docker/stars/linuxserver/bookstack.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=stars&logo=docker)](https://hub.docker.com/r/linuxserver/bookstack)
[![Jenkins Build](https://img.shields.io/jenkins/build?labelColor=555555&logoColor=ffffff&style=for-the-badge&jobUrl=https%3A%2F%2Fci.linuxserver.io%2Fjob%2FDocker-Pipeline-Builders%2Fjob%2Fdocker-bookstack%2Fjob%2Fmaster%2F&logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-bookstack/job/master/) [![Jenkins Build](https://img.shields.io/jenkins/build?labelColor=555555&logoColor=ffffff&style=for-the-badge&jobUrl=https%3A%2F%2Fci.linuxserver.io%2Fjob%2FDocker-Pipeline-Builders%2Fjob%2Fdocker-bookstack%2Fjob%2Fmaster%2F&logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-bookstack/job/master/)
[![LSIO CI](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=CI&query=CI&url=https%3A%2F%2Fci-tests.linuxserver.io%2Flinuxserver%2Fbookstack%2Flatest%2Fci-status.yml)](https://ci-tests.linuxserver.io/linuxserver/bookstack/latest/index.html)
[Bookstack](https://github.com/BookStackApp/BookStack) 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. [Bookstack](https://github.com/BookStackApp/BookStack) 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.
@ -46,11 +42,11 @@ Powered by SQL and including a Markdown editor for those who prefer it, BookStac
For more information on BookStack visit their website and check it out: https://www.bookstackapp.com For more information on BookStack visit their website and check it out: https://www.bookstackapp.com
[![bookstack](https://s3-us-west-2.amazonaws.com/linuxserver-docs/images/bookstack-logo500x500.png)](https://github.com/BookStackApp/BookStack) [![bookstack](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/bookstack-logo.png)](https://github.com/BookStackApp/BookStack)
## Supported Architectures ## Supported Architectures
We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/). We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://distribution.github.io/distribution/spec/manifest-v2-2/#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/).
Simply pulling `lscr.io/linuxserver/bookstack:latest` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. Simply pulling `lscr.io/linuxserver/bookstack:latest` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
@ -60,87 +56,86 @@ The architectures supported by this image are:
| :----: | :----: | ---- | | :----: | :----: | ---- |
| x86-64 | ✅ | amd64-\<version tag\> | | x86-64 | ✅ | amd64-\<version tag\> |
| arm64 | ✅ | arm64v8-\<version tag\> | | arm64 | ✅ | arm64v8-\<version tag\> |
| armhf | ❌ | |
## Application Setup ## Application Setup
The default username is admin@admin.com with the password of **password**, access the container at http://dockerhost:6875. The default username is admin@admin.com with the password of **password**, access the container at http://<host ip>: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/.
This application is dependent on a MariaDB database, be it one you already have or a new one. If you do not already have one, we provide an image here https://github.com/linuxserver/docker-mariadb.
If you intend to use this application behind a subfolder reverse proxy, such as our SWAG container or Traefik you will need to make sure that the `APP_URL` environment variable is set to your external domain, or it will not work. If you intend to use this application behind a subfolder reverse proxy, such as our SWAG container or Traefik you will need to make sure that the `APP_URL` environment variable is set to your external domain, or it will not work.
Documentation for BookStack can be found at https://www.bookstackapp.com/docs/. Documentation for BookStack can be found at https://www.bookstackapp.com/docs/.
### BookStack File & Directory Paths ### BookStack File & Directory Paths
This container ensures certain BookStack application files & folders, such as user file upload folders, are retained within the `/config` folder so that they are persistent & accessible when the `/config` container path is bound as a volume. There may be cases, when following the BookStack documentation, that you'll need to know how these files and folders are used relative to a non-container BookStack installation. This container ensures certain BookStack application files & folders, such as user file upload folders, are retained within the `/config` folder so that they are persistent & accessible when the `/config` container path is bound as a volume. There may be cases, when following the BookStack documentation, that you'll need to know how these files and folders are used relative to a non-container BookStack installation.
Below is a mapping of container `/config` paths to those relative within a BookStack install directory: Below is a mapping of container `/config` paths to those relative within a BookStack install directory:
- **/config container path** => **BookStack relative path** - **/config container path** => **BookStack relative path**
- `/config/www/.env` => `.env` - `/config/www/.env` => `.env`
- `/config/www/laravel.log` => `storage/logs/laravel.log` - `/config/log/bookstack/laravel.log` => `storage/logs/laravel.log`
- `/config/www/backups/` => `storage/backups/` - `/config/backups/` => `storage/backups/`
- `/config/www/files/` => `storage/uploads/files/` - `/config/www/files/` => `storage/uploads/files/`
- `/config/www/images/` => `storage/uploads/images/` - `/config/www/images/` => `storage/uploads/images/`
- `/config/www/themes/` => `themes/` - `/config/www/themes/` => `themes/`
- `/config/www/uploads/` => `public/uploads/` - `/config/www/uploads/` => `public/uploads/`
### Changing APP_URL
If you change the APP_URL after initial install, you should run the following line from your host terminal to update the database URL entries:
```shell
docker exec -it bookstack php /app/www/artisan bookstack:update-url ${OLD_URL} ${NEW_URL}
```
### Advanced Users (full control over the .env file) ### 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. The container will copy an exemplary .env file to /config/www/.env on your host system for you to edit.
#### PDF Rendering If you wish to use the extra functionality of BookStack such as email, LDAP and so on you will need to set additional environment variables or make your own .env file with guidance from the BookStack documentation.
[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`. The container will copy an exemplary .env file to /config/www/.env on your host system for you to use.
## Read-Only Operation
This image can be run with a read-only container filesystem. For details please [read the docs](https://docs.linuxserver.io/misc/read-only/).
### Caveats
* `/tmp` must be mounted to tmpfs
## Usage ## Usage
Here are some example snippets to help you get started creating a container. To help you get started creating a container from this image you can either use docker-compose or the docker cli.
>[!NOTE]
>Unless a parameter is flagged as 'optional', it is *mandatory* and a value must be provided.
### docker-compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose)) ### docker-compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose))
```yaml ```yaml
--- ---
version: "2"
services: services:
bookstack: bookstack:
image: lscr.io/linuxserver/bookstack image: lscr.io/linuxserver/bookstack:latest
container_name: bookstack container_name: bookstack
environment: environment:
- PUID=1000 - PUID=1000
- PGID=1000 - PGID=1000
- APP_URL=https://bookstack.example.com - TZ=Etc/UTC
- DB_HOST=bookstack_db - APP_URL=
- APP_KEY=
- DB_HOST=
- DB_PORT=3306 - DB_PORT=3306
- DB_USER=bookstack - DB_USERNAME=
- DB_PASS=<yourdbpass> - DB_PASSWORD=
- DB_DATABASE=bookstackapp - DB_DATABASE=
- QUEUE_CONNECTION= #optional
volumes: volumes:
- ./bookstack_app_data:/config - /path/to/bookstack/config:/config
ports: ports:
- 6875:80 - 6875:80
restart: unless-stopped restart: unless-stopped
depends_on:
- bookstack_db
bookstack_db:
image: lscr.io/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:
- ./bookstack_db_data:/config
restart: unless-stopped
``` ```
### docker cli ([click here for more info](https://docs.docker.com/engine/reference/commandline/cli/)) ### docker cli ([click here for more info](https://docs.docker.com/engine/reference/commandline/cli/))
@ -151,36 +146,40 @@ docker run -d \
-e PUID=1000 \ -e PUID=1000 \
-e PGID=1000 \ -e PGID=1000 \
-e TZ=Etc/UTC \ -e TZ=Etc/UTC \
-e APP_URL=<yourbaseurl> \ -e APP_URL= \
-e DB_HOST=<yourdbhost> \ -e APP_KEY= \
-e DB_PORT=<yourdbport> \ -e DB_HOST= \
-e DB_USER=<yourdbuser> \ -e DB_PORT=3306 \
-e DB_PASS=<yourdbpass> \ -e DB_USERNAME= \
-e DB_DATABASE=bookstackapp \ -e DB_PASSWORD= \
-e DB_DATABASE= \
-e QUEUE_CONNECTION= `#optional` \
-p 6875:80 \ -p 6875:80 \
-v /path/to/data:/config \ -v /path/to/bookstack/config:/config \
--restart unless-stopped \ --restart unless-stopped \
lscr.io/linuxserver/bookstack:latest lscr.io/linuxserver/bookstack:latest
``` ```
## Parameters ## Parameters
Container images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container. Containers are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
| Parameter | Function | | Parameter | Function |
| :----: | --- | | :----: | --- |
| `-p 80` | will map the container's port 80 to port 6875 on the host | | `-p 6875:80` | http/s web interface. |
| `-e PUID=1000` | for UserID - see below for explanation | | `-e PUID=1000` | for UserID - see below for explanation |
| `-e PGID=1000` | for GroupID - see below for explanation | | `-e PGID=1000` | for GroupID - see below for explanation |
| `-e TZ=Etc/UTC` | specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). | | `-e TZ=Etc/UTC` | specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). |
| `-e APP_URL=<yourbaseurl>` | 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` | | `-e APP_URL=` | The protocol, IP/URL, and port that your application will be accessed on (ie. `http://192.168.1.1:6875` or `https://bookstack.mydomain.com` |
| `-e DB_HOST=<yourdbhost>` | for specifying the database host | | `-e APP_KEY=` | Session encryption key. You will need to generate this with `docker run -it --rm --entrypoint /bin/bash lscr.io/linuxserver/bookstack:latest appkey` |
| `-e DB_PORT=<yourdbport>` | for specifying the database port if not default 3306 | | `-e DB_HOST=` | The database instance hostname |
| `-e DB_USER=<yourdbuser>` | for specifying the database user | | `-e DB_PORT=3306` | Database port |
| `-e DB_PASS=<yourdbpass>` | for specifying the database password (non-alphanumeric passwords must be properly escaped.) | | `-e DB_USERNAME=` | Database user |
| `-e DB_DATABASE=bookstackapp` | for specifying the database to be used | | `-e DB_PASSWORD=` | Database password (minimum 4 characters & non-alphanumeric passwords must be properly escaped.) |
| `-v /config` | this will store any uploaded data on the docker host | | `-e DB_DATABASE=` | Database name |
| `-e QUEUE_CONNECTION=` | Set to `database` to enable async actions like sending email or triggering webhooks. See [documentation](https://www.bookstackapp.com/docs/admin/email-webhooks/#async-action-handling). |
| `-v /config` | Persistent config files |
| `--read-only=true` | Run container with a read-only filesystem. Please [read the docs](https://docs.linuxserver.io/misc/read-only/). |
## Environment variables from files (Docker secrets) ## Environment variables from files (Docker secrets)
@ -189,10 +188,10 @@ You can set any environment variable from a file by using a special prepend `FIL
As an example: As an example:
```bash ```bash
-e FILE__PASSWORD=/run/secrets/mysecretpassword -e FILE__MYVAR=/run/secrets/mysecretvariable
``` ```
Will set the environment variable `PASSWORD` based on the contents of the `/run/secrets/mysecretpassword` file. Will set the environment variable `MYVAR` based on the contents of the `/run/secrets/mysecretvariable` file.
## Umask for running applications ## Umask for running applications
@ -201,15 +200,20 @@ Keep in mind umask is not chmod it subtracts from permissions based on it's valu
## User / Group Identifiers ## User / Group Identifiers
When using volumes (`-v` flags) permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user `PUID` and group `PGID`. When using volumes (`-v` flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user `PUID` and group `PGID`.
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic. Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below: In this instance `PUID=1000` and `PGID=1000`, to find yours use `id your_user` as below:
```bash ```bash
$ id username id your_user
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup) ```
Example output:
```text
uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)
``` ```
## Docker Mods ## Docker Mods
@ -220,53 +224,101 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to
## Support Info ## Support Info
* Shell access whilst the container is running: `docker exec -it bookstack /bin/bash` * Shell access whilst the container is running:
* To monitor the logs of the container in realtime: `docker logs -f bookstack`
* container version number ```bash
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' bookstack` docker exec -it bookstack /bin/bash
* image version number ```
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/bookstack:latest`
* To monitor the logs of the container in realtime:
```bash
docker logs -f bookstack
```
* Container version number:
```bash
docker inspect -f '{{ index .Config.Labels "build_version" }}' bookstack
```
* Image version number:
```bash
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/bookstack:latest
```
## Updating Info ## Updating Info
Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (ie. nextcloud, plex), we do not recommend or support updating apps inside the container. Please consult the [Application Setup](#application-setup) section above to see if it is recommended for the image. Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (noted in the relevant readme.md), we do not recommend or support updating apps inside the container. Please consult the [Application Setup](#application-setup) section above to see if it is recommended for the image.
Below are the instructions for updating containers: Below are the instructions for updating containers:
### Via Docker Compose ### Via Docker Compose
* Update all images: `docker-compose pull` * Update images:
* or update a single image: `docker-compose pull bookstack` * All images:
* Let compose update all containers as necessary: `docker-compose up -d`
* or update a single container: `docker-compose up -d bookstack` ```bash
* You can also remove the old dangling images: `docker image prune` docker-compose pull
```
* Single image:
```bash
docker-compose pull bookstack
```
* Update containers:
* All containers:
```bash
docker-compose up -d
```
* Single container:
```bash
docker-compose up -d bookstack
```
* You can also remove the old dangling images:
```bash
docker image prune
```
### Via Docker Run ### Via Docker Run
* Update the image: `docker pull lscr.io/linuxserver/bookstack:latest` * Update the image:
* Stop the running container: `docker stop bookstack`
* Delete the container: `docker rm bookstack` ```bash
docker pull lscr.io/linuxserver/bookstack:latest
```
* Stop the running container:
```bash
docker stop bookstack
```
* Delete the container:
```bash
docker rm bookstack
```
* Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your `/config` folder and settings will be preserved) * Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your `/config` folder and settings will be preserved)
* You can also remove the old dangling images: `docker image prune` * You can also remove the old dangling images:
### Via Watchtower auto-updater (only use if you don't remember the original parameters) ```bash
docker image prune
* Pull the latest image at its tag and replace it with the same env variables in one run: ```
```bash
docker run --rm \
-v /var/run/docker.sock:/var/run/docker.sock \
containrrr/watchtower \
--run-once bookstack
```
* You can also remove the old dangling images: `docker image prune`
**Note:** We do not endorse the use of Watchtower as a solution to automated updates of existing Docker containers. In fact we generally discourage automated updates. However, this is a useful tool for one-time manual updates of containers where you have forgotten the original parameters. In the long term, we highly recommend using [Docker Compose](https://docs.linuxserver.io/general/docker-compose).
### Image Update Notifications - Diun (Docker Image Update Notifier) ### Image Update Notifications - Diun (Docker Image Update Notifier)
* We recommend [Diun](https://crazymax.dev/diun/) for update notifications. Other tools that automatically update containers unattended are not recommended or supported. >[!TIP]
>We recommend [Diun](https://crazymax.dev/diun/) for update notifications. Other tools that automatically update containers unattended are not recommended or supported.
## Building locally ## Building locally
@ -281,16 +333,26 @@ docker build \
-t lscr.io/linuxserver/bookstack:latest . -t lscr.io/linuxserver/bookstack:latest .
``` ```
The ARM variants can be built on x86_64 hardware using `multiarch/qemu-user-static` The ARM variants can be built on x86_64 hardware and vice versa using `lscr.io/linuxserver/qemu-static`
```bash ```bash
docker run --rm --privileged multiarch/qemu-user-static:register --reset docker run --rm --privileged lscr.io/linuxserver/qemu-static --reset
``` ```
Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64`. Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64`.
## Versions ## Versions
* **28.12.25:** - Rebase to Alpine 3.23.
* **05.07.25:** - Rebase to Alpine 3.22.
* **04.01.25:** - Add php-opcache.
* **17.12.24:** - Rebase to Alpine 3.21.
* **11.10.24:** - Default to environment config over .env file config.
* **06.09.24:** - Add php-exif for reading image EXIF data.
* **27.05.24:** - Rebase to Alpine 3.20. Existing users should update their nginx confs to avoid http2 deprecation warnings.
* **25.01.24:** - Existing users should update: site-confs/default.conf - Cleanup default site conf.
* **23.12.23:** - Rebase to Alpine 3.19 with php 8.3.
* **31.10.23:** - Further sanitize sed replace.
* **07.06.23:** - Add mariadb-client for bookstack-system-cli support. * **07.06.23:** - Add mariadb-client for bookstack-system-cli support.
* **25.05.23:** - Rebase to Alpine 3.18, deprecate armhf. * **25.05.23:** - Rebase to Alpine 3.18, deprecate armhf.
* **13.04.23:** - Move ssl.conf include to default.conf. * **13.04.23:** - Move ssl.conf include to default.conf.

View File

@ -6,7 +6,6 @@ external_type: github_stable
release_type: stable release_type: stable
release_tag: latest release_tag: latest
ls_branch: master ls_branch: master
build_armhf: false
repo_vars: repo_vars:
- EXT_GIT_BRANCH = 'master' - EXT_GIT_BRANCH = 'master'
- EXT_USER = 'bookstackapp' - EXT_USER = 'bookstackapp'
@ -20,11 +19,11 @@ repo_vars:
- PR_DOCKERHUB_IMAGE = 'lspipepr/bookstack' - PR_DOCKERHUB_IMAGE = 'lspipepr/bookstack'
- DIST_IMAGE = 'alpine' - DIST_IMAGE = 'alpine'
- MULTIARCH = 'true' - MULTIARCH = 'true'
- CI = 'true' - CI = 'false'
- CI_WEB = 'false' - CI_WEB = 'false'
- CI_PORT = '80' - CI_PORT = '80'
- CI_SSL = 'false' - CI_SSL = 'false'
- CI_DELAY = '30' - CI_DELAY = '60'
- CI_DOCKERENV='TEST_RUN=1' - CI_DOCKERENV=''
- CI_AUTH = 'user:password' - CI_AUTH = ''
- CI_WEBPATH = '' - CI_WEBPATH = ''

View File

@ -1,287 +1,296 @@
NAME VERSION TYPE NAME VERSION TYPE
alpine-baselayout 3.4.3-r1 apk Hidden Input 1, 0, 0, 0 binary
alpine-baselayout-data 3.4.3-r1 apk acl-libs 2.3.2-r1 apk
alpine-keys 2.4-r1 apk alpine-baselayout 3.7.1-r8 apk
alpine-release 3.18.2-r0 apk alpine-baselayout-data 3.7.1-r8 apk
aom-libs 3.6.1-r0 apk alpine-keys 2.6-r0 apk
apache2-utils 2.4.57-r2 apk alpine-release 3.23.3-r0 apk
apk-tools 2.14.0-r2 apk aom-libs 3.13.1-r1 apk
apr 1.7.4-r0 apk apache2-utils 2.4.66-r0 apk
apr-util 1.6.3-r1 apk apk-tools 3.0.4-r0 apk
argon2-libs 20190702-r4 apk apr 1.7.6-r0 apk
aws/aws-crt-php v1.2.1 php-composer apr-util 1.6.3-r2 apk
aws/aws-sdk-php 3.269.0 php-composer argon2-libs 20190702-r5 apk
bacon/bacon-qr-code 2.0.8 php-composer aws/aws-crt-php v1.2.7 php-composer
barryvdh/laravel-dompdf v2.0.1 php-composer aws/aws-sdk-php 3.369.36 php-composer
barryvdh/laravel-snappy v1.0.2 php-composer bacon/bacon-qr-code v3.0.3 php-composer
bash 5.2.15-r5 apk bash 5.3.3-r1 apk
brick/math 0.11.0 php-composer brick/math 0.14.8 php-composer
brotli-libs 1.0.9-r14 apk brotli-libs 1.2.0-r0 apk
busybox 1.36.1 binary busybox 1.37.0-r30 apk
busybox 1.36.1-r0 apk busybox-binsh 1.37.0-r30 apk
busybox-binsh 1.36.1-r0 apk c-ares 1.34.6-r0 apk
ca-certificates 20230506-r0 apk ca-certificates 20251003-r0 apk
ca-certificates-bundle 20230506-r0 apk ca-certificates-bundle 20251003-r0 apk
coreutils 9.3-r1 apk carbonphp/carbon-doctrine-types 3.2.0 php-composer
curl 8.1.2-r0 apk catatonit 0.2.1-r0 apk
dasprid/enum 1.0.4 php-composer composer 2.9.5 binary
dbus-libs 1.14.8-r0 apk coreutils 9.8-r1 apk
dflydev/dot-access-data v3.0.2 php-composer coreutils-env 9.8-r1 apk
doctrine/cache 2.2.0 php-composer coreutils-fmt 9.8-r1 apk
doctrine/dbal 3.6.4 php-composer coreutils-sha512sum 9.8-r1 apk
doctrine/deprecations v1.1.1 php-composer curl 8.17.0-r1 apk
doctrine/event-manager 1.2.0 php-composer dasprid/enum 1.0.7 php-composer
doctrine/inflector 2.0.8 php-composer dbus-libs 1.16.2-r1 apk
doctrine/instantiator 1.5.0 php-composer dflydev/dot-access-data v3.0.3 php-composer
doctrine/lexer 2.1.0 php-composer doctrine/inflector 2.1.0 php-composer
dompdf/dompdf v2.0.3 php-composer doctrine/lexer 3.0.1 php-composer
dragonmantank/cron-expression v3.3.2 php-composer dompdf/dompdf v3.1.4 php-composer
egulias/email-validator 3.2.6 php-composer dompdf/php-font-lib 1.0.2 php-composer
encodings 1.0.7-r1 apk dompdf/php-svg-lib 1.0.2 php-composer
fakerphp/faker v1.23.0 php-composer dragonmantank/cron-expression v3.6.0 php-composer
filp/whoops 2.15.2 php-composer egulias/email-validator 4.0.4 php-composer
font-freefont 20120503-r4 apk encodings 1.1.0-r0 apk
fontconfig 2.14.2-r3 apk ezyang/htmlpurifier v4.19.0 php-composer
freetype 2.13.0-r5 apk fakerphp/faker v1.24.1 php-composer
fruitcake/php-cors v1.2.0 php-composer filp/whoops 2.18.4 php-composer
gdbm 1.23-r1 apk findutils 4.10.0-r0 apk
git 2.40.1-r0 apk firebase/php-jwt v7.0.2 php-composer
git-perl 2.40.1-r0 apk font-freefont 20120503-r4 apk
glib 2.76.3-r0 apk fontconfig 2.17.1-r0 apk
graham-campbell/result-type v1.1.1 php-composer freetype 2.14.1-r0 apk
guzzlehttp/guzzle 7.7.0 php-composer fruitcake/php-cors v1.4.0 php-composer
guzzlehttp/promises 1.5.3 php-composer gdbm 1.26-r0 apk
guzzlehttp/psr7 2.5.0 php-composer git 2.52.0-r0 apk
guzzlehttp/uri-template v1.0.1 php-composer git-init-template 2.52.0-r0 apk
hamcrest/hamcrest-php v2.0.1 php-composer glib 2.86.3-r0 apk
icu-data-full 73.2-r1 apk graham-campbell/result-type v1.1.4 php-composer
icu-libs 73.2-r1 apk guzzlehttp/guzzle 7.10.0 php-composer
intervention/image 2.7.2 php-composer guzzlehttp/promises 2.3.0 php-composer
itsgoingd/clockwork v5.1.12 php-composer guzzlehttp/psr7 2.8.0 php-composer
jq 1.6-r3 apk guzzlehttp/uri-template v1.0.5 php-composer
knplabs/knp-snappy v1.4.2 php-composer hamcrest/hamcrest-php v2.1.1 php-composer
laravel/framework v9.52.9 php-composer iamcal/sql-parser v0.7 php-composer
laravel/serializable-closure v1.3.0 php-composer icu-data-full 76.1-r1 apk
laravel/socialite v5.6.3 php-composer icu-libs 76.1-r1 apk
laravel/tinker v2.8.1 php-composer intervention/gif 4.2.4 php-composer
league/commonmark 2.4.0 php-composer intervention/image 3.11.6 php-composer
league/config v1.2.0 php-composer itsgoingd/clockwork v5.3.5 php-composer
league/flysystem 3.15.1 php-composer jq 1.8.1-r0 apk
league/flysystem-aws-s3-v3 3.15.0 php-composer knplabs/knp-snappy v1.6.0 php-composer
league/flysystem-local 3.15.0 php-composer larastan/larastan v3.9.2 php-composer
league/html-to-markdown 5.1.0 php-composer laravel/framework v12.52.0 php-composer
league/mime-type-detection 1.11.0 php-composer laravel/prompts v0.3.13 php-composer
league/oauth1-client v1.10.1 php-composer laravel/serializable-closure v2.0.9 php-composer
league/oauth2-client 2.7.0 php-composer laravel/socialite v5.24.2 php-composer
libacl 2.3.1-r3 apk laravel/tinker v2.11.1 php-composer
libattr 2.5.1-r4 apk league/commonmark 2.8.0 php-composer
libavif 0.11.1-r2 apk league/config v1.2.0 php-composer
libblkid 2.38.1-r8 apk league/flysystem 3.31.0 php-composer
libbsd 0.11.7-r1 apk league/flysystem-aws-s3-v3 3.31.0 php-composer
libbz2 1.0.8-r5 apk league/flysystem-local 3.31.0 php-composer
libc-utils 0.7.2-r5 apk league/html-to-markdown 5.1.1 php-composer
libcrypto3 3.1.1-r1 apk league/mime-type-detection 1.16.0 php-composer
libcurl 8.1.2-r0 apk league/oauth1-client v1.11.0 php-composer
libdav1d 1.2.1-r0 apk league/oauth2-client 2.9.0 php-composer
libedit 20221030.3.1-r1 apk league/uri 7.8.0 php-composer
libevent 2.1.12-r6 apk league/uri-interfaces 7.8.0 php-composer
libexpat 2.5.0-r1 apk libapk 3.0.4-r0 apk
libffi 3.4.4-r2 apk libattr 2.5.2-r2 apk
libfontenc 1.1.7-r2 apk libavif 1.3.0-r0 apk
libgcc 12.2.1_git20220924-r10 apk libblkid 2.41.2-r0 apk
libice 1.1.1-r2 apk libbsd 0.12.2-r0 apk
libidn2 2.3.4-r1 apk libbz2 1.0.8-r6 apk
libintl 0.21.1-r7 apk libcrypto3 3.5.5-r0 apk
libjpeg-turbo 2.1.5.1-r3 apk libcurl 8.17.0-r1 apk
libldap 2.6.4-r3 apk libdav1d 1.5.2-r0 apk
libmd 1.0.4-r2 apk libeconf 0.8.3-r0 apk
libmemcached-libs 1.1.4-r1 apk libedit 20251016.3.1-r0 apk
libmount 2.38.1-r8 apk libevent 2.1.12-r8 apk
libncursesw 6.4_p20230506-r0 apk libexpat 2.7.4-r0 apk
libpcre2-16 10.42-r1 apk libffi 3.5.2-r0 apk
libpng 1.6.39-r3 apk libfontenc 1.1.8-r0 apk
libproc2 4.0.3-r1 apk libgcc 15.2.0-r2 apk
libsasl 2.1.28-r4 apk libice 1.1.2-r0 apk
libseccomp 2.5.4-r2 apk libidn2 2.3.8-r0 apk
libsm 1.2.4-r1 apk libintl 0.24.1-r1 apk
libssl3 3.1.1-r1 apk libjpeg-turbo 3.1.2-r0 apk
libstdc++ 12.2.1_git20220924-r10 apk libldap 2.6.10-r0 apk
libunistring 1.1-r1 apk libmd 1.1.0-r0 apk
libuuid 2.38.1-r8 apk libmemcached-libs 1.1.4-r1 apk
libwebp 1.3.1-r0 apk libmount 2.41.2-r0 apk
libx11 1.8.4-r4 apk libncursesw 6.5_p20251123-r0 apk
libxau 1.0.11-r2 apk libpcre2-16 10.47-r0 apk
libxcb 1.15-r1 apk libpng 1.6.54-r0 apk
libxdmcp 1.1.4-r2 apk libproc2 4.0.5-r0 apk
libxext 1.3.5-r2 apk libpsl 0.21.5-r3 apk
libxml2 2.11.4-r0 apk libsasl 2.1.28-r9 apk
libxpm 3.5.16-r1 apk libseccomp 2.6.0-r1 apk
libxt 1.3.0-r2 apk libsharpyuv 1.6.0-r0 apk
libzip 1.9.2-r2 apk libsm 1.2.6-r0 apk
linux-pam 1.5.2-r10 apk libssl3 3.5.5-r0 apk
logrotate 3.21.0-r1 apk libstdc++ 15.2.0-r2 apk
mariadb-client 10.11.4-r0 apk libunistring 1.4.1-r0 apk
mariadb-common 10.11.4-r0 apk libuuid 2.41.2-r0 apk
masterminds/html5 2.8.0 php-composer libwebp 1.6.0-r0 apk
memcached 1.6.21 binary libx11 1.8.12-r1 apk
memcached 1.6.21-r0 apk libxau 1.0.12-r0 apk
mkfontscale 1.2.2-r3 apk libxcb 1.17.0-r1 apk
mockery/mockery 1.6.2 php-composer libxdmcp 1.1.5-r1 apk
monolog/monolog 2.9.1 php-composer libxext 1.3.6-r2 apk
mtdowling/jmespath.php 2.6.1 php-composer libxml2 2.13.9-r0 apk
musl 1.2.4-r0 apk libxpm 3.5.17-r0 apk
musl-utils 1.2.4-r0 apk libxt 1.3.1-r0 apk
myclabs/deep-copy 1.11.1 php-composer libyuv 0.0.1887.20251502-r1 apk
nano 7.2-r1 apk libzip 1.11.4-r1 apk
ncurses-terminfo-base 6.4_p20230506-r0 apk linux-pam 1.7.1-r2 apk
nesbot/carbon 2.67.0 php-composer logrotate 3.22.0-r0 apk
netcat-openbsd 1.219-r1 apk mariadb-client 11.4.9-r0 apk
nette/schema v1.2.3 php-composer mariadb-common 11.4.9-r0 apk
nette/utils v4.0.0 php-composer masterminds/html5 2.10.0 php-composer
nghttp2-libs 1.53.0-r0 apk memcached 1.6.39-r0 apk
nginx 1.24.0-r6 apk mkfontscale 1.2.3-r1 apk
nikic/php-parser v4.15.5 php-composer mockery/mockery 1.6.12 php-composer
nunomaduro/collision v6.4.0 php-composer monolog/monolog 3.10.0 php-composer
nunomaduro/larastan v2.6.3 php-composer mtdowling/jmespath.php 2.8.0 php-composer
nunomaduro/termwind v1.15.1 php-composer musl 1.2.5-r21 apk
onelogin/php-saml 4.1.0 php-composer musl-utils 1.2.5-r21 apk
oniguruma 6.9.8-r1 apk myclabs/deep-copy 1.13.4 php-composer
openssl 3.1.1-r1 apk nano 8.7-r0 apk
paragonie/constant_time_encoding v2.6.3 php-composer ncurses-terminfo-base 6.5_p20251123-r0 apk
paragonie/random_compat v9.99.100 php-composer nesbot/carbon 3.11.1 php-composer
pcre 8.45-r3 apk netcat-openbsd 1.234.1-r0 apk
pcre2 10.42-r1 apk nette/schema v1.3.4 php-composer
perl 5.36.1-r2 apk nette/utils v4.1.3 php-composer
perl-error 0.17029-r1 apk nghttp2-libs 1.68.0-r0 apk
perl-git 2.40.1-r0 apk nghttp3 1.13.1-r0 apk
phar-io/manifest 2.0.3 php-composer nginx 1.28.2-r0 apk
phar-io/version 3.2.1 php-composer nikic/php-parser v5.7.0 php-composer
phenx/php-font-lib 0.5.4 php-composer nunomaduro/collision v8.9.1 php-composer
phenx/php-svg-lib 0.5.0 php-composer nunomaduro/termwind v2.4.0 php-composer
php-cli 8.2.7 binary onelogin/php-saml 4.3.1 php-composer
php-fpm 8.2.7 binary oniguruma 6.9.10-r0 apk
php82 8.2.7-r0 apk openssl 3.5.5-r0 apk
php82-common 8.2.7-r0 apk paragonie/constant_time_encoding v3.1.3 php-composer
php82-ctype 8.2.7-r0 apk paragonie/random_compat v9.99.100 php-composer
php82-curl 8.2.7-r0 apk pcre2 10.47-r0 apk
php82-dom 8.2.7-r0 apk phar-io/manifest 2.0.4 php-composer
php82-fileinfo 8.2.7-r0 apk phar-io/version 3.2.1 php-composer
php82-fpm 8.2.7-r0 apk php85 8.5.2-r0 apk
php82-gd 8.2.7-r0 apk php85-common 8.5.2-r0 apk
php82-iconv 8.2.7-r0 apk php85-ctype 8.5.2-r0 apk
php82-ldap 8.2.7-r0 apk php85-curl 8.5.2-r0 apk
php82-mbstring 8.2.7-r0 apk php85-dom 8.5.2-r0 apk
php82-mysqlnd 8.2.7-r0 apk php85-exif 8.5.2-r0 apk
php82-openssl 8.2.7-r0 apk php85-fileinfo 8.5.2-r0 apk
php82-pdo 8.2.7-r0 apk php85-fpm 8.5.2-r0 apk
php82-pdo_mysql 8.2.7-r0 apk php85-gd 8.5.2-r0 apk
php82-pecl-igbinary 3.2.14-r0 apk php85-iconv 8.5.2-r0 apk
php82-pecl-memcached 3.2.0-r1 apk php85-ldap 8.5.2-r0 apk
php82-pecl-msgpack 2.2.0-r0 apk php85-mbstring 8.5.2-r0 apk
php82-phar 8.2.7-r0 apk php85-mysqlnd 8.5.2-r0 apk
php82-session 8.2.7-r0 apk php85-openssl 8.5.2-r0 apk
php82-simplexml 8.2.7-r0 apk php85-pdo 8.5.2-r0 apk
php82-sockets 8.2.7-r0 apk php85-pdo_mysql 8.5.2-r0 apk
php82-tokenizer 8.2.7-r0 apk php85-pecl-igbinary 3.2.17_rc1-r0 apk
php82-xml 8.2.7-r0 apk php85-pecl-memcached 3.4.0-r0 apk
php82-xmlwriter 8.2.7-r0 apk php85-pecl-msgpack 3.0.0-r0 apk
php82-zip 8.2.7-r0 apk php85-phar 8.5.2-r0 apk
phpmyadmin/sql-parser 5.8.0 php-composer php85-session 8.5.2-r0 apk
phpoption/phpoption 1.9.1 php-composer php85-simplexml 8.5.2-r0 apk
phpseclib/phpseclib 3.0.20 php-composer php85-sockets 8.5.2-r0 apk
phpstan/phpstan 1.10.21 php-composer php85-tokenizer 8.5.2-r0 apk
phpunit/php-code-coverage 9.2.26 php-composer php85-xml 8.5.2-r0 apk
phpunit/php-file-iterator 3.0.6 php-composer php85-xmlwriter 8.5.2-r0 apk
phpunit/php-invoker 3.1.1 php-composer php85-zip 8.5.2-r0 apk
phpunit/php-text-template 2.0.4 php-composer phpoption/phpoption 1.9.5 php-composer
phpunit/php-timer 5.0.3 php-composer phpseclib/phpseclib 3.0.49 php-composer
phpunit/phpunit 9.6.9 php-composer phpstan/phpstan 2.1.39 php-composer
popt 1.19-r2 apk phpunit/php-code-coverage 11.0.12 php-composer
pragmarx/google2fa v8.0.1 php-composer phpunit/php-file-iterator 5.1.1 php-composer
predis/predis v2.2.0 php-composer phpunit/php-invoker 5.0.1 php-composer
procps-ng 4.0.3-r1 apk phpunit/php-text-template 4.0.1 php-composer
psr/cache 3.0.0 php-composer phpunit/php-timer 7.0.1 php-composer
psr/container 2.0.2 php-composer phpunit/phpunit 11.5.55 php-composer
psr/event-dispatcher 1.0.0 php-composer popt 1.19-r4 apk
psr/http-client 1.0.2 php-composer pragmarx/google2fa v9.0.0 php-composer
psr/http-factory 1.0.2 php-composer predis/predis v3.4.0 php-composer
psr/http-message 2.0 php-composer procps-ng 4.0.5-r0 apk
psr/log 3.0.0 php-composer psr/clock 1.0.0 php-composer
psr/simple-cache 3.0.0 php-composer psr/container 2.0.2 php-composer
psy/psysh v0.11.18 php-composer psr/event-dispatcher 1.0.0 php-composer
qt5-qtbase 5.15.9_git20230505-r0 apk psr/http-client 1.0.3 php-composer
ralouphie/getallheaders 3.0.3 php-composer psr/http-factory 1.1.0 php-composer
ramsey/collection 1.3.0 php-composer psr/http-message 2.0 php-composer
ramsey/uuid 4.7.4 php-composer psr/log 3.0.2 php-composer
readline 8.2.1-r1 apk psr/simple-cache 3.0.0 php-composer
robrichards/xmlseclibs 3.1.1 php-composer psy/psysh v0.12.20 php-composer
sabberworm/php-css-parser 8.4.0 php-composer qt5-qtbase 5.15.10_git20230714-r4 apk
scanelf 1.3.7-r1 apk ralouphie/getallheaders 3.0.3 php-composer
sebastian/cli-parser 1.0.1 php-composer ramsey/collection 2.1.1 php-composer
sebastian/code-unit 1.0.8 php-composer ramsey/uuid 4.9.2 php-composer
sebastian/code-unit-reverse-lookup 2.0.3 php-composer readline 8.3.1-r0 apk
sebastian/comparator 4.0.8 php-composer robrichards/xmlseclibs 3.1.4 php-composer
sebastian/complexity 2.0.2 php-composer sabberworm/php-css-parser v9.1.0 php-composer
sebastian/diff 4.0.5 php-composer scanelf 1.3.8-r2 apk
sebastian/environment 5.1.5 php-composer sebastian/cli-parser 3.0.2 php-composer
sebastian/exporter 4.0.5 php-composer sebastian/code-unit 3.0.3 php-composer
sebastian/global-state 5.0.5 php-composer sebastian/code-unit-reverse-lookup 4.0.1 php-composer
sebastian/lines-of-code 1.0.3 php-composer sebastian/comparator 6.3.3 php-composer
sebastian/object-enumerator 4.0.4 php-composer sebastian/complexity 4.0.1 php-composer
sebastian/object-reflector 2.0.4 php-composer sebastian/diff 6.0.2 php-composer
sebastian/recursion-context 4.0.5 php-composer sebastian/environment 7.2.1 php-composer
sebastian/resource-operations 3.0.3 php-composer sebastian/exporter 6.3.2 php-composer
sebastian/type 3.2.1 php-composer sebastian/global-state 7.0.2 php-composer
sebastian/version 3.0.2 php-composer sebastian/lines-of-code 3.0.1 php-composer
shadow 4.13-r4 apk sebastian/object-enumerator 6.0.1 php-composer
skalibs 2.13.1.1-r1 apk sebastian/object-reflector 4.0.1 php-composer
socialiteproviders/discord 4.1.2 php-composer sebastian/recursion-context 6.0.3 php-composer
socialiteproviders/gitlab 4.1.0 php-composer sebastian/type 5.1.3 php-composer
socialiteproviders/manager v4.3.0 php-composer sebastian/version 5.0.2 php-composer
socialiteproviders/microsoft-azure 5.1.0 php-composer shadow 4.18.0-r0 apk
socialiteproviders/okta 4.2.1 php-composer skalibs-libs 2.14.4.0-r0 apk
socialiteproviders/slack 4.1.1 php-composer socialiteproviders/discord 4.2.0 php-composer
socialiteproviders/twitch 5.3.1 php-composer socialiteproviders/gitlab 4.1.0 php-composer
squizlabs/php_codesniffer 3.7.2 php-composer socialiteproviders/manager v4.8.1 php-composer
ssddanbrown/asserthtml v2.0.0 php-composer socialiteproviders/microsoft-azure 5.2.0 php-composer
ssddanbrown/htmldiff v1.0.2 php-composer socialiteproviders/okta 4.5.0 php-composer
ssl_client 1.36.1-r0 apk socialiteproviders/twitch 5.4.0 php-composer
symfony/console v6.0.19 php-composer squizlabs/php_codesniffer 4.0.1 php-composer
symfony/css-selector v6.0.19 php-composer ssddanbrown/asserthtml v3.1.0 php-composer
symfony/deprecation-contracts v3.0.2 php-composer ssddanbrown/htmldiff v2.0.0 php-composer
symfony/dom-crawler v6.0.19 php-composer ssl_client 1.37.0-r30 apk
symfony/error-handler v6.0.19 php-composer staabm/side-effects-detector 1.0.5 php-composer
symfony/event-dispatcher v6.0.19 php-composer symfony/clock v7.4.0 php-composer
symfony/event-dispatcher-contracts v3.0.2 php-composer symfony/console v7.4.4 php-composer
symfony/finder v6.0.19 php-composer symfony/css-selector v7.4.0 php-composer
symfony/http-foundation v6.0.20 php-composer symfony/deprecation-contracts v3.6.0 php-composer
symfony/http-kernel v6.0.20 php-composer symfony/dom-crawler v7.4.4 php-composer
symfony/mailer v6.0.19 php-composer symfony/error-handler v7.4.4 php-composer
symfony/mime v6.0.19 php-composer symfony/event-dispatcher v7.4.4 php-composer
symfony/polyfill-ctype v1.27.0 php-composer symfony/event-dispatcher-contracts v3.6.0 php-composer
symfony/polyfill-intl-grapheme v1.27.0 php-composer symfony/filesystem v7.4.0 php-composer
symfony/polyfill-intl-idn v1.27.0 php-composer symfony/finder v7.4.5 php-composer
symfony/polyfill-intl-normalizer v1.27.0 php-composer symfony/http-foundation v7.4.5 php-composer
symfony/polyfill-mbstring v1.27.0 php-composer symfony/http-kernel v7.4.5 php-composer
symfony/polyfill-php72 v1.27.0 php-composer symfony/mailer v7.4.4 php-composer
symfony/polyfill-php80 v1.27.0 php-composer symfony/mime v7.4.5 php-composer
symfony/polyfill-php81 v1.27.0 php-composer symfony/polyfill-ctype v1.33.0 php-composer
symfony/polyfill-uuid v1.27.0 php-composer symfony/polyfill-intl-grapheme v1.33.0 php-composer
symfony/process v6.0.19 php-composer symfony/polyfill-intl-idn v1.33.0 php-composer
symfony/routing v6.0.19 php-composer symfony/polyfill-intl-normalizer v1.33.0 php-composer
symfony/service-contracts v3.0.2 php-composer symfony/polyfill-mbstring v1.33.0 php-composer
symfony/string v6.0.19 php-composer symfony/polyfill-php80 v1.33.0 php-composer
symfony/translation v6.0.19 php-composer symfony/polyfill-php83 v1.33.0 php-composer
symfony/translation-contracts v3.0.2 php-composer symfony/polyfill-php84 v1.33.0 php-composer
symfony/uid v6.0.19 php-composer symfony/polyfill-php85 v1.33.0 php-composer
symfony/var-dumper v6.0.19 php-composer symfony/polyfill-uuid v1.33.0 php-composer
theseer/tokenizer 1.2.1 php-composer symfony/process v7.4.5 php-composer
tijsverkoyen/css-to-inline-styles 2.2.6 php-composer symfony/routing v7.4.4 php-composer
tzdata 2023c-r1 apk symfony/service-contracts v3.6.1 php-composer
utmps-libs 0.1.2.1-r1 apk symfony/string v7.4.4 php-composer
vlucas/phpdotenv v5.5.0 php-composer symfony/translation v7.4.4 php-composer
voku/portable-ascii 2.0.1 php-composer symfony/translation-contracts v3.6.1 php-composer
webmozart/assert 1.11.0 php-composer symfony/uid v7.4.4 php-composer
xz-libs 5.4.3-r0 apk symfony/var-dumper v7.4.4 php-composer
zlib 1.2.13-r1 apk thecodingmachine/safe v3.4.0 php-composer
zstd-libs 1.5.5-r4 apk theseer/tokenizer 1.3.1 php-composer
tijsverkoyen/css-to-inline-styles v2.4.0 php-composer
tzdata 2025c-r0 apk
utmps-libs 0.1.3.1-r0 apk
vlucas/phpdotenv v5.6.3 php-composer
voku/portable-ascii 2.0.3 php-composer
xemlock/htmlpurifier-html5 v0.1.12 php-composer
xz-libs 5.8.2-r0 apk
zlib 1.3.1-r2 apk
zstd-libs 1.5.7-r2 apk

View File

@ -3,144 +3,173 @@
# project information # project information
project_name: bookstack project_name: bookstack
project_url: "https://github.com/BookStackApp/BookStack" project_url: "https://github.com/BookStackApp/BookStack"
project_logo: "https://s3-us-west-2.amazonaws.com/linuxserver-docs/images/bookstack-logo500x500.png" project_logo: "https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/bookstack-logo.png"
project_lsio_github_repo_url: "https://github.com/linuxserver/docker-{{ project_name }}" project_lsio_github_repo_url: "https://github.com/linuxserver/docker-{{ project_name }}"
project_categories: "Content Management"
project_blurb: | project_blurb: |
[{{ 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. [{{ 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.
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. 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 For more information on BookStack visit their website and check it out: https://www.bookstackapp.com
# supported architectures # supported architectures
available_architectures: available_architectures:
- { arch: "{{ arch_x86_64 }}", tag: "amd64-latest"} - {arch: "{{ arch_x86_64 }}", tag: "amd64-latest"}
- { arch: "{{ arch_arm64 }}", tag: "arm64v8-latest"} - {arch: "{{ arch_arm64 }}", tag: "arm64v8-latest"}
# container parameters # container parameters
param_container_name: "{{ project_name }}" param_container_name: "{{ project_name }}"
param_usage_include_vols: true param_usage_include_vols: true
param_volumes: param_volumes:
- { vol_path: "/config", vol_host_path: "/path/to/data", desc: "this will store any uploaded data on the docker host" } - {vol_path: "/config", vol_host_path: "/path/to/{{ project_name }}/config", desc: "Persistent config files"}
param_usage_include_env: true param_usage_include_env: true
param_env_vars: param_env_vars:
- { env_var: "TZ", env_value: "Europe/London", desc: "Specify a timezone to use EG Europe/London"} - {env_var: "APP_URL", env_value: "", desc: "The protocol, IP/URL, and port that your application will be accessed on (ie. `http://192.168.1.1:6875` or `https://bookstack.mydomain.com`"}
- { 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`"} - {env_var: "APP_KEY", env_value: "", desc: "Session encryption key. You will need to generate this with `docker run -it --rm --entrypoint /bin/bash lscr.io/linuxserver/bookstack:latest appkey`"}
- { env_var: "DB_HOST", env_value: "<yourdbhost>", desc: "for specifying the database host" } - {env_var: "DB_HOST", env_value: "", desc: "The database instance hostname"}
- { env_var: "DB_PORT", env_value: "<yourdbport>", desc: "for specifying the database port if not default 3306" } - {env_var: "DB_PORT", env_value: "3306", desc: "Database port"}
- { env_var: "DB_USER", env_value: "<yourdbuser>", desc: "for specifying the database user" } - {env_var: "DB_USERNAME", env_value: "", desc: "Database user"}
- { env_var: "DB_PASS", env_value: "<yourdbpass>", desc: "for specifying the database password (non-alphanumeric passwords must be properly escaped.)" } - {env_var: "DB_PASSWORD", env_value: "", desc: "Database password (minimum 4 characters & non-alphanumeric passwords must be properly escaped.)"}
- { env_var: "DB_DATABASE", env_value: "bookstackapp", desc: "for specifying the database to be used" } - {env_var: "DB_DATABASE", env_value: "", desc: "Database name"}
param_usage_include_ports: true param_usage_include_ports: true
param_ports: param_ports:
- { external_port: "6875", internal_port: "80", port_desc: "will map the container's port 80 to port 6875 on the host" } - {external_port: "6875", internal_port: "80", port_desc: "http/s web interface."}
opt_param_usage_include_env: true
opt_param_usage_include_env: false
opt_param_env_vars: opt_param_env_vars:
- {env_var: "QUEUE_CONNECTION", env_value: "", desc: "Set to `database` to enable async actions like sending email or triggering webhooks. See [documentation](https://www.bookstackapp.com/docs/admin/email-webhooks/#async-action-handling)."}
custom_compose: | readonly_supported: true
--- readonly_message: |
version: "2" * `/tmp` must be mounted to tmpfs
services:
bookstack:
image: lscr.io/linuxserver/bookstack
container_name: bookstack
environment:
- PUID=1000
- PGID=1000
- APP_URL=https://bookstack.example.com
- DB_HOST=bookstack_db
- DB_PORT=3306
- DB_USER=bookstack
- DB_PASS=<yourdbpass>
- DB_DATABASE=bookstackapp
volumes:
- ./bookstack_app_data:/config
ports:
- 6875:80
restart: unless-stopped
depends_on:
- bookstack_db
bookstack_db:
image: lscr.io/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:
- ./bookstack_db_data:/config
restart: unless-stopped
# application setup block # application setup block
app_setup_block_enabled: true app_setup_block_enabled: true
app_setup_block: | app_setup_block: |
The default username is admin@admin.com with the password of **password**, access the container at http://<host ip>:6875.
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 MariaDB database, be it one you already have or a new one. If you do not already have one, we provide an image here https://github.com/linuxserver/docker-mariadb.
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 SWAG container or Traefik you will need to make sure that the `APP_URL` environment variable is set to your external domain, or it will not work. If you intend to use this application behind a subfolder reverse proxy, such as our SWAG container or Traefik you will need to make sure that the `APP_URL` environment variable is set to your external domain, or it will not work.
Documentation for BookStack can be found at https://www.bookstackapp.com/docs/. Documentation for BookStack can be found at https://www.bookstackapp.com/docs/.
### BookStack File & Directory Paths ### BookStack File & Directory Paths
This container ensures certain BookStack application files & folders, such as user file upload folders, are retained within the `/config` folder so that they are persistent & accessible when the `/config` container path is bound as a volume. There may be cases, when following the BookStack documentation, that you'll need to know how these files and folders are used relative to a non-container BookStack installation. This container ensures certain BookStack application files & folders, such as user file upload folders, are retained within the `/config` folder so that they are persistent & accessible when the `/config` container path is bound as a volume. There may be cases, when following the BookStack documentation, that you'll need to know how these files and folders are used relative to a non-container BookStack installation.
Below is a mapping of container `/config` paths to those relative within a BookStack install directory: Below is a mapping of container `/config` paths to those relative within a BookStack install directory:
- **/config container path** => **BookStack relative path** - **/config container path** => **BookStack relative path**
- `/config/www/.env` => `.env` - `/config/www/.env` => `.env`
- `/config/www/laravel.log` => `storage/logs/laravel.log` - `/config/log/bookstack/laravel.log` => `storage/logs/laravel.log`
- `/config/www/backups/` => `storage/backups/` - `/config/backups/` => `storage/backups/`
- `/config/www/files/` => `storage/uploads/files/` - `/config/www/files/` => `storage/uploads/files/`
- `/config/www/images/` => `storage/uploads/images/` - `/config/www/images/` => `storage/uploads/images/`
- `/config/www/themes/` => `themes/` - `/config/www/themes/` => `themes/`
- `/config/www/uploads/` => `public/uploads/` - `/config/www/uploads/` => `public/uploads/`
### Changing APP_URL
If you change the APP_URL after initial install, you should run the following line from your host terminal to update the database URL entries:
```shell
docker exec -it bookstack php /app/www/artisan bookstack:update-url ${OLD_URL} ${NEW_URL}
```
### Advanced Users (full control over the .env file) ### 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. 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`.
If you wish to use the extra functionality of BookStack such as email, LDAP and so on you will need to set additional environment variables or make your own .env file with guidance from the BookStack documentation.
The container will copy an exemplary .env file to /config/www/.env on your host system for you to use.
# init diagram
init_diagram: |
"bookstack:latest": {
docker-mods
base {
fix-attr +\nlegacy cont-init
}
docker-mods -> base
legacy-services
custom services
init-services -> legacy-services
init-services -> custom services
custom services -> legacy-services
legacy-services -> ci-service-check
init-migrations -> init-adduser
init-nginx-end -> init-bookstack-config
init-nginx-end -> init-config
init-os-end -> init-config
init-bookstack-config -> init-config-end
init-config -> init-config-end
init-crontab-config -> init-config-end
init-config -> init-crontab-config
init-mods-end -> init-custom-files
init-adduser -> init-device-perms
base -> init-envfile
init-os-end -> init-folders
init-php -> init-keygen
base -> init-migrations
init-config-end -> init-mods
init-mods-package-install -> init-mods-end
init-mods -> init-mods-package-install
init-samples -> init-nginx
init-version-checks -> init-nginx-end
init-adduser -> init-os-end
init-device-perms -> init-os-end
init-envfile -> init-os-end
init-keygen -> init-permissions
init-nginx -> init-php
init-folders -> init-samples
init-custom-files -> init-services
init-permissions -> init-version-checks
init-services -> svc-cron
svc-cron -> legacy-services
init-services -> svc-memcached
svc-memcached -> legacy-services
init-services -> svc-nginx
svc-nginx -> legacy-services
init-services -> svc-php-fpm
svc-php-fpm -> legacy-services
init-services -> svc-queue-worker
svc-queue-worker -> legacy-services
}
Base Images: {
"baseimage-alpine-nginx:3.23" <- "baseimage-alpine:3.23"
}
"bookstack:latest" <- Base Images
# changelog # changelog
changelogs: changelogs:
- { date: "07.06.23:", desc: "Add mariadb-client for bookstack-system-cli support." } - {date: "28.12.25:", desc: "Rebase to Alpine 3.23."}
- { date: "25.05.23:", desc: "Rebase to Alpine 3.18, deprecate armhf." } - {date: "05.07.25:", desc: "Rebase to Alpine 3.22."}
- { date: "13.04.23:", desc: "Move ssl.conf include to default.conf." } - {date: "04.01.25:", desc: "Add php-opcache."}
- { date: "01.03.23:", desc: "Add php iconv." } - {date: "17.12.24:", desc: "Rebase to Alpine 3.21."}
- { date: "19.01.23:", desc: "Rebase to alpine 3.17 with php8.1." } - {date: "11.10.24:", desc: "Default to environment config over .env file config."}
- { date: "16.01.23:", desc: "Wrap `.env` values in quotes." } - {date: "06.09.24:", desc: "Add php-exif for reading image EXIF data."}
- { date: "05.01.23:", desc: "Fix db password setting (sed escape `&`)." } - {date: "27.05.24:", desc: "Rebase to Alpine 3.20. Existing users should update their nginx confs to avoid http2 deprecation warnings."}
- { date: "21.12.22:", desc: "Update db info in .env file when env vars are updated." } - {date: "25.01.24:", desc: "Existing users should update: site-confs/default.conf - Cleanup default site conf."}
- { date: "10.10.22:", desc: "Remove password escape logic which caused problems for a small subset of users." } - {date: "23.12.23:", desc: "Rebase to Alpine 3.19 with php 8.3."}
- { date: "20.08.22:", desc: "Rebasing to alpine 3.15 with php8. Restructure nginx configs ([see changes announcement](https://info.linuxserver.io/issues/2022-08-20-nginx-base))." } - {date: "31.10.23:", desc: "Further sanitize sed replace."}
- { date: "14.03.22:", desc: "Add symlinks for theme support." } - {date: "07.06.23:", desc: "Add mariadb-client for bookstack-system-cli support."}
- { date: "11.07.21:", desc: "Rebase to Alpine 3.14." } - {date: "25.05.23:", desc: "Rebase to Alpine 3.18, deprecate armhf."}
- { date: "12.01.21:", desc: "Remove unused requirement, as of release 0.31.0." } - {date: "13.04.23:", desc: "Move ssl.conf include to default.conf."}
- { date: "17.12.20:", desc: "Make APP_URL var required (upstream changes)." } - {date: "01.03.23:", desc: "Add php iconv."}
- { date: "17.09.20:", desc: "Rebase to alpine 3.12. Fix APP_URL setting. Bump php post max and upload max filesizes to 100MB by default." } - {date: "19.01.23:", desc: "Rebase to alpine 3.17 with php8.1."}
- { date: "19.12.19:", desc: "Rebasing to alpine 3.11." } - {date: "16.01.23:", desc: "Wrap `.env` values in quotes."}
- { date: "26.07.19:", desc: "Use old version of tidyhtml pending upstream fixes." } - {date: "05.01.23:", desc: "Fix db password setting (sed escape `&`)."}
- { date: "28.06.19:", desc: "Rebasing to alpine 3.10." } - {date: "21.12.22:", desc: "Update db info in .env file when env vars are updated."}
- { date: "14.06.19:", desc: "Add wkhtmltopdf to image for PDF rendering." } - {date: "10.10.22:", desc: "Remove password escape logic which caused problems for a small subset of users."}
- { date: "20.04.19:", desc: "Rebase to Alpine 3.9, add MySQL init logic." } - {date: "20.08.22:", desc: "Rebasing to alpine 3.15 with php8. Restructure nginx configs ([see changes announcement](https://info.linuxserver.io/issues/2022-08-20-nginx-base))."}
- { date: "22.03.19:", desc: "Switching to new Base images, shift to arm32v7 tag." } - {date: "14.03.22:", desc: "Add symlinks for theme support."}
- { date: "20.01.19:", desc: "Added php7-curl"} - {date: "11.07.21:", desc: "Rebase to Alpine 3.14."}
- { date: "04.11.18:", desc: "Added php7-ldap"} - {date: "12.01.21:", desc: "Remove unused requirement, as of release 0.31.0."}
- { date: "15.10.18:", desc: "Changed functionality for advanced users"} - {date: "17.12.20:", desc: "Make APP_URL var required (upstream changes)."}
- { date: "08.10.18:", desc: "Advanced mode, symlink changes, sed fixing, docs updated, added some composer files"} - {date: "17.09.20:", desc: "Rebase to alpine 3.12. Fix APP_URL setting. Bump php post max and upload max filesizes to 100MB by default."}
- { date: "23.09.28:", desc: "Updates pre-release"} - {date: "19.12.19:", desc: "Rebasing to alpine 3.11."}
- { date: "02.07.18:", desc: "Initial Release." } - {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."}

9
root/appkey Executable file
View File

@ -0,0 +1,9 @@
#!/bin/bash
mkdir -p \
/config/www/framework/{cache,sessions,views} \
/config/log/bookstack
touch /config/log/bookstack/laravel.log
php /app/www/artisan key:generate --show --no-ansi

View File

@ -1,36 +0,0 @@
## Version 2023/04/13 - Changelog: https://github.com/linuxserver/docker-bookstack/commits/master/root/defaults/nginx/site-confs/default.conf.sample
server {
listen 80 default_server;
listen [::]:80 default_server;
listen 443 ssl http2 default_server;
listen [::]:443 ssl http2 default_server;
server_name _;
include /config/nginx/ssl.conf;
root /app/www/public;
index index.html index.htm index.php;
location / {
# enable for basic auth
#auth_basic "Restricted";
#auth_basic_user_file /config/nginx/.htpasswd;
try_files $uri $uri/ /index.php$is_args$args;
}
location ~ ^(.+\.php)(.*)$ {
fastcgi_split_path_info ^(.+\.php)(.*)$;
fastcgi_pass 127.0.0.1:9000;
fastcgi_index index.php;
include /etc/nginx/fastcgi_params;
}
# deny access to .htaccess/.htpasswd files
location ~ /\.ht {
deny all;
}
}

View File

@ -3,110 +3,28 @@
# create directory structure # create directory structure
mkdir -p \ mkdir -p \
/config/www/{uploads,files,images,themes,backups} /config/www/{uploads,files,images,themes} \
/config/www/framework/{cache,sessions,views,purifier} \
/config/backups \
/config/log/bookstack
if [[ ! -f /tmp/dbwait.lock ]];then
rm -rf /config/www/framework/{cache,sessions,views,purifier}/*
fi
# check for .env and copy default if needed # check for .env and copy default if needed
if [[ ! -f "/config/www/.env" ]] || [[ ! -s "/config/www/.env" ]]; then if [[ ! -f "/config/www/.env" ]] || [[ ! -s "/config/www/.env" ]]; then
cp /app/www/.env.example /config/www/.env cp /app/www/.env.example /config/www/.env
fi fi
# create symlinks # Check for app key
symlinks=( if [[ -z ${APP_KEY} ]]; then
/app/www/themes if ! grep -qE "APP_KEY=[0-9A-Za-z:+\/=]{1,}" /config/www/.env 2> /dev/null || grep -qE "APP_KEY=SomeRandomString" /config/www/.env 2> /dev/null; then
/app/www/storage/backups echo "The application key is missing, halting init!"
/app/www/storage/uploads/files echo "You can generate a key with: docker run -it --rm --entrypoint /bin/bash lscr.io/linuxserver/bookstack:latest appkey"
/app/www/storage/uploads/images echo "And apply it to the APP_KEY environment variable."
/app/www/public/uploads
/app/www/.env
/app/www/storage/logs/laravel.log
)
for i in "${symlinks[@]}"; do
if [[ -e "${i}" && ! -L "${i}" ]]; then
rm -rf "${i}"
fi
if [[ ! -L "${i}" ]]; then
ln -s /config/www/"$(basename "${i}")" "${i}"
fi
done
# Echo init finish for test runs
if [ -n "${TEST_RUN}" ]; then
echo '[ls.io-init] done.'
fi
# Create API key if needed
if [ ! -f "/config/BOOKSTACK_APP_KEY.txt" ]; then
echo "Generating BookStack app key for first run"
key=$(php /app/www/artisan key:generate --show)
echo "${key}" >/config/BOOKSTACK_APP_KEY.txt
echo "App Key set to ${key} you can modify the file to update /config/BOOKSTACK_APP_KEY.txt"
elif [ -f "/config/BOOKSTACK_APP_KEY.txt" ]; then
echo "App Key found - setting variable for seds"
key=$(cat /config/BOOKSTACK_APP_KEY.txt)
fi
# .env file setup
# check for the default app key or if it has been updated
if ! grep -Fxq "APP_KEY=${key}" /config/www/.env; then
sed -i "s#^APP_KEY=.*#APP_KEY=${key}#" /config/www/.env
fi
# if DB_HOST contains a port and DB_HOST is not a IPv6 without brackets [..]
# support ipv4:port, [ipv6]:port, and domain:port
if [[ ${DB_HOST} =~ :[0-9]+$ ]] && ! [[ ${DB_HOST} =~ ^(:{0,2}[a-fA-F0-9]{1,4})+$ ]]; then
DB_HOST_PORT="${DB_HOST}"
fi
# if DB_HOST_PORT is set
if [[ -n "${DB_HOST_PORT}" ]]; then
# if DB_PORT is set
if [[ -n "${DB_PORT}" ]]; then
echo "DB_PORT is not supported when using DB_HOST with port"
sleep infinity sleep infinity
fi fi
DB_HOST="${DB_HOST_PORT%:*}"
DB_PORT="${DB_HOST_PORT##*:}"
fi
# if DB_PORT is not set
if [[ -z "${DB_PORT}" ]]; then
DB_PORT="3306"
fi
# check to see if DB_HOST is set, if it is then run seds and if not then leave them
if [[ -n "${DB_HOST}" ]]; then
echo "Running config - DB_HOST set"
if ! grep -xqE "^[#]?DB_PORT=.*" /config/www/.env; then
# add DB_PORT line to /config/www/.env because current /app/www/.env.example doesn't have it
sed -i -E "/^[#]?DB_HOST=.*/a DB_PORT='${DB_PORT}'" /config/www/.env
echo "**** Insert DB_PORT='${DB_PORT}' into /config/www/.env ****"
fi
sed -i -E "s/^[#]?DB_HOST=.*/DB_HOST='${DB_HOST}'/g" /config/www/.env
sed -i -E "s/^[#]?DB_PORT=.*/DB_PORT='${DB_PORT}'/g" /config/www/.env
sed -i -E "s/^[#]?DB_DATABASE=.*/DB_DATABASE='${DB_DATABASE}'/g" /config/www/.env
sed -i -E "s/^[#]?DB_USERNAME=.*/DB_USERNAME='${DB_USER}'/g" /config/www/.env
sed -i -E "s/^[#]?DB_PASSWORD=.*/DB_PASSWORD='${DB_PASS//&/\\&}'/g" /config/www/.env
fi
# set appurl
if [ -z "${APP_URL}" ]; then
EXT_IP=$(curl -s https://icanhazip.com)
APP_URL="http://${EXT_IP}:6875"
echo "**** Docker env var APP_URL is not set, setting it to ${APP_URL} ****"
fi
OLD_URL=$(grep APP_URL /config/www/.env | sed 's|.*APP_URL=||g')
if [ "${APP_URL}" != "${OLD_URL}" ]; then
sed -r "s,([#\s]*)?APP_URL=.*,APP_URL=${APP_URL},g" -i /config/www/.env
echo "**** APP_URL in /config/www/.env is being updated from ${OLD_URL} to ${APP_URL} ****"
if [ "${OLD_URL}" != "http://example.com" ]; then
echo "**** If this is an existing install, you should run the following line from your host terminal to update the database URL entries: ****"
echo "************************************************************************"
echo "docker exec -it bookstack php /app/www/artisan bookstack:update-url ${OLD_URL} ${APP_URL}"
echo "************************************************************************"
fi
fi fi
## Bump php upload max filesize and post max size to 100MB by default ## Bump php upload max filesize and post max size to 100MB by default
@ -117,33 +35,29 @@ if ! grep -qx '^post_max_size.*$' /config/php/php-local.ini; then
echo 'post_max_size = 100M' >>/config/php/php-local.ini echo 'post_max_size = 100M' >>/config/php/php-local.ini
fi fi
# if DB_PORT is not set
if [[ -z "${DB_PORT}" ]]; then
DB_PORT="3306"
fi
# check for the mysql endpoint # check for the mysql endpoint
echo "Waiting for DB to be available" echo "Waiting for DB to be available"
END=$((SECONDS + 30)) END=$((SECONDS + 30))
while [[ ${SECONDS} -lt ${END} ]] && [[ -n "${DB_HOST+x}" ]]; do while [[ ${SECONDS} -lt ${END} ]] && [[ -n "${DB_HOST+x}" ]]; do
if [[ $(/usr/bin/nc -w1 "${DB_HOST}" "${DB_PORT}" | tr -d '\0') ]]; then if [[ $(/usr/bin/nc -w1 "${DB_HOST}" "${DB_PORT}" | tr -d '\0') ]]; then
if [[ -n "${RUN}" ]]; then if [[ ! -f /tmp/dbwait.lock ]]; then
break
fi
RUN="RAN"
# we sleep here again due to first run init on DB containers
if [[ ! -f /dbwait.lock ]]; then
sleep 5 sleep 5
fi fi
touch /tmp/dbwait.lock
break
else else
sleep 1 sleep 1
fi fi
done done
# update database - will set up database if fresh, or, migrate existing # update database - will set up database if fresh, or, migrate existing
if [ -z "${CI_RUN+x}" ]; then php /app/www/artisan migrate --force
php /app/www/artisan migrate --force
fi
# permissions # permissions
lsiown -R abc:abc \ lsiown -R abc:abc \
/app/www/storage \
/config /config
# set lockfile to avoid DB waits for this specific container
touch /dbwait.lock

View File

@ -0,0 +1,6 @@
#!/usr/bin/with-contenv bash
# shellcheck shell=bash
echo "*** Starting Async Action Queue ***"
exec /usr/bin/php /app/www/artisan queue:work --sleep=3 --tries=1 --max-time=3600

View File

@ -0,0 +1 @@
longrun

9
root/init-hook Executable file
View File

@ -0,0 +1,9 @@
#!/usr/bin/with-contenv bash
# shellcheck shell=bash
if [[ -n "${QUEUE_CONNECTION}" ]]; then
touch /etc/s6-overlay/s6-rc.d/user/contents.d/svc-queue-worker
fi
exec \
/docker-mods

2
root/migrations/02-default-location Normal file → Executable file
View File

@ -5,7 +5,7 @@ DEFAULT_CONF="/config/nginx/site-confs/default.conf"
OLD_ROOT="root /var/www/html/public;" OLD_ROOT="root /var/www/html/public;"
NEW_ROOT="root /app/www/public;" NEW_ROOT="root /app/www/public;"
if grep -q "${OLD_ROOT}" "${DEFAULT_CONF}"; then if [[ -f "${DEFAULT_CONF}" ]] && grep -q "${OLD_ROOT}" "${DEFAULT_CONF}" 2>/dev/null; then
echo "updating root in ${DEFAULT_CONF}" echo "updating root in ${DEFAULT_CONF}"
sed -i "s|${OLD_ROOT}|${NEW_ROOT}|" "${DEFAULT_CONF}" sed -i "s|${OLD_ROOT}|${NEW_ROOT}|" "${DEFAULT_CONF}"
fi fi