octo
/
BirdsiteLive
mirror of https://github.com/NicolasConstant/BirdsiteLive
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

better documentation

This commit is contained in:
Nicolas Constant 2021-01-19 23:06:35 -05:00
parent af2a496ee6
commit 9bc1a3923b
No known key found for this signature in database
GPG Key ID: 1E9F677FB01A5688
3 changed files with 17 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
INSTALLATION.md
View File

@ -151,3 +151,7 @@ docker-compose pull
# Start a new container, automatically removes old one # Start a new container, automatically removes old one
docker-compose up -d docker-compose up -d
``` ```
## More options
You can find more options available [here](https://github.com/NicolasConstant/BirdsiteLive/blob/master/VARIABLES.md)

2
README.md
View File

@ -16,7 +16,7 @@ You can find an official (and temporary) instance here: [beta.birdsite.live](htt
## Installation ## 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 ## License

12
VARIABLES.md Normal file
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.