Add readme and licence

This commit is contained in:
Malanius 2018-10-01 20:06:20 +02:00
parent 4546d9099c
commit 1517cd5ece
2 changed files with 57 additions and 0 deletions

21
LICENCE Normal file
View file

@ -0,0 +1,21 @@
MIT License
Copyright (c) 2018 brmlab
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

36
readme.md Normal file
View file

@ -0,0 +1,36 @@
# Wekan mailer
## About
This is small application which provides email to board function for wekan.
It is supposed to run in docker compose alongside [wekan+mongodb](https://github.com/wekan/wekan-mongodb), but may be used separately as it is Java based.
**The application is currently WIP, use at your own risk!**
## Functions
- read emails from single SMTP server account
- create card from received email on single wekan board in target list
*Note: These are just starting functions, other may or may not be added later.*
## Configuration
The configuration is passed to the wekan-mailer trough environment variables simmilar to the approach in wekan+mongodb is compose used.
### Wekan
Required env vars are:
- `WEKAN_URL`=http://localhost:3000
- `WEKAN_USER`=someuser
- `WEKAN_PASSWORD`=somepass
- `WEKAN_TARGET_BOARD`=someId
- `WEKAN_TARGET_LIST`=someListId
```env
WEKAN_URL=http://localhost:3000
WEKAN_USER=someuser
WEKAN_PASSWORD=somepass
WEKAN_TARGET_BOARD=someId
WEKAN_TARGET_LIST=someListId
```