Verified Commit 78226592 authored by Luc Didry's avatar Luc Didry
Browse files

Add README

parent 81e78fde
# vRMS
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.
## How to use it on your computer?
### Installation
Install Perl6 and some modules:
```
apt-get install -y git build-essential libssl-dev
git clone https://github.com/tadzik/rakudobrew ~/.rakudobrew
echo 'PATH=~/.rakudobrew/bin:$PATH' > ~/.bashrc
. ~/.bashrc
rakudobrew build moar
rakudobrew build zef
zef install --/test Template::Mojo File::Directory::Tree
zef install --/test --deps-only Net::IMAP
```
Install vRMS:
```
git clone https://framagit.org/framasoft/vrms
```
### Configuration
The configuration is provided by environnement variables:
- `USER`: the user for the IMAP connexion (mandatory)
- `PASSWORD`: his password (mandatory)
- `SERVER`: the IMAP server address (mandatory)
- `THEME`: the theme you want to use (optional, default is `default`)
- `DEV`: set to 1 if you want to fetch all mails, not only the unread ones (optional, no default)
### Use
```
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.
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