Documentation: Setting-up: Some fixes & details

This commit is contained in:
Arthi-chaud 2022-02-11 14:02:20 +01:00
parent 349d1ea3cb
commit b3e9904634
No known key found for this signature in database
GPG Key ID: 320A19ADD621B0F7

View File

@ -12,7 +12,7 @@ To setup Kyoo, you need to make sure you installed it, then we'll configure some
## settings.json ## settings.json
If you installed Kyoo on Linux/macOS, their should be a ```/var/lib/Kyoo``` directory 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``` If you are on a Windows, it should be ```C:\ProgramData\Kyoo```
Inside this folder, we'll find (almost) everything we need. The most important file is ```settings.json``` Inside this folder, we'll find (almost) everything we need. The most important file is ```settings.json```
@ -22,7 +22,7 @@ We are going to take a look at the fields you might want to change to tailor Kyo
- ```basics``` - ```basics```
- ```url```: The port on which Kyoo will be exposed - ```url```: The port on which Kyoo will be exposed
- ```publicUrl```: The full URL for Kyoo. **Warning** The port must match with ```url``` - ```publicUrl```: The full URL for Kyoo.
For the 3 following fields, the path are relative to the directory ```settings.json``` is in For the 3 following fields, the path are relative to the directory ```settings.json``` is in
- ```pluginsPath```: The directory where the plugins are stored - ```pluginsPath```: The directory where the plugins are stored
- ```transmuxPath```: The directory where the transmux-ed video are stored (used as a cache) - ```transmuxPath```: The directory where the transmux-ed video are stored (used as a cache)
@ -45,17 +45,17 @@ We are going to take a look at the fields you might want to change to tailor Kyo
**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 ;) **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 ;)
- ```database``` - ```database```
- ```enabled```: Which database to use. Either ```sqlite``` (by default) or ```postgres```. SQLite is easier to use & manage if you don't have an SQL server on your machine - ```enabled```: Which database to use. Either ```sqlite``` (by default) or ```postgres```. SQLite is easier to use & manage if you don't have an SQL server on your machine. However, if you have a large amount of videos, we recommend using Postgres, which is more powerful to manage large databases
- ```tasks``` - ```tasks```
- ```parallels```: The number (as a string) of tasks that can be run at the same time. To avoid conflicts, we recommend leaving the value at ```1``` - ```parallels```: The number of tasks that can be run at the same time. If the values is not ```1```, the behavior is not implemented.
- ```scheduled```: An object with keys being the name of an automation task, with a value being the interval between each task of the same type. - ```scheduled```: An object with keys being the name of an automation task, with a value being the interval between each task of the same type.
- The available keys can be found at ```publicUrl/api/tasks``` (as 'slug') - The available keys can be found at ```publicUrl/api/tasks``` (as 'slug')
- The values must be formatted like ```HH:MM:SS`` - The values must be formatted like ```HH:MM:SS``
**For Example** in the default configuration, a file scan task will be executed every 24 hours **For Example** in the default configuration, a file scan task will be executed every 24 hours
- ```media``` - ```media```
- ```regex```: An array of String to match files using Regex (PHP). The Regex must have the following groups: - ```regex```: An array of String to match files using Regex. The Regex must have the following groups:
- ```Collection```: The name of the collection. For example, you can move all the movie from a same saga in one directory, the collection's name will be the directory's. If the movie is at the root of the library, no collection will be created. - ```Collection```: The name of the collection. For example, you can move all the movie from a same saga in one directory, the collection's name will be the directory's. If the movie is at the root of the library, no collection will be created.
- ```Show```: the name of the show/movie - ```Show```: the name of the show/movie
- ```StartYear``` (optional): the start year for a TV Series, or Year for a movie, used to get the correct metadata in provider - ```StartYear``` (optional): the start year for a TV Series, or Year for a movie, used to get the correct metadata in provider
@ -75,7 +75,7 @@ We are going to take a look at the fields you might want to change to tailor Kyo
## Using a Container ## 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 Kyoo from a container, we recommend 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 Postgres, configure the fields ```DATABASE__CONFIGURATIONS_*```
- If you use SQLite, set the ```DATABASE__ENABLED``` to ```sqlite``` - If you use SQLite, set the ```DATABASE__ENABLED``` to ```sqlite```
@ -84,6 +84,8 @@ If you use Kyoo from a container, we recommand using the docker-compose file fro
- Map the folder ```/video``` to the media directory - 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 - If you use Postgres, map ```/var/lib/postgresql/data``` to the host's Postgres server data folder
If you don't have a previous Kyoo configuration, we recommend using Postgres.
## Configuring Libraries ## Configuring Libraries
You are now ready to launch Kyoo for the first time! You are now ready to launch Kyoo for the first time!
@ -103,7 +105,7 @@ Then, we are going to interact with Kyoo's API. To create a library, you must do
{ {
"name": "$KYOO_LIBRARY_NAME", // The name of the Library "name": "$KYOO_LIBRARY_NAME", // The name of the Library
"slug": "$KYOO_LIBRARY_SLUG", // The unique identifier of the Library, can be $KYOO_LIBRARY_NAME if it's unique "slug": "$KYOO_LIBRARY_SLUG", // The unique identifier of the Library, can be $KYOO_LIBRARY_NAME if it's unique
"paths": ["$KYOO_LIBRARY_PATH"], // Path of directories to scan for shows in library "paths": ["$KYOO_LIBRARY_PATH"], // Paths of directories to scan for shows in library
"providers": [ "providers": [
{"slug": "the-moviedb"}, // Remove if you don't want to use this provider {"slug": "the-moviedb"}, // Remove if you don't want to use this provider
{"slug": "the-tvdb"} // Remove if you don't want to use this provider {"slug": "the-tvdb"} // Remove if you don't want to use this provider