From b8166aa71069c148253742da9589d74023fdd533 Mon Sep 17 00:00:00 2001 From: Thibaud WOJTOWICZ Date: Mon, 15 Aug 2022 00:28:51 +0200 Subject: [PATCH 1/5] improved readability of /etc/gemserv/config.toml --- conf/server.toml | 1 + 1 file changed, 1 insertion(+) diff --git a/conf/server.toml b/conf/server.toml index 17a9b9a..5b75b28 100644 --- a/conf/server.toml +++ b/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" + From bfd74d334f9f8a61df9b6c65fe895033e3d2ea67 Mon Sep 17 00:00:00 2001 From: Thibaud WOJTOWICZ Date: Mon, 15 Aug 2022 00:28:55 +0200 Subject: [PATCH 2/5] improve readme and readme_fr --- README.md | 2 +- README_fr.md | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 961b562..5e66080 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,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/README_fr.md b/README_fr.md index 9ef9138..a8fc722 100644 --- a/README_fr.md +++ b/README_fr.md @@ -31,14 +31,14 @@ A gemini server written in rust. **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 From 9f12f4d5509c063f20cd4ff7c0637258c0f2ced2 Mon Sep 17 00:00:00 2001 From: yunohost-bot Date: Sun, 14 Aug 2022 23:09:52 +0000 Subject: [PATCH 3/5] Auto-update README --- README.md | 3 ++- README_fr.md | 9 +++++---- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 5e66080..411cd91 100644 --- a/README.md +++ b/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 = "/opt/yunohost/gemserv" +dir = "/path/to/serv" 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/README_fr.md b/README_fr.md index a8fc722..cc1c244 100644 --- a/README_fr.md +++ b/README_fr.md @@ -28,17 +28,18 @@ A gemini server written in rust. - Reload config on SIGHUP -**Version incluse :** 0.6.6~ynh4 +**Version incluse :** 0.6.6~ynh4 + ## Avertissements / informations importantes -Gemserv utilise le port TCP 1965, vous ne pourrez donc l'utiliser pour autre chose. +Please note that Gemserv uses the TCP port 1965, so you can't use it for anything else. -Pour ajouter une capsule, créer le fichier de configuration `/etc/gemserv/config.d/example.toml` avec le contenu suivant: +To add a gemini capsule, create a `/etc/gemserv/config.d/example.toml` file as following: ``` toml [[server]] hostname = "yourdomain.org" -dir = "/opt/yunohost/gemserv" +dir = "/path/to/serv" 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 From 34e04d7aa75241ddd35b108cd17f2c5a32e0f8c9 Mon Sep 17 00:00:00 2001 From: yalh76 Date: Mon, 15 Aug 2022 01:16:23 +0200 Subject: [PATCH 4/5] 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" } +``` From c55119d2f14257f33fb52ee3a629e9995b5afe35 Mon Sep 17 00:00:00 2001 From: yunohost-bot Date: Sun, 14 Aug 2022 23:16:28 +0000 Subject: [PATCH 5/5] Auto-update README --- README.md | 2 +- README_fr.md | 18 +++++++++--------- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 411cd91..02a3149 100644 --- a/README.md +++ b/README.md @@ -39,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 diff --git a/README_fr.md b/README_fr.md index cc1c244..120171c 100644 --- a/README_fr.md +++ b/README_fr.md @@ -15,31 +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 ## 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