Add all oidc variables to .env.example

This commit is contained in:
Zoe Roux 2024-03-09 00:20:29 +01:00
parent a3ec224cf0
commit 7adfef9f36
2 changed files with 15 additions and 5 deletions

View File

@ -25,10 +25,20 @@ UNLOGGED_PERMISSIONS=overall.read,overall.play
THEMOVIEDB_APIKEY= THEMOVIEDB_APIKEY=
PUBLIC_URL=http://localhost:5000 PUBLIC_URL=http://localhost:5000
# You can use as many # Use a builtin oidc service (google or discord):
OIDC_GOOGLE_URL=https://accounts.google.com/o/oauth2/v2/auth # OIDC_DISCORD_CLIENTID=
OIDC_GOOGLE_CLIENTID= # OIDC_DISCORD_SECRET=
OIDC_GOOGLE_SECRET=
# Or add your custom one:
OIDC_SERVICE_NAME=YourPrettyName
OIDC_SERVICE_LOGO=https://url-of-your-logo.com
OIDC_SERVICE_CLIENTID=
OIDC_SERVICE_SECRET=
OIDC_SERVICE_AUTHORIZATION=https://url-of-the-authorization-endpoint-of-the-oidc-service.com/auth
OIDC_SERVICE_TOKEN=https://url-of-the-token-endpoint-of-the-oidc-service.com/token
OIDC_SERVICE_PROFILE=https://url-of-the-profile-endpoint-of-the-oidc-service.com/userinfo
OIDC_SERVICE_SCOPE="the list of scopes space separeted like email identity"
# on the previous list, service is the internal name of your service, you can add as many as you want.
# Following options are optional and only useful for debugging. # Following options are optional and only useful for debugging.

View File

@ -7,7 +7,7 @@
[`.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 (and an API Key from [themoviedb.org](https://www.themoviedb.org/))
4. Look at [Hardware Acceleration section](#Hardware-Acceleration) if you need it 4. Look at [Hardware Acceleration section](#Hardware-Acceleration) if you need it
4. 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`
# Installing # Installing