mirror of
https://github.com/YunoHost-Apps/gemserv_ynh.git
synced 2024-09-03 18:36:27 +02:00
88 lines
3.1 KiB
Markdown
88 lines
3.1 KiB
Markdown
<!--
|
||
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
|
||
It shall NOT be edited by hand.
|
||
-->
|
||
|
||
# Gemserv pour YunoHost
|
||
|
||
[](https://dash.yunohost.org/appci/app/gemserv)  
|
||
[](https://install-app.yunohost.org/?app=gemserv)
|
||
|
||
*[Read this readme in english.](./README.md)*
|
||
|
||
> *Ce package vous permet d'installer Gemserv rapidement et simplement sur un serveur YunoHost.
|
||
Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
|
||
|
||
## Vue d'ensemble
|
||
|
||
A gemini server written in rust.
|
||
|
||
### Features
|
||
|
||
- Vhosts
|
||
- CGI
|
||
- User directories
|
||
- Reverse proxy
|
||
- Redirect
|
||
- SCGI
|
||
- Reload config on SIGHUP
|
||
|
||
|
||
**Version incluse :** 0.6.6~ynh2
|
||
## Avertissements / informations importantes
|
||
|
||
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 = "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"
|
||
# 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" }
|
||
```
|
||
|
||
## Documentations et ressources
|
||
|
||
* Dépôt de code officiel de l'app : <https://git.sr.ht/~int80h/gemserv>
|
||
* Documentation YunoHost pour cette app : <https://yunohost.org/app_gemserv>
|
||
* Signaler un bug : <https://github.com/YunoHost-Apps/gemserv_ynh/issues>
|
||
|
||
## Informations pour les développeurs
|
||
|
||
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/gemserv_ynh/tree/testing).
|
||
|
||
Pour essayer la branche testing, procédez comme suit.
|
||
|
||
``` bash
|
||
sudo yunohost app install https://github.com/YunoHost-Apps/gemserv_ynh/tree/testing --debug
|
||
ou
|
||
sudo yunohost app upgrade gemserv -u https://github.com/YunoHost-Apps/gemserv_ynh/tree/testing --debug
|
||
```
|
||
|
||
**Plus d'infos sur le packaging d'applications :** <https://yunohost.org/packaging_apps>
|