From a94ddfb408159c88fcc35159aa78dc8f844b4e6d Mon Sep 17 00:00:00 2001 From: Arthi-chaud Date: Fri, 11 Feb 2022 10:54:23 +0100 Subject: [PATCH] Documentation: Setting-up: Settings.json: 'Basics' section --- docs/setting_up/setting_up.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/docs/setting_up/setting_up.md b/docs/setting_up/setting_up.md index 7637c633..9739eea2 100644 --- a/docs/setting_up/setting_up.md +++ b/docs/setting_up/setting_up.md @@ -11,4 +11,37 @@ To setup Kyoo, you need to make sure you installed it, then we'll configure some ## Settings.json +If you installed Kyoo on Linux/macOS, their should be a ```/var/lib/Kyoo``` directory +If you are on a Windows, it should be ```C:\ProgramData``` + +Inside this folder, we'll find (almost) everything we need. The most important file is ```settings.json``` + +At first, it'll look like [this](https://github.com/AnonymusRaccoon/Kyoo/blob/master/src/Kyoo.Host.Generic/settings.json) + +We are going to take a look at the fields you might want to change to tailor Kyoo to your configuration: + +- ```basics``` + - ```url```: The port on which Kyoo will be exposed + - ```publicUrl```: The full URL for Kyoo. **Warning** The port must match with ```url``` + For the 3 following fields, the path are relative to the directory ```settings.json``` is in + - ```pluginsPath```: The directory where the plugins are stored + - ```transmuxPath```: The directory where the transmux-ed video are stored (used as a cache) + - ```transcodePath```: The directory where the transcoded video are stored (used as a cache) + - ```metadataInShow```: A boolean telling if the Movie/Show metadata (posters, extracted subtitles, Chapters) will be stored in the same directory as the video, in an ```Extra``` directory, or in the ```metadataPath```. + For example, if ```metadataInShow``` is true, your file tree wil look something like this: + + ```bash + /my-movies + | + -- My First Movie/ + | + -- My First Movie.mp4 + -- Extra/ + | + -- poster.jpe + -- etc... + ``` + + **Warning** Therefore, if your shows are not in individual folders, it is recommended to set ```metadataInShow``` to ```false```. If you don't, all the shows will share the same metadata we are sure you don't want that ;) + ## Using a Container \ No newline at end of file