summaryrefslogtreecommitdiff
path: root/docs/content/integration/openid-connect/zipline/index.md
blob: 4ed9a235c2edbc1e0365a155ae82fb15a9a01bac (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
---
title: "Zipline"
description: "Integrating Zipline with the Authelia OpenID Connect 1.0 Provider."
summary: ""
date: 2025-03-04T12:18:02+10:00
draft: false
images: []
weight: 620
toc: true
support:
  level: community
  versions: true
  integration: true
seo:
  title: "" # custom title (optional)
  description: "" # custom description (recommended)
  canonical: "" # custom canonical URL (optional)
  noindex: false # false (default) or true
---

## Tested Versions

* [Authelia]
  * [v4.38.0](https://github.com/authelia/authelia/releases/tag/v4.38.0)
* [Zipline]
  * [4.0.0](https://github.com/diced/zipline/releases/tag/v4.0.0)

{{% oidc-common %}}

### Assumptions

This example makes the following assumptions:

* __Application Root URL:__ `https://zipline.{{< sitevar name="domain" nojs="example.com" >}}/`
* __Authelia Root URL:__ `https://{{< sitevar name="subdomain-authelia" nojs="auth" >}}.{{< sitevar name="domain" nojs="example.com" >}}/`
* __Client ID:__ `zipline`
* __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 [Zipline] which will
operate with the application example:

```yaml {title="configuration.yml"}
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: 'zipline'
        client_name: 'Zipline'
        client_secret: '$pbkdf2-sha512$310000$c8p78n7pUMln0jzvd4aK4Q$JNRBzwAo0ek5qKn50cFzzvE9RXV88h1wJn5KGiHrD0YKtZaR/nCb2CJPOsKaPK0hjf.9yHxzQGZziziccp6Yng'  # The digest of 'insecure_secret'.
        public: false
        redirect_uris:
          - 'https://zipline.{{< sitevar name="domain" nojs="example.com" >}}/api/auth/oauth/oidc'
        scopes:
          - 'openid'
          - 'email'
          - 'profile'
          - offline_access
        response_types: 'code'
        token_endpoint_auth_method: 'client_secret_post'
```

### Application

To configure [Zipline] to utilize Authelia as an [OpenID Connect 1.0] Provider:

1. Go to Server Settings
2. Activate the **OAuth Registration** feature toggle
2. Configure:
   1. OIDC Client ID: `ziplinea`
   2. OIDC Client Secret: `insecure_secret`
   3. OIDC Authorize URL: `https://{{< sitevar name="subdomain-authelia" nojs="auth" >}}.{{< sitevar name="domain" nojs="example.com" >}}/api/oidc/authorization`
   4. OIDC Token URL: `https://{{< sitevar name="subdomain-authelia" nojs="auth" >}}.{{< sitevar name="domain" nojs="example.com" >}}/api/oidc/token`
   5. OIDC Userinfo URL: `https://{{< sitevar name="subdomain-authelia" nojs="auth" >}}.{{< sitevar name="domain" nojs="example.com" >}}/api/oidc/userinfo`
   6. OIDC Redirect URL can be left blank, but the default Zipline URL is HTTP, if you didn't activate **Return HTTPS URLs** in the Core settings, this impacts the OIDC Redirect URL
3. Click Save

{{< figure src="zipline.png" alt="Zipline configuration" width="300" >}}

Take a look at the [See Also](#see-also) section for the cheatsheets corresponding to the sections above for their
descriptions.

## See Also

- [Zipline]:
  - [OIDC documentation](https://zipline.diced.sh/docs/guides/oauth/oidc)

[Authelia]: https://www.authelia.com
[Zipline]: https://zipline.diced.sh/
[OpenID Connect 1.0]: ../../openid-connect/introduction.md
[client configuration]: ../../../configuration/identity-providers/openid-connect/clients.md