Merge pull request #22 from YunoHost-Apps/testing

Improve Readme

README.md

@@ -29,6 +29,7 @@ A gemini server written in rust.
 
 
 **Shipped version:** 0.6.6~ynh4
+
 ## Disclaimers / important information
 
 Please note that Gemserv uses the TCP port 1965, so you can't use it for anything else.
@@ -38,7 +39,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

README_fr.md

@@ -15,30 +15,31 @@ Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour
 
 ## Vue d'ensemble
 
-A gemini server written in rust.
+Un serveur Gemini écrit en rust.
 
-### Features
+### Caractéristiques
 
-- Vhosts
+- Hôtes virtuels
 - CGI
-- User directories
+- Dossiers utilisateurs
 - Reverse proxy
-- Redirect
+- Redirection
 - SCGI
-- Reload config on SIGHUP
+- Rechargement de la configuration sur SIGHUP
 
 
-**Version incluse :** 0.6.6~ynh4
+**Version incluse :** 0.6.6~ynh4
+
 ## Avertissements / informations importantes
 
-Please note that Gemserv uses the TCP port 1965, so you can't use it for anything else.
+Gemserv utilise le port TCP 1965, vous ne pourrez donc l'utiliser pour autre chose.
 
-To add a gemini capsule, create a `/etc/gemserv/config.d/example.toml` file as following:
+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 = "/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

conf/server.toml

@@ -11,3 +11,4 @@ interface = [ "[::]:1965" ]
 # are error, warn, and info. If error is set it will only show error. If warn
 # is set it will show error and warn. Info shows all three.
 log = "info"
+

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

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

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" }
+```