From 34e04d7aa75241ddd35b108cd17f2c5a32e0f8c9 Mon Sep 17 00:00:00 2001 From: yalh76 Date: Mon, 15 Aug 2022 01:16:23 +0200 Subject: [PATCH] Improve readmes --- doc/DESCRIPTION_fr.md | 11 +++++++++++ doc/DISCLAIMER.md | 2 +- doc/DISCLAIMER_fr.md | 35 +++++++++++++++++++++++++++++++++++ 3 files changed, 47 insertions(+), 1 deletion(-) create mode 100644 doc/DESCRIPTION_fr.md create mode 100644 doc/DISCLAIMER_fr.md diff --git a/doc/DESCRIPTION_fr.md b/doc/DESCRIPTION_fr.md new file mode 100644 index 0000000..b1d6f2b --- /dev/null +++ b/doc/DESCRIPTION_fr.md @@ -0,0 +1,11 @@ +Un serveur Gemini écrit en rust. + +### Caractéristiques + +- Hôtes virtuels +- CGI +- Dossiers utilisateurs +- Reverse proxy +- Redirection +- SCGI +- Rechargement de la configuration sur SIGHUP diff --git a/doc/DISCLAIMER.md b/doc/DISCLAIMER.md index af98e68..7678dbd 100644 --- a/doc/DISCLAIMER.md +++ b/doc/DISCLAIMER.md @@ -5,7 +5,7 @@ To add a gemini capsule, create a `/etc/gemserv/config.d/example.toml` file as f ``` toml [[server]] hostname = "yourdomain.org" -dir = "/path/to/serv" +dir = "/opt/yunohost/gemserv" key = "/etc/yunohost/certs/yourdomain.org/key.pem" cert = "/etc/yunohost/certs/yourdomain.org/crt.pem" # index is optional but defaults to index.gemini. The server will serve files diff --git a/doc/DISCLAIMER_fr.md b/doc/DISCLAIMER_fr.md new file mode 100644 index 0000000..08ac910 --- /dev/null +++ b/doc/DISCLAIMER_fr.md @@ -0,0 +1,35 @@ +Gemserv utilise le port TCP 1965, vous ne pourrez donc l'utiliser pour autre chose. + +Pour ajouter une capsule, créer le fichier de configuration `/etc/gemserv/config.d/example.toml` avec le contenu suivant: + +``` toml +[[server]] +hostname = "yourdomain.org" +dir = "/opt/yunohost/gemserv" +key = "/etc/yunohost/certs/yourdomain.org/key.pem" +cert = "/etc/yunohost/certs/yourdomain.org/crt.pem" +# 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" } +# usrdir is optional. it'll look in each user's ~/public_gemini +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. +proxy_all = "localhost:1967" +# redirect is optional +redirect = { "/redirect" = "/", "/newdomain" = "gemini://example.net" } +```