musala/README.md

140 lines
3.8 KiB
Markdown
Raw Normal View History

2020-05-17 22:45:20 +00:00
# <img src="doc/logo-title-paths.svg" width="50%" style="display: block; margin: 0 auto;" alt="Musala" />
2021-01-03 12:37:02 +00:00
![Build](https://github.com/glenux/musala/workflows/build/badge.svg?branch=master)
[![GitHub license](https://img.shields.io/github/license/glenux/musala.svg)](https://github.com/glenux/musala/blob/master/LICENSE.txt)
2020-01-25 17:53:26 +00:00
[![Donate on patreon](https://img.shields.io/badge/patreon-donate-orange.svg)](https://patreon.com/glenux)
2018-08-22 10:29:23 +00:00
2020-01-25 17:53:26 +00:00
Every morning, get the content of your favorite kanban board by email, WhatsApp or SMS.
2020-01-25 17:53:26 +00:00
2020-05-17 21:48:24 +00:00
Note: _musala_ means _work, occupation_ [in Lingala](https://dic.lingala.be/fr/mosala)
2020-05-17 21:47:43 +00:00
## Roadmap
2020-01-25 17:53:26 +00:00
Task sources:
2019-09-04 15:03:46 +00:00
* :heavy_check_mark: __Trello__
2020-06-02 14:58:56 +00:00
* :x: Nextcloud Deck (not yet) - [API Reference](https://github.com/nextcloud/deck/blob/master/docs/API.md)
* :x: Wekan (not yet) - [API Reference](https://github.com/wekan/wekan/wiki/REST-API)
2019-09-04 15:13:34 +00:00
* :x: Libreboard (not yet)
* :x: Github Projects (not yet)
2018-08-22 10:29:23 +00:00
2020-06-02 15:07:20 +00:00
Source selection
* :heavy_check_mark: __All of them__
* :heavy_check_mark: __Favorited boards__
* :heavy_check_mark: __Only selected ones__
2020-06-02 15:07:20 +00:00
2020-01-25 17:53:26 +00:00
Delivery via:
* :heavy_check_mark: __E-mail__
2020-06-02 15:04:00 +00:00
* :x: Telegram
2020-06-02 15:04:33 +00:00
* :x: Slack
2020-01-25 17:53:26 +00:00
* :x: SMS
2020-06-02 15:05:12 +00:00
* :x: Whatsapp
* :x: IRC
2020-01-25 17:53:26 +00:00
2020-06-02 15:09:22 +00:00
User interface for account configuration
2020-06-02 15:08:49 +00:00
2020-06-02 15:09:22 +00:00
* :heavy_check_mark: Command line + environment variables
2020-06-02 15:08:49 +00:00
* :x: Web app
2018-08-22 18:02:00 +00:00
## Installation
2018-08-22 10:29:23 +00:00
2018-08-27 13:48:08 +00:00
### With go
2018-08-22 18:15:11 +00:00
Make sure you have Go installed, then type:
2018-08-22 18:02:00 +00:00
2021-01-03 12:37:02 +00:00
$ go install github.com/glenux/musala/...
2018-08-22 18:02:00 +00:00
2019-09-04 15:03:46 +00:00
It will install Musala Mail binary in `$GOPATH/bin`
2018-08-22 18:15:11 +00:00
2020-01-25 22:50:35 +00:00
2018-08-27 13:48:08 +00:00
### With docker
Make sure you have Docker installed, then type:
2021-01-03 12:37:02 +00:00
$ docker build -t musala -f docker/Dockerfile .
2018-08-22 18:15:11 +00:00
## Usage
2019-09-04 15:12:00 +00:00
### Creating a developper account
2019-09-04 05:35:49 +00:00
2019-09-04 15:03:46 +00:00
1. Create a Trello account on <https://trello.com>
2. Check your mailbox and confirm your email
2019-09-04 05:35:49 +00:00
3. Enable developper account on <https://trello.com/app-key>
4. Get an developer API KEY
2020-01-25 22:50:35 +00:00
2019-09-04 15:12:00 +00:00
### 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.
2019-09-04 15:03:46 +00:00
<https://trello.com/1/authorize?expiration=never&scope=read,write,account&response_type=token&name=Musala%20Mail&key=YOUR-API-KEY>
2020-01-25 22:50:35 +00:00
2019-09-04 15:12:00 +00:00
### Using the binary
2018-08-28 07:54:19 +00:00
2018-08-22 18:15:11 +00:00
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:
2021-01-03 12:37:02 +00:00
$ $GOPATH/bin/musala
2018-08-22 18:15:11 +00:00
2019-09-04 15:12:00 +00:00
### Using with docker
2018-08-28 07:54:19 +00:00
2021-01-03 12:37:02 +00:00
$ docker build -f docker/Dockerfile -t musala .
2019-09-04 15:12:00 +00:00
$ docker run \
2018-08-28 07:54:19 +00:00
-e EMAIL_FROM=
-e EMAIL_TO=
-e EMAIL_SUBJECT=
-e EMAIL_FROM=
-e EMAIL_TO=
-e EMAIL_SUBJECT=
2021-01-03 12:37:02 +00:00
-v /var/lib/musala/musala.cron:/app/musala.cron \
-it musala:latest
2018-08-22 18:02:00 +00:00
## Contributing
2021-01-03 12:37:02 +00:00
1. Fork it ( http://github.com/glenux/musala/fork )
2018-08-22 18:02:00 +00:00
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
2020-05-17 21:52:09 +00:00
* [Glenn Y. ROLLAND](https://github.com/glenux) - author & maintainer:
* You? Fork the project and become a contributor!
2018-08-22 18:02:00 +00:00
2019-09-04 15:03:46 +00:00
Got questions? Need help? Tweet at [@glenux](https://twitter.com/glenux)
2018-08-22 18:02:00 +00:00
## License
2021-01-03 12:44:20 +00:00
Musala is Copyright © 2018-2021 Glenn ROLLAND. It is free software, and may be redistributed under the terms specified in the LICENSE.txt file.
2019-09-04 15:03:46 +00:00
## See also...
Following projects may also inspire you:
* [72nd/deck-cli](https://github.com/72nd/deck-cli): a command-line tool for interacting with Nextcloud's Deck Plugin by using it's API