mirror of
https://github.com/YunoHost-Apps/gemserv_ynh.git
synced 2024-09-03 18:36:27 +02:00
89 lines
3 KiB
Markdown
89 lines
3 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 for YunoHost
|
|
|
|
[](https://dash.yunohost.org/appci/app/gemserv)  
|
|
|
|
[](https://install-app.yunohost.org/?app=gemserv)
|
|
|
|
*[Lire ce readme en français.](./README_fr.md)*
|
|
|
|
> *This package allows you to install Gemserv quickly and simply on a YunoHost server.
|
|
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
|
|
|
|
## Overview
|
|
|
|
A gemini server written in rust.
|
|
|
|
### Features
|
|
|
|
- Vhosts
|
|
- CGI
|
|
- User directories
|
|
- Reverse proxy
|
|
- Redirect
|
|
- SCGI
|
|
- Reload config on SIGHUP
|
|
|
|
|
|
**Shipped version:** 0.6.6~ynh6
|
|
## Disclaimers / important information
|
|
|
|
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 = "/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" }
|
|
```
|
|
|
|
## Documentation and resources
|
|
|
|
* Upstream app code repository: <https://git.sr.ht/~int80h/gemserv>
|
|
* YunoHost Store: <https://apps.yunohost.org/app/gemserv>
|
|
* Report a bug: <https://github.com/YunoHost-Apps/gemserv_ynh/issues>
|
|
|
|
## Developer info
|
|
|
|
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/gemserv_ynh/tree/testing).
|
|
|
|
To try the testing branch, please proceed like that.
|
|
|
|
``` bash
|
|
sudo yunohost app install https://github.com/YunoHost-Apps/gemserv_ynh/tree/testing --debug
|
|
or
|
|
sudo yunohost app upgrade gemserv -u https://github.com/YunoHost-Apps/gemserv_ynh/tree/testing --debug
|
|
```
|
|
|
|
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
|