summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorFrederic Guillot <fred@kanboard.net>2016-02-28 12:14:37 -0500
committerFrederic Guillot <fred@kanboard.net>2016-02-28 12:14:37 -0500
commit85d4833ce5de9a54f5d928cf4c4a7a239e9b19d3 (patch)
tree87a47ac1b3c7fe8db51a39a160a574a4e0f70afd /doc
parent8d71bbb1228fcfb3da80010c94b747cc56f739e2 (diff)
Add some environment variables
Diffstat (limited to 'doc')
-rw-r--r--doc/docker.markdown12
-rw-r--r--doc/env.markdown11
-rw-r--r--doc/index.markdown1
3 files changed, 24 insertions, 0 deletions
diff --git a/doc/docker.markdown b/doc/docker.markdown
index 6bd966d3..3f13e954 100644
--- a/doc/docker.markdown
+++ b/doc/docker.markdown
@@ -69,6 +69,18 @@ You can attach 2 volumes to your container:
Use the flag `-v` to mount a volume on the host machine like described in [official Docker documentation](https://docs.docker.com/engine/userguide/containers/dockervolumes/).
+Upgrade your container
+----------------------
+
+- Pull the new image
+- Remove the old container
+- Restart a new container with the same volumes
+
+Environment variables
+---------------------
+
+The list of environment variables is available on [this page](env.markdown).
+
Config files
------------
diff --git a/doc/env.markdown b/doc/env.markdown
new file mode 100644
index 00000000..a01d0a6f
--- /dev/null
+++ b/doc/env.markdown
@@ -0,0 +1,11 @@
+Environment Variables
+=====================
+
+Environment variables maybe useful when Kanboard is deployed as container (Docker).
+
+| Variable | Description |
+|---------------|---------------------------------------------------------------------------------------------------------------------------------|
+| DATABASE_URL | `[database type]://[username]:[password]@[host]:[port]/[database name]`, example: `postgres://foo:foo@myserver:5432/kanboard` |
+| DEBUG | Enable/Disable debug mode |
+| DEBUG_FILE | Debug file location, `DEBUG_FILE=php://stderr` |
+| ENABLE_SYSLOG | Enable/Disable logging to Syslog: `ENABLE_SYSLOG=1` |
diff --git a/doc/index.markdown b/doc/index.markdown
index 99ca01f6..7a3ca8e5 100644
--- a/doc/index.markdown
+++ b/doc/index.markdown
@@ -105,6 +105,7 @@ Technical details
- [Daily background job](cronjob.markdown)
- [Config file](config.markdown)
+- [Environment variables](env.markdown)
- [Email configuration](email-configuration.markdown)
- [URL rewriting](nice-urls.markdown)