🟢 Stable | Every morning, get your task lists by email, WhatsApp or SMS.
Go to file
Glenn Y. Rolland ac2209962b
All checks were successful
continuous-integration/drone/push Build is passing
continuous-integration/drone Build is passing
chore: Fix link to contrib-trello
2023-01-15 19:27:16 +01: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 doc: Add idea for composable functions 2023-01-15 19:08:21 +01:00
docker Rename musala-push to musala 2021-01-03 13:37:33 +01:00
templates fix: Improve template readability 2022-08-18 21:32:42 +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
.drone.yml ci: Fix backend binary build step 2022-08-18 21:29:28 +02:00
.gitignore chore: Ignore _* files 2022-08-18 21:33:24 +02:00
contrib-trello chore: Fix link to contrib-trello 2023-01-15 19:27:16 +01: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: update dev-dependency for security 2021-04-29 23:42:13 +02:00
README.md doc: Shorten content & improve display 2023-01-15 19:27:03 +01:00

Musala

Build Status GitHub license Donate on patreon

Every morning, get the content of your favorite kanban board by email, WhatsApp or SMS.

Note: musala means work, occupation in Lingala

Roadmap

Multiple task sources & destinations:

  • ✔️ Trello
  • Nextcloud Deck (not yet) / Wekan (not yet) / Gitea / Forgejo (not yet) / Libreboard (not yet) / Github Projects (not yet)

Board Data selection:

  • ✔️ All boards / Favorited boards / Only selected ones

Task actions:

  • ✔️ List tasks
  • Create task / Read task / Update task / Remove task

Delivery via:

  • ✔️ E-mail
  • Terminal / Webhook / UnifiedPush / Telegram / Slack / SMS / Whatsapp / IRC

UI for task management:

  • ✔️ Simple CLI + environment variables
  • Composable CLI + environment variables / Web UI

Installation

With go

Make sure you have Go installed, then type:

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

or

$ go install code.apps.glenux.net/glenux/musala/...@master

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

  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

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

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

Thanks

Thanks to Tamim & Stephanie for watching me updating this project.

License

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

See also...

Following projects may also inspire you: