Commit 20dcaded authored by goofy-bz's avatar goofy-bz
Browse files

Update README.md

parent 0339f97f
......@@ -2,7 +2,7 @@
This program creates an HTML statistics page from [`vrms`](https://packages.debian.org/search?suite=default&section=all&arch=any&searchon=names&keywords=vrms) mails.
This programm connects to an IMAP account, checks the new mails, parse them and create an HTML output in `public` folder.
This programm connects to an IMAP account, checks the new mails, parses them and creates an HTML output in `public` folder.
## How to get `vrms` mails?
......@@ -38,9 +38,9 @@ git clone https://framagit.org/framasoft/vrms
### Configuration
The configuration is provided by environnement variables:
The configuration is provided by environment variables:
- `USER`: the user for the IMAP connexion (mandatory)
- `USER`: the user for the IMAP connection (mandatory)
- `PASSWORD`: his password (mandatory)
- `SERVER`: the IMAP server address (mandatory)
- `THEME`: the theme you want to use (optional, default is `default`)
......@@ -55,4 +55,4 @@ USER=foo@bar.org PASSWORD=s3cr3t SERVER=imap.bar.org ./vrms-web.pl6
## How to use it with Gitlab CI and Gitlab Pages?
Fork https://framagit.org/framasoft/vrms. Set the environnement variables in the project configuration. Run a pipeline. That's all.
Fork https://framagit.org/framasoft/vrms. Set the environment variables in the project configuration. Run a pipeline. That's all.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment