musala/README.md at cddf27f99a365b065300a07bcb2a47e8bb2acec0

glenux/musala

Fork 0

Glenn Y. Rolland cddf27f99a

Update README.md

2020-06-02 16:57:49 +02:00

3.4 KiB

Raw Blame History

Every morning, get your task lists by email, WhatsApp or SMS.

Note: musala means work, occupation in Lingala

Roadmap

Task sources:

✔️ Trello
❌ Nextcloud Deck (not yet) API Reference
❌ Libreboard (not yet)
❌ Github Projects (not yet)

Delivery via:

✔️ E-mail
❌ Whatsapp
❌ SMS

Installation

With go

Make sure you have Go installed, then type:

$ go install github.com/glenux/musala-push/...

It will install Musala Mail binary in $GOPATH/bin

With docker

Make sure you have Docker installed, then type:

$ docker build -t musala-push -f docker/Dockerfile .

Usage

Creating a developper account

Create a Trello account on https://trello.com
Check your mailbox and confirm your email
Enable developper account on https://trello.com/app-key
Get an developer API KEY

Getting a Trello TOKEN

Open the following URL in your web browser and authenticate yourself. That will give you the TRELLO_TOKEN that will be needed in the next step.

https://trello.com/1/authorize?expiration=never&scope=read,write,account&response_type=token&name=Musala%20Mail&key=YOUR-API-KEY

Using the binary

Prepare your environment with the following variables

EMAIL_FROM:    no-reply@example.com
EMAIL_TO:      me@example.com
EMAIL_SUBJECT: "Daily mail for YYYYYY"
TRELLO_URL:    https://trello.com/b/xxxxx/yyyy
TRELLO_TOKEN:  xxxxxxxxxxxxxx
SMTP_HOSTNAME: smtp.example.com
SMTP_USERNAME: foobar@example.com
SMTP_PASSWORD: securefoobar
SMTP_PORT:   587
# SMTP_AUTH_TYPE accepts either "none", "plain" or "login"
SMTP_AUTH_TYPE: plain 
# SMTP_SECURITY_TYPE accepts either "none", "tls" or "starttls"
SMTP_SECURITY_TYPE: tls

Then run the program:

$ $GOPATH/bin/musala-push

Using with docker

$ docker build -f docker/Dockerfile -t musala-push .
$ docker run  \
    -e EMAIL_FROM=
    -e EMAIL_TO=
    -e EMAIL_SUBJECT=
    -e EMAIL_FROM=
    -e EMAIL_TO=
    -e EMAIL_SUBJECT=
    -v /var/lib/musala-push/musala-push.cron:/app/musala-push.cron \
    -it musala-push:latest

Contributing

Fork it ( http://github.com/glenux/musala-push/fork )
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Create new Pull Request

Credits

Glenn Y. ROLLAND - author & maintainer:
You? Fork the project and become a contributor!

Got questions? Need help? Tweet at @glenux

3.4 KiB Raw Blame History