🟢 Stable | Every morning, get your task lists by email, WhatsApp or SMS.
Find a file
2020-06-02 17:04:00 +02:00
.github/workflows Create go.yml 2020-01-25 23:53:59 +01:00
cmd/musala-mail Update project name in sources 2019-09-04 17:09:23 +02:00
doc Add logo 2020-05-18 00:44:26 +02:00
docker Update project name in sources 2019-09-04 17:09:23 +02:00
templates Update project name in sources 2019-09-04 17:09:23 +02:00
tmp Update email mockup & ignore tmp dir 2018-09-11 17:21:55 +02:00
.dockerignore Prepare docker build 2019-09-04 09:06:05 +02:00
.gitignore Update project name in sources 2019-09-04 17:09:23 +02:00
contrib-trello Update project name in sources 2019-09-04 17:09:23 +02:00
docker-compose.example.yml Update project name in sources 2019-09-04 17:09:23 +02:00
go.mod Update project name in sources 2019-09-04 17:09:23 +02:00
go.sum Update dependencies 2019-09-04 09:27:56 +02:00
Jenkinsfile Added Jenkinsfile 2019-10-31 17:19:52 +01:00
LICENSE.txt Improve documentation 2018-08-22 20:02:00 +02:00
Makefile Update project name in sources 2019-09-04 17:09:23 +02:00
README.md Update README.md 2020-06-02 17:04:00 +02:00

Musala

GitHub license Donate on patreon

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
  • Wekan (not yet) - API Reference
  • Libreboard (not yet)
  • Github Projects (not yet)

Delivery via:

  • ✔️ E-mail
  • Whatsapp
  • Telegram
  • IRC
  • SMS

Installation

From sources

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

  1. Create a Trello account on https://trello.com
  2. Check your mailbox and confirm your email
  3. Enable developper account on https://trello.com/app-key
  4. 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

  1. Fork it ( http://github.com/glenux/musala-push/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. 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

License

Musala Push is Copyright © 2018-2020 Glenn ROLLAND. It is free software, and may be redistributed under the terms specified in the LICENSE.txt file.