Gitea

Tested Versions#

• Authelia
  • v4.38.0
• Gitea
  • 1.17.0

Before You Begin#

Common Notes#

1. The OpenID Connect 1.0 client_id parameter:
   1. This must be a unique value for every client.
   2. The value used in this guide is merely for readability and demonstration purposes and you should not use this value in production and should instead utilize the How do I generate a client identifier or client secret? FAQ. We recommend 64 random characters but you can use any arbitrary value that meets the other criteria.
   3. This must only contain RFC3986 Unreserved Characters.
   4. This must be no more than 100 characters in length.
2. The OpenID Connect 1.0 client_secret parameter:
   1. The value used in this guide is merely for demonstration purposes and you should absolutely not use this value in production and should instead utilize the How do I generate a client identifier or client secret? FAQ.
   2. This string may be stored as plaintext in the Authelia configuration but this behaviour is deprecated and is not guaranteed to be supported in the future. See the Plaintext guide for more information.
   3. When the secret is stored in hashed form in the Authelia configuration (heavily recommended), the cost of hashing can, if too great, cause timeouts for clients. See the Tuning the work factors guide for more information.
3. The configuration example for Authelia:
   1. Only contains an example configuration for the client registration and you MUST also configure the required elements from the OpenID Connect 1.0 Provider Configuration guide.
   2. Only contains a small portion of all of the available options for a registered client and users may wish to configure portions that are not part of this guide or configure them differently, as such it’s important to both familiarize yourself with the other options available and the effect of each of the options configured in this section by looking at the OpenID Connect 1.0 Clients Configuration guide.

Assumptions#

This example makes the following assumptions:

• Application Root URL: https://gitea.example.com/
• Authelia Root URL: https://auth.example.com/
• Client ID: gitea
• Client Secret: insecure_secret
• Authentication Name (Gitea): authelia:
  • This option determines the redirect URI in the format of https://gitea.example.com/user/oauth2/<Authentication Name>/callback. This means if you change this value you need to update the redirect URI.

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

Set Documentation Variables

Configuration#

Authelia#

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

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: 'gitea'
        client_name: 'Gitea'
        client_secret: '$pbkdf2-sha512$310000$c8p78n7pUMln0jzvd4aK4Q$JNRBzwAo0ek5qKn50cFzzvE9RXV88h1wJn5KGiHrD0YKtZaR/nCb2CJPOsKaPK0hjf.9yHxzQGZziziccp6Yng'  # The digest of 'insecure_secret'.
        public: false
        authorization_policy: 'two_factor'
        redirect_uris:
          - 'https://gitea.example.com/user/oauth2/authelia/callback'
        scopes:
          - 'openid'
          - 'email'
          - 'profile'
        userinfo_signed_response_alg: 'none'
        token_endpoint_auth_method: 'client_secret_basic'

Application#

To configure Gitea to utilize Authelia as an OpenID Connect 1.0 Provider:

1. Expand User Options
2. Visit Site Administration
3. Visit Authentication Sources
4. Visit Add Authentication Source
5. Configure:
   1. Authentication Name: authelia
   2. OAuth2 Provider: OpenID Connect
   3. Client ID (Key): gitea
   4. Client Secret: insecure_secret
   5. OpenID Connect Auto Discovery URL: https://auth.example.com/.well-known/openid-configuration

CLI#

Important Note: Please refer to the Gitea CLI Guide regarding the correct usage of the CLI.

Alternatively, you can add the authentication source via command line:

gitea admin auth add-oauth --provider=openidConnect --name=authelia --key=gitea --secret=insecure_secret --auto-discover-url=https://auth.example.com/.well-known/openid-configuration --scopes='openid email profile'

You might have to run ./gitea migrate first in order to set up the database with the required structure.

To configure Gitea to perform automatic user creation for the auth.example.com domain via OpenID Connect 1.0:

1. Edit the following values in the Gitea app.ini:

[openid]
ENABLE_OPENID_SIGNIN = false
ENABLE_OPENID_SIGNUP = true
WHITELISTED_URIS     = auth.example.com

[service]
DISABLE_REGISTRATION                          = false
ALLOW_ONLY_EXTERNAL_REGISTRATION              = true
SHOW_REGISTRATION_BUTTON                      = false

Take a look at the See Also section for the cheatsheets corresponding to the sections above for their descriptions.

See Also#

• Gitea app.ini Config Cheat Sheet:
  • OpenID
  • Service