mirror of
https://github.com/YunoHost-Apps/gemserv_ynh.git
synced 2024-09-03 18:36:27 +02:00
enhanced description & disclaimer
This commit is contained in:
OniriCorpe
parent
0c4dafd1c7
commit
fac8c577c1
4 changed files with 57 additions and 25 deletions
27
README.md
27
README.md
|
|
@ -17,6 +17,16 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in
|
|||
|
||||
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
|
||||
|
||||
|
|
@ -24,16 +34,16 @@ A gemini server written in rust.
|
|||
|
||||
## Disclaimers / important information
|
||||
|
||||
* Other infos that people should be aware of, such as:
|
||||
* Redirect TCP/1965 port to the server
|
||||
* To add a gemini capsule, create a /etc/gemserv/config.d/example.toml
|
||||
Please note that Gemserv uses the TCP port 1965, so you can't use it for anything else.
|
||||
|
||||
```
|
||||
To add a gemini capsule, create a `/etc/gemserv/config.d/example.toml` file as following:
|
||||
|
||||
``` toml
|
||||
[[server]]
|
||||
hostname = "youdomain.org"
|
||||
dir = "/path/to/serv/"
|
||||
key = "/etc/yunohost/certs/youdomain.org/key.pem"
|
||||
cert = "/etc/yunohost/certs/youdomain.org/crt.pem"
|
||||
hostname = "yourdomain.org"
|
||||
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
|
||||
# ending in gemini or gmi.
|
||||
index = "index.gmi"
|
||||
|
|
@ -59,6 +69,7 @@ proxy_all = localhost:1967
|
|||
# redirect is optional
|
||||
redirect = { "/redirect" = "/", "/newdomain" = "gemini://example.net" }
|
||||
```
|
||||
|
||||
## Documentation and resources
|
||||
|
||||
* Upstream app code repository: https://git.sr.ht/~int80h/gemserv
|
||||
|
|
|
|||
27
README_fr.md
27
README_fr.md
|
|
@ -13,6 +13,16 @@ Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour
|
|||
|
||||
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
|
||||
|
||||
|
|
@ -20,16 +30,16 @@ A gemini server written in rust.
|
|||
|
||||
## Avertissements / informations importantes
|
||||
|
||||
* Other infos that people should be aware of, such as:
|
||||
* Redirect TCP/1965 port to the server
|
||||
* To add a gemini capsule, create a /etc/gemserv/config.d/example.toml
|
||||
Please note that Gemserv uses the TCP port 1965, so you can't use it for anything else.
|
||||
|
||||
```
|
||||
To add a gemini capsule, create a `/etc/gemserv/config.d/example.toml` file as following:
|
||||
|
||||
``` toml
|
||||
[[server]]
|
||||
hostname = "youdomain.org"
|
||||
dir = "/path/to/serv/"
|
||||
key = "/etc/yunohost/certs/youdomain.org/key.pem"
|
||||
cert = "/etc/yunohost/certs/youdomain.org/crt.pem"
|
||||
hostname = "yourdomain.org"
|
||||
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
|
||||
# ending in gemini or gmi.
|
||||
index = "index.gmi"
|
||||
|
|
@ -55,6 +65,7 @@ proxy_all = localhost:1967
|
|||
# redirect is optional
|
||||
redirect = { "/redirect" = "/", "/newdomain" = "gemini://example.net" }
|
||||
```
|
||||
|
||||
## Documentations et ressources
|
||||
|
||||
* Dépôt de code officiel de l'app : https://git.sr.ht/~int80h/gemserv
|
||||
|
|
|
|||
|
|
@ -1 +1,11 @@
|
|||
A gemini server written in rust.
|
||||
|
||||
### Features
|
||||
|
||||
- Vhosts
|
||||
- CGI
|
||||
- User directories
|
||||
- Reverse proxy
|
||||
- Redirect
|
||||
- SCGI
|
||||
- Reload config on SIGHUP
|
||||
|
|
|
|||
|
|
@ -1,13 +1,13 @@
|
|||
* Other infos that people should be aware of, such as:
|
||||
* Redirect TCP/1965 port to the server
|
||||
* To add a gemini capsule, create a /etc/gemserv/config.d/example.toml
|
||||
Please note that Gemserv uses the TCP port 1965, so you can't use it for anything else.
|
||||
|
||||
```
|
||||
To add a gemini capsule, create a `/etc/gemserv/config.d/example.toml` file as following:
|
||||
|
||||
``` toml
|
||||
[[server]]
|
||||
hostname = "youdomain.org"
|
||||
dir = "/path/to/serv/"
|
||||
key = "/etc/yunohost/certs/youdomain.org/key.pem"
|
||||
cert = "/etc/yunohost/certs/youdomain.org/crt.pem"
|
||||
hostname = "yourdomain.org"
|
||||
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
|
||||
# ending in gemini or gmi.
|
||||
index = "index.gmi"
|
||||
|
|
@ -32,4 +32,4 @@ proxy = { path = "localhost:1966" }
|
|||
proxy_all = localhost:1967
|
||||
# redirect is optional
|
||||
redirect = { "/redirect" = "/", "/newdomain" = "gemini://example.net" }
|
||||
```
|
||||
```
|
||||
|
|
|
|||
Loading…
Reference in a new issue