Auto-update README

README.md

@@ -1,74 +1,78 @@
-# Packaging your an app, starting from this example
-
-- Copy this app before working on it, using the ['Use this template'](https://github.com/YunoHost/example_ynh/generate) button on the Github repo.
-- Edit the `manifest.json` with app specific info.
-- Edit the `install`, `upgrade`, `remove`, `backup`, and `restore` scripts, and any relevant conf files in `conf/`.
-  - Using the [script helpers documentation.](https://yunohost.org/packaging_apps_helpers)
-- Add a `LICENSE` file for the package.
-- Edit `doc/DISCLAIMER*.md`
-- The `README.md` files are to be automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
-
----
 <!--
 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.
 -->
 
-# Example app for YunoHost
+# Gemserv for YunoHost
 
-[![Integration level](https://dash.yunohost.org/integration/example.svg)](https://dash.yunohost.org/appci/app/example) ![](https://ci-apps.yunohost.org/ci/badges/example.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/example.maintain.svg)  
+[![Integration level](https://dash.yunohost.org/integration/gemserv.svg)](https://dash.yunohost.org/appci/app/gemserv) ![](https://ci-apps.yunohost.org/ci/badges/gemserv.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/gemserv.maintain.svg)  
-[![Install Example app with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=example)
+[![Install Gemserv with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=gemserv)
 
 *[Lire ce readme en français.](./README_fr.md)*
 
-> *This package allows you to install Example app quickly and simply on a YunoHost server.
+> *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
 
-Explain in *a few (10~15) words* the purpose of the app or what it actually does (it is meant to give a rough idea to users browsing a catalog of 100+ apps)
+A gemini server written in rust.
 
-**Shipped version:** 1.0~ynh1
+**Shipped version:** 0.4.4~ynh1
 
-**Demo:** https://demo.example.com
 
-## Screenshots
-
-![](./doc/screenshots/example.jpg)
 
 ## Disclaimers / important information
 
-* Any known limitations, constrains or stuff not working, such as (but not limited to):
-    * requiring a full dedicated domain ?
-    * architectures not supported ?
-    * not-working single-sign on or LDAP integration ?
-    * the app requires an important amount of RAM / disk / .. to install or to work properly
-    * etc...
-
 * Other infos that people should be aware of, such as:
-    * any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...)
+    * Redirect TCP/1965 port to the server
-    * how to configure / administrate the application if it ain't obvious
+    * To add a gemini capsule, create a /etc/gemserv/config.d/example.toml 
-    * upgrade process / specificities / things to be aware of ?
-    * security considerations ?
 
+```
+[[server]]
+hostname = "youdomain.org"
+dir = "/path/to/serv/"
+key = "/etc/yunohost/certs/youdomain.org/key.pem"
+cert = "/etc/yunohost/certs/youdomain.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 /home/usr/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
 
-* Official app website: https://example.com
+* Upstream app code repository: https://codeberg.org/Valenoern/gemserv
-* Official user documentation: https://yunohost.org/apps
+* YunoHost documentation for this app: https://yunohost.org/app_gemserv
-* Official admin documentation: https://yunohost.org/packaging_apps
+* Report a bug: https://github.com/YunoHost-Apps/gemserv_ynh/issues
-* Upstream app code repository: https://some.forge.com/example/example
-* YunoHost documentation for this app: https://yunohost.org/app_example
-* Report a bug: https://github.com/YunoHost-Apps/example_ynh/issues
 
 ## Developer info
 
-Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/example_ynh/tree/testing).
+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.
 ```
-sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug
+sudo yunohost app install https://github.com/YunoHost-Apps/gemserv_ynh/tree/testing --debug
 or
-sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug
+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

README_fr.md

@@ -0,0 +1,74 @@
+# Gemserv pour YunoHost
+
+[![Niveau d'intégration](https://dash.yunohost.org/integration/gemserv.svg)](https://dash.yunohost.org/appci/app/gemserv) ![](https://ci-apps.yunohost.org/ci/badges/gemserv.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/gemserv.maintain.svg)  
+[![Installer Gemserv avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=gemserv)
+
+*[Read this readme in english.](./README.md)*
+*[Lire ce readme en français.](./README_fr.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
+
+
+
+**Version incluse :** 0.4.4~ynh1
+
+
+
+## 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 
+
+```
+[[server]]
+hostname = "youdomain.org"
+dir = "/path/to/serv/"
+key = "/etc/yunohost/certs/youdomain.org/key.pem"
+cert = "/etc/yunohost/certs/youdomain.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 /home/usr/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://codeberg.org/Valenoern/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.
+```
+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