0
0
Fork 0
mirror of https://codeberg.org/forgejo/docs.git synced 2024-11-28 18:42:51 -05:00

split the documentation into user/developer/admin

This commit is contained in:
Earl Warren 2023-03-01 18:47:26 +01:00
parent 0454802412
commit 41b0111c59
9 changed files with 49 additions and 28 deletions

View file

@ -3,19 +3,11 @@ layout: '~/layouts/Markdown.astro'
title: 'Forgejo v1.19 administrator guide' title: 'Forgejo v1.19 administrator guide'
--- ---
* [What is Forgejo?](https://forgejo.org/)
* [Installation](https://forgejo.org/download/)
* [FAQ](https://forgejo.org/faq/)
* [Configuration Cheat Sheet](config-cheat-sheet) * [Configuration Cheat Sheet](config-cheat-sheet)
* [Upgrade guide](upgrade) * [Upgrade guide](upgrade)
* [Command Line](command-line) * [Command Line](command-line)
* Authentication * [Reverse Proxy](reverse-proxy)
* [LDAP, PAM, FreeIPA, Reverse Proxy](authentication)
* [OAuth2, Scoped Tokens, Client Types](oauth2-provider)
* [Email setup](email-setup) * [Email setup](email-setup)
* [Incoming Email](incoming-email) * [Incoming Email](incoming-email)
* [Logging Configuration](logging-documentation) * [Logging Configuration](logging-documentation)
* [Packages](packages) * [Packages](packages)
* [API Usage](api-usage)
* [API Reference](https://codeberg.org/api/swagger)
* [License](license)

View file

@ -0,0 +1,21 @@
---
layout: '~/layouts/Markdown.astro'
title: 'Reverse proxy'
---
Forgejo supports Reverse Proxy Header authentication, it will read headers as a trusted login user name or user email address. This hasn't been enabled by default, you can enable it with
```ini
[service]
ENABLE_REVERSE_PROXY_AUTHENTICATION = true
```
The default login user name is in the `X-WEBAUTH-USER` header, you can change it via changing `REVERSE_PROXY_AUTHENTICATION_USER` in app.ini. If the user doesn't exist, you can enable automatic registration with `ENABLE_REVERSE_PROXY_AUTO_REGISTRATION=true`.
The default login user email is `X-WEBAUTH-EMAIL`, you can change it via changing `REVERSE_PROXY_AUTHENTICATION_EMAIL` in app.ini, this could also be disabled with `ENABLE_REVERSE_PROXY_EMAIL`
If set `ENABLE_REVERSE_PROXY_FULL_NAME=true`, a user full name expected in `X-WEBAUTH-FULLNAME` will be assigned to the user when auto creating the user. You can also change the header name with `REVERSE_PROXY_AUTHENTICATION_FULL_NAME`.
You can also limit the reverse proxy's IP address range with `REVERSE_PROXY_TRUSTED_PROXIES` which default value is `127.0.0.0/8,::1/128`. By `REVERSE_PROXY_LIMIT`, you can limit trusted proxies level.
Notice: Reverse Proxy Auth doesn't support the API. You still need an access token or basic auth to make API requests.

5
v1.19/developer/index.md Normal file
View file

@ -0,0 +1,5 @@
---
layout: '~/layouts/Markdown.astro'
title: 'Forgejo v1.19 developer guide'
---

12
v1.19/index.md Normal file
View file

@ -0,0 +1,12 @@
---
layout: '~/layouts/Markdown.astro'
title: 'Forgejo v1.19 documentation'
---
* [What is Forgejo?](https://forgejo.org/)
* [Installation](https://forgejo.org/download/)
* [FAQ](https://forgejo.org/faq/)
* [Administrator guide](admin)
* [User guide](user)
* [Developer guide](developer)
* [License](license)

View file

@ -232,22 +232,3 @@ user will log into the Forgejo web interface as `gituser` and not `gituser@mail.
- Log in to Forgejo as an Administrator and click on "Authentication" under Admin Panel. - Log in to Forgejo as an Administrator and click on "Authentication" under Admin Panel.
Then click `Add New Source` and fill in the details, changing all where appropriate. Then click `Add New Source` and fill in the details, changing all where appropriate.
## Reverse Proxy
Forgejo supports Reverse Proxy Header authentication, it will read headers as a trusted login user name or user email address. This hasn't been enabled by default, you can enable it with
```ini
[service]
ENABLE_REVERSE_PROXY_AUTHENTICATION = true
```
The default login user name is in the `X-WEBAUTH-USER` header, you can change it via changing `REVERSE_PROXY_AUTHENTICATION_USER` in app.ini. If the user doesn't exist, you can enable automatic registration with `ENABLE_REVERSE_PROXY_AUTO_REGISTRATION=true`.
The default login user email is `X-WEBAUTH-EMAIL`, you can change it via changing `REVERSE_PROXY_AUTHENTICATION_EMAIL` in app.ini, this could also be disabled with `ENABLE_REVERSE_PROXY_EMAIL`
If set `ENABLE_REVERSE_PROXY_FULL_NAME=true`, a user full name expected in `X-WEBAUTH-FULLNAME` will be assigned to the user when auto creating the user. You can also change the header name with `REVERSE_PROXY_AUTHENTICATION_FULL_NAME`.
You can also limit the reverse proxy's IP address range with `REVERSE_PROXY_TRUSTED_PROXIES` which default value is `127.0.0.0/8,::1/128`. By `REVERSE_PROXY_LIMIT`, you can limit trusted proxies level.
Notice: Reverse Proxy Auth doesn't support the API. You still need an access token or basic auth to make API requests.

10
v1.19/user/index.md Normal file
View file

@ -0,0 +1,10 @@
---
layout: '~/layouts/Markdown.astro'
title: 'Forgejo v1.19 user guide'
---
* Authentication
* [LDAP, PAM, FreeIPA](authentication)
* [OAuth2, Scoped Tokens, Client Types](oauth2-provider)
* [API Usage](api-usage)
* [API Reference](https://codeberg.org/api/swagger)