doc: SourceHut documentation fixes (#3170)

* fix: SourceHut documentation

- Add it to sidebar and provider index
- Fix broken link

This fixes an oversight in #2359, where I had not fully understood how
the documentation works.

Signed-off-by: Conrad Hoffmann <ch@bitfehler.net>

* fix: doc build instructions in docs/README.md

---------

Signed-off-by: Conrad Hoffmann <ch@bitfehler.net>
This commit is contained in:
Conrad Hoffmann 2025-08-20 12:02:32 +02:00 committed by GitHub
parent 5082db0bec
commit 8afb047e01
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
10 changed files with 12 additions and 6 deletions

View File

@ -19,7 +19,7 @@ This command starts a local development server and open up a browser window. Mos
## Build ## Build
```console ```console
npm build npm run build
``` ```
This command generates static content into the `build` directory and can be served using any static contents hosting service. This command generates static content into the `build` directory and can be served using any static contents hosting service.

View File

@ -25,6 +25,7 @@ Valid providers are :
- [Microsoft Entra ID](ms_entra_id.md) - [Microsoft Entra ID](ms_entra_id.md)
- [Nextcloud](nextcloud.md) - [Nextcloud](nextcloud.md)
- [OpenID Connect](openid_connect.md) - [OpenID Connect](openid_connect.md)
- [SourceHut](sourcehut.md)
The provider can be selected using the `provider` configuration value, or set in the [`providers` array using AlphaConfig](https://oauth2-proxy.github.io/oauth2-proxy/configuration/alpha-config#providers). However, [**the feature to implement multiple providers is not complete**](https://github.com/oauth2-proxy/oauth2-proxy/issues/926). The provider can be selected using the `provider` configuration value, or set in the [`providers` array using AlphaConfig](https://oauth2-proxy.github.io/oauth2-proxy/configuration/alpha-config#providers). However, [**the feature to implement multiple providers is not complete**](https://github.com/oauth2-proxy/oauth2-proxy/issues/926).

View File

@ -21,5 +21,5 @@ to the appropriate URLs:
The default configuration allows everyone with an account to authenticate. The default configuration allows everyone with an account to authenticate.
Restricting access is currently only supported by Restricting access is currently only supported by
[email](#email-authentication). [email](index.md#email-authentication).

View File

@ -47,6 +47,7 @@ const sidebars = {
"configuration/providers/ms_entra_id", "configuration/providers/ms_entra_id",
"configuration/providers/nextcloud", "configuration/providers/nextcloud",
"configuration/providers/openid_connect", "configuration/providers/openid_connect",
"configuration/providers/sourcehut"
], ],
}, },
'configuration/session_storage', 'configuration/session_storage',

View File

@ -24,6 +24,7 @@ Valid providers are :
- [Microsoft Entra ID](ms_entra_id.md) - [Microsoft Entra ID](ms_entra_id.md)
- [Nextcloud](nextcloud.md) - [Nextcloud](nextcloud.md)
- [OpenID Connect](openid_connect.md) - [OpenID Connect](openid_connect.md)
- [SourceHut](sourcehut.md)
The provider can be selected using the `provider` configuration value, or set in the [`providers` array using AlphaConfig](https://oauth2-proxy.github.io/oauth2-proxy/configuration/alpha-config#providers). However, [**the feature to implement multiple providers is not complete**](https://github.com/oauth2-proxy/oauth2-proxy/issues/926). The provider can be selected using the `provider` configuration value, or set in the [`providers` array using AlphaConfig](https://oauth2-proxy.github.io/oauth2-proxy/configuration/alpha-config#providers). However, [**the feature to implement multiple providers is not complete**](https://github.com/oauth2-proxy/oauth2-proxy/issues/926).

View File

@ -21,5 +21,5 @@ to the appropriate URLs:
The default configuration allows everyone with an account to authenticate. The default configuration allows everyone with an account to authenticate.
Restricting access is currently only supported by Restricting access is currently only supported by
[email](#email-authentication). [email](index.md#email-authentication).

View File

@ -25,6 +25,7 @@ Valid providers are :
- [Microsoft Entra ID](ms_entra_id.md) - [Microsoft Entra ID](ms_entra_id.md)
- [Nextcloud](nextcloud.md) - [Nextcloud](nextcloud.md)
- [OpenID Connect](openid_connect.md) - [OpenID Connect](openid_connect.md)
- [SourceHut](sourcehut.md)
The provider can be selected using the `provider` configuration value, or set in the [`providers` array using AlphaConfig](https://oauth2-proxy.github.io/oauth2-proxy/configuration/alpha-config#providers). However, [**the feature to implement multiple providers is not complete**](https://github.com/oauth2-proxy/oauth2-proxy/issues/926). The provider can be selected using the `provider` configuration value, or set in the [`providers` array using AlphaConfig](https://oauth2-proxy.github.io/oauth2-proxy/configuration/alpha-config#providers). However, [**the feature to implement multiple providers is not complete**](https://github.com/oauth2-proxy/oauth2-proxy/issues/926).

View File

@ -21,5 +21,5 @@ to the appropriate URLs:
The default configuration allows everyone with an account to authenticate. The default configuration allows everyone with an account to authenticate.
Restricting access is currently only supported by Restricting access is currently only supported by
[email](#email-authentication). [email](index.md#email-authentication).

View File

@ -46,7 +46,8 @@
"configuration/providers/login_gov", "configuration/providers/login_gov",
"configuration/providers/ms_entra_id", "configuration/providers/ms_entra_id",
"configuration/providers/nextcloud", "configuration/providers/nextcloud",
"configuration/providers/openid_connect" "configuration/providers/openid_connect",
"configuration/providers/sourcehut"
] ]
}, },
"configuration/session_storage", "configuration/session_storage",

View File

@ -46,7 +46,8 @@
"configuration/providers/login_gov", "configuration/providers/login_gov",
"configuration/providers/ms_entra_id", "configuration/providers/ms_entra_id",
"configuration/providers/nextcloud", "configuration/providers/nextcloud",
"configuration/providers/openid_connect" "configuration/providers/openid_connect",
"configuration/providers/sourcehut"
] ]
}, },
"configuration/session_storage", "configuration/session_storage",