2022-07-25 23:24:03 +02:00
<!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
It shall NOT be edited by hand.
-->
2022-01-07 00:43:10 +01:00
# Gemserv pour YunoHost
2022-07-25 23:24:03 +02:00
[![Niveau d'intégration ](https://dash.yunohost.org/integration/gemserv.svg )](https://dash.yunohost.org/appci/app/gemserv) ![Statut du fonctionnement ](https://ci-apps.yunohost.org/ci/badges/gemserv.status.svg ) ![Statut de maintenance ](https://ci-apps.yunohost.org/ci/badges/gemserv.maintain.svg )
2022-01-07 00:43:10 +01:00
[![Installer Gemserv avec YunoHost ](https://install-app.yunohost.org/install-with-yunohost.svg )](https://install-app.yunohost.org/?app=gemserv)
*[Read this readme in english.](./README.md)*
> *Ce package vous permet d'installer Gemserv rapidement et simplement sur un serveur YunoHost.
Si vous n'avez pas YunoHost, regardez [ici ](https://yunohost.org/#/install ) pour savoir comment l'installer et en profiter.*
## Vue d'ensemble
2022-08-15 01:16:28 +02:00
Un serveur Gemini écrit en rust.
2022-01-07 00:43:10 +01:00
2022-08-15 01:16:28 +02:00
### Caractéristiques
2022-05-07 23:13:33 +02:00
2022-08-15 01:16:28 +02:00
- Hôtes virtuels
2022-05-07 23:13:33 +02:00
- CGI
2022-08-15 01:16:28 +02:00
- Dossiers utilisateurs
2022-05-07 23:13:33 +02:00
- Reverse proxy
2022-08-15 01:16:28 +02:00
- Redirection
2022-05-07 23:13:33 +02:00
- SCGI
2022-08-15 01:16:28 +02:00
- Rechargement de la configuration sur SIGHUP
2022-05-07 23:13:33 +02:00
2022-01-07 00:43:10 +01:00
2022-10-05 21:43:06 +02:00
**Version incluse :** 0.6.6~ynh5
2022-08-15 01:09:52 +02:00
2022-01-07 00:43:10 +01:00
## Avertissements / informations importantes
2022-08-15 01:16:28 +02:00
Gemserv utilise le port TCP 1965, vous ne pourrez donc l'utiliser pour autre chose.
2022-01-07 00:43:10 +01:00
2022-08-15 01:16:28 +02:00
Pour ajouter une capsule, créer le fichier de configuration `/etc/gemserv/config.d/example.toml` avec le contenu suivant:
2022-05-07 23:13:33 +02:00
``` toml
2022-01-07 00:43:10 +01:00
[[server]]
2022-05-07 23:13:33 +02:00
hostname = "yourdomain.org"
2022-08-15 01:16:28 +02:00
dir = "/opt/yunohost/gemserv"
2022-05-07 23:13:33 +02:00
key = "/etc/yunohost/certs/yourdomain.org/key.pem"
cert = "/etc/yunohost/certs/yourdomain.org/crt.pem"
2022-01-07 00:43:10 +01:00
# index is optional but defaults to index.gemini. The server will serve files
# ending in gemini or gmi.
index = "index.gmi"
# lang is optional
lang = "en"
# cgi is optional bool
cgi = true
# cgipath is optional and only checked if cgi is true. It restricts cgi to only
# this directory.
cgipath = "/path/to/cgi-bin/"
# scgi is optional
scgi = { "/scgi" = "localhost:4000" }
# cgienv is optional
cgienv = { "GIT_PROJECT_ROOT" = "/srv/git" }
2022-05-07 23:17:35 +02:00
# usrdir is optional. it'll look in each user's ~/public_gemini
2022-01-07 00:43:10 +01:00
usrdir = true
# proxy is optional
# path is what comes after the hostname e.g. example.com/path
proxy = { path = "localhost:1966" }
# proxy_all is optional
# It will send all requests to the specified server. It also supports streamming.
2022-05-07 23:17:35 +02:00
proxy_all = "localhost:1967"
2022-01-07 00:43:10 +01:00
# redirect is optional
redirect = { "/redirect" = "/", "/newdomain" = "gemini://example.net" }
```
2022-05-07 23:13:33 +02:00
2022-01-07 00:43:10 +01:00
## Documentations et ressources
2022-07-25 23:24:03 +02:00
* Dépôt de code officiel de l'app : < https: // git . sr . ht /~ int80h / gemserv >
* Documentation YunoHost pour cette app : < https: // yunohost . org / app_gemserv >
* Signaler un bug : < https: // github . com / YunoHost-Apps / gemserv_ynh / issues >
2022-01-07 00:43:10 +01:00
## Informations pour les développeurs
Merci de faire vos pull request sur la [branche testing ](https://github.com/YunoHost-Apps/gemserv_ynh/tree/testing ).
Pour essayer la branche testing, procédez comme suit.
2022-07-25 23:24:03 +02:00
``` bash
2022-01-07 00:43:10 +01:00
sudo yunohost app install https://github.com/YunoHost-Apps/gemserv_ynh/tree/testing --debug
ou
sudo yunohost app upgrade gemserv -u https://github.com/YunoHost-Apps/gemserv_ynh/tree/testing --debug
```
2022-07-25 23:24:03 +02:00
**Plus d'infos sur le packaging d'applications :** < https: / / yunohost . org / packaging_apps >