From 9bc1a3923bfa6cfd2812bf68f8a3e8d27cdb4d31 Mon Sep 17 00:00:00 2001
From: Nicolas Constant <github@nicolas-constant.com>
Date: Tue, 19 Jan 2021 23:06:35 -0500
Subject: [PATCH] better documentation

---
 INSTALLATION.md |  4 ++++
 README.md       |  2 +-
 VARIABLES.md    | 12 ++++++++++++
 3 files changed, 17 insertions(+), 1 deletion(-)
 create mode 100644 VARIABLES.md

diff --git a/INSTALLATION.md b/INSTALLATION.md
index da4b7cc..17a60f7 100644
--- a/INSTALLATION.md
+++ b/INSTALLATION.md
@@ -151,3 +151,7 @@ docker-compose pull
 # Start a new container, automatically removes old one
 docker-compose up -d
 ```
+
+## More options 
+
+You can find more options available [here](https://github.com/NicolasConstant/BirdsiteLive/blob/master/VARIABLES.md)
\ No newline at end of file
diff --git a/README.md b/README.md
index 916a8a0..241316e 100644
--- a/README.md
+++ b/README.md
@@ -16,7 +16,7 @@ You can find an official (and temporary) instance here: [beta.birdsite.live](htt
 
 ## Installation
 
-I'm providing a [Docker build](https://hub.docker.com/r/nicolasconstant/birdsitelive), to install it on your own server, please follow [those instructions](https://github.com/NicolasConstant/BirdsiteLive/blob/master/INSTALLATION.md).
+I'm providing a [docker build](https://hub.docker.com/r/nicolasconstant/birdsitelive). To install it on your own server, please follow [those instructions](https://github.com/NicolasConstant/BirdsiteLive/blob/master/INSTALLATION.md). More [options](https://github.com/NicolasConstant/BirdsiteLive/blob/master/VARIABLES.md) are also available.
 
 ## License
 
diff --git a/VARIABLES.md b/VARIABLES.md
new file mode 100644
index 0000000..b68d4de
--- /dev/null
+++ b/VARIABLES.md
@@ -0,0 +1,12 @@
+# Environment variables
+
+You can configure some of BirdsiteLIVE's settings via environment variables (those are optionnals):
+
+## Logging
+
+* `Logging:Type` set the type of the logging and monitoring system, currently the only type supported is `insights` for *Azure Application Insights* (PR welcome to support other types)
+* `Logging:InstrumentationKey` the instrumentation key for Azure Application Insights
+
+## Instance customization 
+
+* `Instance:ResolveMentionsInProfiles` (default: true) to enable or disable mentions parsing in profile's description. Resolving it will consume more User's API calls since newly discovered account can also contain references to others accounts as well. On a big instance it is recommended to disable it.
\ No newline at end of file