From 4513ff0f52c070c200419323d25dcbb7844b0435 Mon Sep 17 00:00:00 2001 From: Arthi-chaud Date: Fri, 11 Feb 2022 11:33:52 +0100 Subject: [PATCH] Documentation: Setting-up: 'Using a container' documentation --- docs/setting_up/setting_up.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/docs/setting_up/setting_up.md b/docs/setting_up/setting_up.md index bac883e4..50cc3c44 100644 --- a/docs/setting_up/setting_up.md +++ b/docs/setting_up/setting_up.md @@ -73,4 +73,13 @@ We are going to take a look at the fields you might want to change to tailor Kyo - ```the-moviedb``` - ```apikey```: The API key that will be used to interact with TMDB's API. See [there](https://developers.themoviedb.org/3/getting-started/introduction) to get one -## Using a Container \ No newline at end of file +## Using a Container + +If you use Kyoo from a container, we recommand using the docker-compose file from [here](https://github.com/AnonymusRaccoon/Kyoo) and doing the following actions before launching the container: + +- If you use Postgres, configure the fields ```DATABASE__CONFIGURATIONS_*``` +- If you use SQLite, set the ```DATABASE__ENABLED``` to ```sqlite``` +- Set the ```*APIKEY``` values +- Map the folder ```/var/lib/kyoo``` to a directory on your host, so you can access files easily, and it'll be persistent +- Map the folder ```/video``` to the media directory +- If you use Postgres, map ```/var/lib/postgresql/data``` to the host's Postgres server data folder