musala/README.md

89 lines
2.1 KiB
Markdown
Raw Normal View History

2018-08-22 10:29:23 +00:00
# Trello-2-Mail
2018-08-27 07:53:47 +00:00
Every morning, get the content of your favorite task list by email
2018-08-22 10:29:23 +00:00
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
go install github.com/glenux/trello2mail-go/...
2018-08-22 18:15:11 +00:00
It will install Trello2Mail binary in `$GOPATH/bin`
2018-08-27 13:48:08 +00:00
### With docker
Make sure you have Docker installed, then type:
docker build -t trello2mail -f docker/Dockerfile .
2018-08-22 18:15:11 +00:00
## Usage
## 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=Server%20Token&key=58117ebf843d49b05bca074c5fd520ee>
2018-08-28 07:54:19 +00:00
## Normal use
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:
$GOPATH/bin/trello2mail
2018-08-28 07:54:19 +00:00
### With docker
docker run \
-e EMAIL_FROM=
-e EMAIL_TO=
-e EMAIL_SUBJECT=
-e EMAIL_FROM=
-e EMAIL_TO=
-e EMAIL_SUBJECT=
-v /var/lib/trello2mail/trello2mail.cron:/app/trello2mail.cron \
-it trello2mail:latest
2018-08-22 18:02:00 +00:00
## Contributing
1. Fork it ( http://github.com/glenux/trello2mail-go/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
Author & Maintainer: Glenn Y. ROLLAND
Contributors: none yet ;)
Got questions? Need help? Tweet at @glenux
## License
Trello2Mail is Copyright © 2018 Glenn ROLLAND. It is free software, and may be redistributed under the terms specified in the LICENSE file.