From 74ad51f0b69c59af4c5cbb48aaf65d0386a627f0 Mon Sep 17 00:00:00 2001 From: root Date: Thu, 25 Oct 2018 05:32:07 +0000 Subject: [PATCH] Bot Updating README from template --- README.md | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 001b82c..26e9ec5 100644 --- a/README.md +++ b/README.md @@ -63,7 +63,6 @@ docker create \ -e DB_PASS= \ -e DB_DATABASE=bookstackapp \ -e APPURL=your.site.here.xyz \ - -e ADVANCED_MODE=1 \ -p 6875:80 \ -v :/config \ linuxserver/bookstack @@ -89,7 +88,6 @@ services: - DB_PASS= - DB_DATABASE=bookstackapp - APPURL=your.site.here.xyz - - ADVANCED_MODE=1 volumes: - :/config ports: @@ -112,7 +110,6 @@ Container images are configured using parameters passed at runtime (such as thos | `-e DB_PASS=` | for specifying the database password | | `-e DB_DATABASE=bookstackapp` | for specifying the database to be used | | `-e APPURL=your.site.here.xyz` | for specifying the url your application will be accessed on | -| `-e ADVANCED_MODE=1` | enables advanced mode for direct editing of the .env - scroll down for details on this | | `-v /config` | this will store any uploaded data on the docker host | ## User / Group Identifiers @@ -155,12 +152,10 @@ If you intend to use this application behind a reverse proxy, such as our LetsEn Documentation can be found at https://www.bookstackapp.com/docs/ -### Advanced Mode -We have implemented a special 'advanced mode' where users who wish to leverage the built in SMTP or LDAP functionality, will have the ability to edit the .env by hand. With `ADVANCED_MODE=1` set when -the container is created, it will copy the .env.example to /config within the container. You can then edit this file on the host system (make sure you read the BookStack docs) and restart the -container when finished. When the container starts, it copies /config/.env to /var/www/html/.env within the container for the web app to use. It will do this every time the container restarts. +### Advanced Users +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. -Note, the APP_KEY is still set by PHP environment so you do not need to worrry about this. +When you create the container, do not set any arguements for SQL or APPURL. The container will copy an .env file to /config/www/.env on your host system for you to edit. ### Composer @@ -179,6 +174,7 @@ Some simple docker-compose files are included for you to get started with. You w ## Versions +* **15.10.18:** - Changed functionality for advanced users * **08.10.18:** - Advanced mode, symlink changes, sed fixing, docs updated, added some composer files * **23.09.28:** - Updates pre-release * **02.07.18:** - Initial Release.