musala

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

Find a file

Glenn Y. Rolland e8b83bb7ab doc: add section 'See also' to README Signed-off-by: Glenn Y. Rolland <glenux@glenux.net>		2021-04-29 23:32:12 +02:00
.github/workflows	CI/CD: change build command	2021-01-03 13:36:41 +01:00
cmd/musala	Rename musala-push to musala	2021-01-03 13:37:33 +01:00
doc	Add logo	2020-05-18 00:43:03 +02:00
docker	Rename musala-push to musala	2021-01-03 13:37:33 +01:00
templates	Better handling of template generation	2020-12-07 10:46:55 +01: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	Merge branch 'develop'	2021-01-03 13:44:20 +01: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 dependencies versions	2020-12-05 19:00:41 +01:00
go.sum	Update dependencies versions	2020-12-05 19:00:41 +01:00
LICENSE.txt	Improve documentation	2018-08-22 20:02:00 +02:00
Makefile	Makefile: add bindir creation step	2021-01-03 13:47:56 +01:00
package-lock.json	Fix dependabot alerts (again)	2021-01-03 13:52:15 +01:00
package.json	Fix dependabot alerts (again)	2021-01-03 13:52:15 +01:00
README.md	doc: add section 'See also' to README	2021-04-29 23:32:12 +02:00

README.md

Every morning, get the content of your favorite kanban board 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)

Source selection

✔️ All of them
✔️ Favorited boards
✔️ Only selected ones

Delivery via:

✔️ E-mail
❌ Telegram
❌ Slack
❌ SMS
❌ Whatsapp
❌ IRC

User interface for account configuration

✔️ Command line + environment variables
❌ Web app

Installation

With go

Make sure you have Go installed, then type:

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

It will install Musala Mail binary in $GOPATH/bin

With docker

Make sure you have Docker installed, then type:

$ docker build -t musala -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

Using with docker

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

Contributing

Fork it ( http://github.com/glenux/musala/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