ContextQMD
Back to Authelia

Jellysweep

docs/content/integration/openid-connect/clients/jellysweep/index.md

4.39.194.1 KB
Original Source

Tested Versions

{{% oidc-common %}}

Assumptions

This example makes the following assumptions:

  • Application Root URL: https://jellysweep.{{< sitevar name="domain" nojs="example.com" >}}/
  • Authelia Root URL: https://{{< sitevar name="subdomain-authelia" nojs="auth" >}}.{{< sitevar name="domain" nojs="example.com" >}}/
  • Client ID: jellysweep
  • Client Secret: insecure_secret

Some of the values presented in this guide can automatically be replaced with documentation variables.

{{< sitevar-preferences >}}

Configuration

Authelia

The following YAML configuration is an example Authelia client configuration for use with Jellysweep which will operate with the application example:

yaml
identity_providers:
  oidc:
    ## The other portions of the mandatory OpenID Connect 1.0 configuration go here.
    ## See: https://www.authelia.com/c/oidc
    clients:
      - client_id: 'jellysweep'
        client_name: 'Jellysweep'
        client_secret: '$pbkdf2-sha512$310000$c8p78n7pUMln0jzvd4aK4Q$JNRBzwAo0ek5qKn50cFzzvE9RXV88h1wJn5KGiHrD0YKtZaR/nCb2CJPOsKaPK0hjf.9yHxzQGZziziccp6Yng'  # The digest of 'insecure_secret'.
        public: false
        authorization_policy: 'two_factor'
        require_pkce: true
        pkce_challenge_method: 'S256'
        redirect_uris:
          - 'https://jellysweep.{{< sitevar name="domain" nojs="example.com" >}}/auth/oidc/callback'
        scopes:
          - 'openid'
          - 'profile'
          - 'email'
          - 'groups'
        response_types:
          - 'code'
        grant_types:
          - 'authorization_code'
        access_token_signed_response_alg: 'none'
        userinfo_signed_response_alg: 'none'
        token_endpoint_auth_method: 'client_secret_post'

Application

To configure Jellysweep to utilize Authelia as an OpenID Connect 1.0 Provider, configure the following environment variables in your deployment:

yaml
services:
  jellysweep:
    image: ghcr.io/jon4hz/jellysweep:v0.14.0
    container_name: jellysweep
    environment:
      - JELLYSWEEP_SERVER_URL=https://jellysweep.{{< sitevar name="domain" nojs="example.com" >}}
      - JELLYSWEEP_AUTH_OIDC_ENABLED=true
      - JELLYSWEEP_AUTH_OIDC_NAME=Authelia
      - JELLYSWEEP_AUTH_OIDC_ISSUER=https://{{< sitevar name="subdomain-authelia" nojs="auth" >}}.{{< sitevar name="domain" nojs="example.com" >}}
      - JELLYSWEEP_AUTH_OIDC_CLIENT_ID=jellysweep
      - JELLYSWEEP_AUTH_OIDC_CLIENT_SECRET=insecure_secret
      - JELLYSWEEP_AUTH_OIDC_REDIRECT_URL=https://jellysweep.{{< sitevar name="domain" nojs="example.com" >}}/auth/oidc/callback
      - JELLYSWEEP_AUTH_OIDC_USE_PKCE=true
      - JELLYSWEEP_AUTH_OIDC_ADMIN_GROUP=jellyfin-admins
    ports:
      - "3002:3002"
    volumes:
      - ./config.yml:/app/config.yml:ro
      - ./data:/app/data

{{< callout context="caution" title="Important Note" icon="outline/alert-triangle" >}} This configuration assumes Jellysweep administrators are part of the jellyfin-admins group. Depending on your specific group configuration, you will have to adapt the JELLYSWEEP_AUTH_OIDC_ADMIN_GROUP variable. Alternatively you may elect to create a new authorization policy in provider authorization policies then utilize that policy as the client authorization policy. {{< /callout >}}

See Also