dataset/seed/forgejo/README.md

152 lines
11 KiB
Markdown
Raw Normal View History

2023-01-17 21:43:32 +01:00
---
gitea: none
include_toc: true
---
# forgejo
2023-08-02 09:26:54 +02:00
## Synopsis
2023-01-17 21:43:32 +01:00
Forgejo, a community managed lightweight code hosting solution.
[For more informations](https://forgejo.org/)
2023-08-02 09:26:54 +02:00
## Basic variables
2023-08-01 14:34:26 +02:00
2023-08-02 09:26:54 +02:00
### Général
2023-08-01 14:34:26 +02:00
2023-08-02 09:26:54 +02:00
#### Reverse proxy
2023-08-01 14:34:26 +02:00
2023-08-02 09:26:54 +02:00
##### Point d'entrée des clients
This a family is a leadership.
| Description | Type | Example | Supplier |
|----------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|---------------------|-----------------------|
| **Nom de domaine exterieur du serveur** (*[general.revprox.revprox_client.revprox_client_external_domainnames](dictionaries/21_revprox_client.xml)*) [+] | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | service.example.net | ReverseProxy:external |
| **Nom de l'arborescence racine du site** (*[general.revprox.revprox_client.revprox_client_location](dictionaries/21_revprox_client.xml)*) | [filename](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | ReverseProxy:location |
#### Forgejo
Git forge Forgejo.
| Description | Values | Type | Example |
|-------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|-------------------|
| **Titre de la forge** (*[general.forgejo.forgejo_title](dictionaries/31_forgejo.xml)*) | Forgejo : Au-delà du développement. Nous forgeons. | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | |
| **Les courriels sont envoyés à partir de cet adresse** (*[general.forgejo.forgejo_mail_sender](dictionaries/31_forgejo.xml)*) | | [mail](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | admin@example.net |
- [+]: variable is multiple
- **bold**: variable is mandatory
## Variables for expert
### Général
#### Reverse proxy
##### Point d'entrée des clients
This a family is a leadership.
| Description | Supplier |
|-------------------------------------------------------------------------------------------------------------------------------|----------------------------|
| Taille maximum du corps (*[general.revprox.revprox_client.revprox_client_max_body_size](dictionaries/21_revprox_client.xml)*) | ReverseProxy:max_body_size |
#### PostgreSQL
| Description | Values | Supplier | Type |
|-------------------------------------------------------------------------------------------------|--------------|---------------------|--------------------------------------------------------------------------------------------------------------------------|
| **Client username** (*[general.postgresql.pg_client_username](dictionaries/23_postgresql.xml)*) | *calculated* | Postgresql:username | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
| **Client password** (*[general.postgresql.pg_client_password](dictionaries/23_postgresql.xml)*) | *calculated* | Postgresql:password | [password](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
| **Client database** (*[general.postgresql.pg_client_database](dictionaries/23_postgresql.xml)*) | *calculated* | Postgresql:database | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
#### Redis
| Description | Values | Supplier | Type |
|----------------------------------------------------------------------------------------------------|--------------|----------------|--------------------------------------------------------------------------------------------------------------------------|
| **Nom d'utilisateur** (*[general.redis.redis_client_username](dictionaries/23_redis.xml)*) | *calculated* | Redis:username | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
| **Mot de passe de connexion** (*[general.redis.redis_client_password](dictionaries/23_redis.xml)*) | *calculated* | Redis:password | [password](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
#### OAuth2 client
2023-08-01 14:34:26 +02:00
2023-08-02 09:26:54 +02:00
| Description | Values | Example | Supplier | Type |
|------------------------------------------------------------------------------------------------------------------|------------------------|---------------------|--------------------|-----------------------------------------------------------------------------------------------------------------------------|
| **OAuth2 client name** (*[general.oauth2_client.oauth2_client_name](dictionaries/31_forgejo.xml)*) | Forge | example | OAuth2:name | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
| **OAuth2 client description** (*[general.oauth2_client.oauth2_client_description](dictionaries/31_forgejo.xml)*) | Forge logiciel Forgejo | Example description | OAuth2:description | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
| OAuth2 URL to valid login (*[general.oauth2_client.oauth2_client_login](dictionaries/30_oauth2_client.xml)*) | *calculated* | | OAuth2:login | [web_address](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
| **OAuth2 category** (*[general.oauth2_client.oauth2_client_category](dictionaries/31_forgejo.xml)*) | Développement | | OAuth2:category | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
| **OAuth2 logo** (*[general.oauth2_client.oauth2_client_logo](dictionaries/31_forgejo.xml)*) | silique_note.png | | OAuth2:logo | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
##### external
| Description | Type | Values | Supplier |
|-------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------|--------------|-----------------|
| **OAuth2 client external** (*[general.oauth2_client.external.oauth2_client_external](dictionaries/31_forgejo.xml)*) [+] | [web_address](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | *calculated* | OAuth2:external |
| **OAuth2 family** (*[general.oauth2_client.external.oauth2_client_family](dictionaries/30_oauth2_client.xml)*) | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | users | OAuth2:family |
- [+]: variable is multiple
- **bold**: variable is mandatory
## Associated providers
- **LocalDNS**
- Journald
- **SMTP**
- **ReverseProxy**
- **Postgresql**
- **Redis**
- **OAuth2**
**bold**: provider is mandatory
## Example
Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file.
2023-08-01 14:34:26 +02:00
```
forgejo:
applicationservice: forgejo
zones_name:
- localdns
- reverseproxy
- smtp
- redis
- oauth2
- postgresql
2023-08-02 09:26:54 +02:00
values:
general.revprox.revprox_client.revprox_client_external_domainnames:
- service.example.net
general.forgejo.forgejo_mail_sender: admin@example.net
2023-08-01 14:34:26 +02:00
```
2023-01-17 21:43:32 +01:00
## Dependances
2023-06-29 18:56:46 +02:00
- [base-fedora-38](../base-fedora-38/README.md)
2023-01-17 21:43:32 +01:00
- [base-fedora](../base-fedora/README.md)
- [systemd](../systemd/README.md)
- [base-machine](../base-machine/README.md)
- [base](../base/README.md)
- [dns-local](../dns-local/README.md)
2023-02-14 14:24:16 +01:00
- [pki-tls](../pki-tls/README.md)
2023-06-29 18:56:46 +02:00
- [journald](../journald/README.md)
2023-07-31 18:41:59 +02:00
- [resolved](../resolved/README.md)
2023-01-17 21:43:32 +01:00
- [postgresql-client](../postgresql-client/README.md)
- [reverse-proxy-client](../reverse-proxy-client/README.md)
- [relay-mail-client](../relay-mail-client/README.md)
- [redis-client](../redis-client/README.md)
2023-06-29 18:56:46 +02:00
- [redis-common](../redis-common/README.md)
2023-01-17 21:43:32 +01:00
- [oauth2-client](../oauth2-client/README.md)
## Used by
2023-06-29 18:56:46 +02:00
[gitea](../gitea/README.md)
2023-02-14 14:43:41 +01:00
[All applications services for this dataset.](../README.md)