Skip to content

Commit 92f542d

Browse files
committed
Add notes on breaking change
1 parent 3ba16c4 commit 92f542d

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

+10
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,16 @@
66

77
## Changes
88

9+
Versions higher than 23.6.1 no longer use an in-container `.env` file for
10+
environment variable management. Instead, the preferred approach is to manage
11+
them directly with the container runtime (e.g. Docker's `-e`). This is to
12+
simplify troubleshooting if and when errors occur. The most important change is
13+
that `${APP_KEY}` is no longer provided for you, instead it is up to the
14+
operator to ensure this value is present. Versions prior to this supplied
15+
`${APP_KEY}` (with a default of `SomeRandomStringWith32Characters`. A full
16+
reference of available environment variables is available in the [Bookstack
17+
repository](https://github.com/BookStackApp/BookStack/blob/development/.env.example.complete)
18+
919
The version 23.6.0 is broken due to a bad `.env` configuration created by the
1020
entrypoint script. This is fixed in version 23.6.1.
1121

0 commit comments

Comments
 (0)