YunoHost-Apps/gemserv_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/gemserv_ynh.git synced 2024-09-03 18:36:27 +02:00
Code Issues Activity Actions

enhanced description & disclaimer

Browse source
This commit is contained in:
OniriCorpe 2022-05-07 23:13:33 +02:00
parent 0c4dafd1c7
commit fac8c577c1
4 changed files with 57 additions and 25 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
README.md
View file

@ -17,6 +17,16 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in
A gemini server written in rust. A gemini server written in rust.
### Features
- Vhosts
- CGI
- User directories
- Reverse proxy
- Redirect
- SCGI
- Reload config on SIGHUP
**Shipped version:** 0.6.6~ynh1 **Shipped version:** 0.6.6~ynh1
@ -24,16 +34,16 @@ A gemini server written in rust.
## Disclaimers / important information ## Disclaimers / important information
* Other infos that people should be aware of, such as: Please note that Gemserv uses the TCP port 1965, so you can't use it for anything else.
* Redirect TCP/1965 port to the server
* To add a gemini capsule, create a /etc/gemserv/config.d/example.toml
``` To add a gemini capsule, create a `/etc/gemserv/config.d/example.toml` file as following:
``` toml
[[server]] [[server]]
hostname = "youdomain.org" hostname = "yourdomain.org"
dir = "/path/to/serv/" dir = "/path/to/serv"
key = "/etc/yunohost/certs/youdomain.org/key.pem" key = "/etc/yunohost/certs/yourdomain.org/key.pem"
cert = "/etc/yunohost/certs/youdomain.org/crt.pem" cert = "/etc/yunohost/certs/yourdomain.org/crt.pem"
# index is optional but defaults to index.gemini. The server will serve files # index is optional but defaults to index.gemini. The server will serve files
# ending in gemini or gmi. # ending in gemini or gmi.
index = "index.gmi" index = "index.gmi"
@ -59,6 +69,7 @@ proxy_all = localhost:1967
# redirect is optional # redirect is optional
redirect = { "/redirect" = "/", "/newdomain" = "gemini://example.net" } redirect = { "/redirect" = "/", "/newdomain" = "gemini://example.net" }
``` ```
## Documentation and resources ## Documentation and resources
* Upstream app code repository: https://git.sr.ht/~int80h/gemserv * Upstream app code repository: https://git.sr.ht/~int80h/gemserv

27
README_fr.md
View file

@ -13,6 +13,16 @@ Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour
A gemini server written in rust. A gemini server written in rust.
### Features
- Vhosts
- CGI
- User directories
- Reverse proxy
- Redirect
- SCGI
- Reload config on SIGHUP
**Version incluse :** 0.6.6~ynh1 **Version incluse :** 0.6.6~ynh1
@ -20,16 +30,16 @@ A gemini server written in rust.
## Avertissements / informations importantes ## Avertissements / informations importantes
* Other infos that people should be aware of, such as: Please note that Gemserv uses the TCP port 1965, so you can't use it for anything else.
* Redirect TCP/1965 port to the server
* To add a gemini capsule, create a /etc/gemserv/config.d/example.toml
``` To add a gemini capsule, create a `/etc/gemserv/config.d/example.toml` file as following:
``` toml
[[server]] [[server]]
hostname = "youdomain.org" hostname = "yourdomain.org"
dir = "/path/to/serv/" dir = "/path/to/serv"
key = "/etc/yunohost/certs/youdomain.org/key.pem" key = "/etc/yunohost/certs/yourdomain.org/key.pem"
cert = "/etc/yunohost/certs/youdomain.org/crt.pem" cert = "/etc/yunohost/certs/yourdomain.org/crt.pem"
# index is optional but defaults to index.gemini. The server will serve files # index is optional but defaults to index.gemini. The server will serve files
# ending in gemini or gmi. # ending in gemini or gmi.
index = "index.gmi" index = "index.gmi"
@ -55,6 +65,7 @@ proxy_all = localhost:1967
# redirect is optional # redirect is optional
redirect = { "/redirect" = "/", "/newdomain" = "gemini://example.net" } redirect = { "/redirect" = "/", "/newdomain" = "gemini://example.net" }
``` ```
## Documentations et ressources ## Documentations et ressources
* Dépôt de code officiel de l'app : https://git.sr.ht/~int80h/gemserv * Dépôt de code officiel de l'app : https://git.sr.ht/~int80h/gemserv

10
doc/DESCRIPTION.md
View file

@ -1 +1,11 @@
A gemini server written in rust. A gemini server written in rust.
### Features
- Vhosts
- CGI
- User directories
- Reverse proxy
- Redirect
- SCGI
- Reload config on SIGHUP

18
doc/DISCLAIMER.md
View file

@ -1,13 +1,13 @@
* Other infos that people should be aware of, such as: Please note that Gemserv uses the TCP port 1965, so you can't use it for anything else.
* Redirect TCP/1965 port to the server
* To add a gemini capsule, create a /etc/gemserv/config.d/example.toml
``` To add a gemini capsule, create a `/etc/gemserv/config.d/example.toml` file as following:
``` toml
[[server]] [[server]]
hostname = "youdomain.org" hostname = "yourdomain.org"
dir = "/path/to/serv/" dir = "/path/to/serv"
key = "/etc/yunohost/certs/youdomain.org/key.pem" key = "/etc/yunohost/certs/yourdomain.org/key.pem"
cert = "/etc/yunohost/certs/youdomain.org/crt.pem" cert = "/etc/yunohost/certs/yourdomain.org/crt.pem"
# index is optional but defaults to index.gemini. The server will serve files # index is optional but defaults to index.gemini. The server will serve files
# ending in gemini or gmi. # ending in gemini or gmi.
index = "index.gmi" index = "index.gmi"
@ -32,4 +32,4 @@ proxy = { path = "localhost:1966" }
proxy_all = localhost:1967 proxy_all = localhost:1967
# redirect is optional # redirect is optional
redirect = { "/redirect" = "/", "/newdomain" = "gemini://example.net" } redirect = { "/redirect" = "/", "/newdomain" = "gemini://example.net" }
``` ```