Browse Source

better documentation

master
Nicolas Constant 11 months ago
parent
commit
9bc1a3923b
No known key found for this signature in database GPG Key ID: 1E9F677FB01A5688
3 changed files with 17 additions and 1 deletions
  1. +4
    -0
      INSTALLATION.md
  2. +1
    -1
      README.md
  3. +12
    -0
      VARIABLES.md

+ 4
- 0
INSTALLATION.md View File

@ -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)

+ 1
- 1
README.md View File

@ -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


+ 12
- 0
VARIABLES.md View File

@ -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.

Loading…
Cancel
Save