Cutlery/Kyoo
1
0
Fork 0
mirror of https://github.com/zoriya/Kyoo.git synced 2025-05-24 02:02:36 -04:00
Code Issues Packages Projects Releases Wiki Activity

Include tmdb api keys by default (#488)

Browse Source
This commit is contained in:
Zoe Roux 2024-05-12 21:32:14 +02:00 committed by GitHub
parent d5d15eaea6
commit fe38cd65b8
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.env.example
View File

@ -37,6 +37,8 @@ GOCODER_PRESET=fast
# You can input multiple api keys separated by a , # You can input multiple api keys separated by a ,
KYOO_APIKEYS=t7H5!@4iMNsAaSJQ49pat4jprJgTcF656if#J3 KYOO_APIKEYS=t7H5!@4iMNsAaSJQ49pat4jprJgTcF656if#J3
# Keep this empty to use kyoo's default api key. You can also specify a custom API key if you want.
# To get one, go to https://www.themoviedb.org/settings/api and copy the api key (not the read access token, the api key)
THEMOVIEDB_APIKEY= THEMOVIEDB_APIKEY=
# The url you can use to reach your kyoo instance. This is used during oidc to redirect users to your instance. # The url you can use to reach your kyoo instance. This is used during oidc to redirect users to your instance.

8
INSTALLING.md
View File

@ -4,7 +4,7 @@
2. Download the 2. Download the
[`docker-compose.yml`](https://github.com/zoriya/kyoo/releases/latest/download/docker-compose.yml) and [`docker-compose.yml`](https://github.com/zoriya/kyoo/releases/latest/download/docker-compose.yml) and
[`.env`](https://raw.githubusercontent.com/zoriya/Kyoo/master/.env.example) files [`.env`](https://raw.githubusercontent.com/zoriya/Kyoo/master/.env.example) files
3. Fill the `.env` file with your configuration options (and an API Key from [themoviedb.org](https://www.themoviedb.org/)) 3. Fill the `.env` file with your configuration options
4. Look at [Hardware Acceleration section](#Hardware-Acceleration) if you need it 4. Look at [Hardware Acceleration section](#Hardware-Acceleration) if you need it
5. Run `docker compose up -d` and see kyoo at `http://localhost:8901` 5. Run `docker compose up -d` and see kyoo at `http://localhost:8901`
@ -16,7 +16,7 @@ To install Kyoo, you need docker and docker-compose. Those can be installed from
or [Windows](https://docs.docker.com/desktop/install/windows-install/). Docker is used to run each services of Kyoo in or [Windows](https://docs.docker.com/desktop/install/windows-install/). Docker is used to run each services of Kyoo in
an isolated environment with all the dependencies they need. an isolated environment with all the dependencies they need.
Kyoo also needs 2 files to work properly. The first should be downloaded from the latest release artificat, the other needs to be filled in with your configurations. Kyoo also needs 2 files to work properly. The first should be downloaded from the latest release artifact, the other needs to be filled in with your configurations.
Those files can be put in any directory of your choice. Those files can be put in any directory of your choice.
Those files are: Those files are:
@ -28,10 +28,6 @@ Those files are:
> The `docker-compose.yml` file describes the different services of Kyoo, where they should be downloaded and their start order. \ > The `docker-compose.yml` file describes the different services of Kyoo, where they should be downloaded and their start order. \
> The `.env` file contains all the configuration options that the services in `docker-compose.yml` will read. > The `.env` file contains all the configuration options that the services in `docker-compose.yml` will read.
To retrieve metadata, Kyoo will need to communicate with an external service. For now, that is `the movie database`.
For this purpose, you will need to get an API Key. For that, go to [themoviedb.org](https://www.themoviedb.org/) and create an account, then
go [here](https://www.themoviedb.org/settings/api) and copy the `API Key (v3 auth)`, paste it after the `THEMOVIEDB_APIKEY=` on the `.env` file.
If you need hardware acceleration, look at [Hardware Acceleration section](#Hardware-Acceleration) if you need it If you need hardware acceleration, look at [Hardware Acceleration section](#Hardware-Acceleration) if you need it
The next and last step is actually starting Kyoo. To do that, open a terminal in the same directory as the 3 configurations files The next and last step is actually starting Kyoo. To do that, open a terminal in the same directory as the 3 configurations files

2
scanner/providers/implementations/themoviedatabase.py
View File

@ -22,6 +22,8 @@ logger = getLogger(__name__)
class TheMovieDatabase(Provider): class TheMovieDatabase(Provider):
DEFAULT_API_KEY = "c9f328a01011b28f22483717395fc3fa"
def __init__( def __init__(
self, self,
languages: list[str], languages: list[str],

4
scanner/providers/provider.py
View File

@ -24,8 +24,8 @@ class Provider:
from providers.implementations.themoviedatabase import TheMovieDatabase from providers.implementations.themoviedatabase import TheMovieDatabase
tmdb = os.environ.get("THEMOVIEDB_APIKEY") tmdb = os.environ.get("THEMOVIEDB_APIKEY") or TheMovieDatabase.DEFAULT_API_KEY
if tmdb: if tmdb != "disabled":
tmdb = TheMovieDatabase(languages, client, tmdb) tmdb = TheMovieDatabase(languages, client, tmdb)
providers.append(tmdb) providers.append(tmdb)