2020-05-13 14:08:08 +00:00
|
|
|
# [alps]
|
2019-12-02 14:31:00 +00:00
|
|
|
|
2020-05-13 12:07:44 +00:00
|
|
|
[](https://godoc.org/git.sr.ht/~emersion/alps)
|
2019-12-11 13:05:16 +00:00
|
|
|
|
2020-01-30 10:20:56 +00:00
|
|
|
A simple and extensible webmail.
|
|
|
|
|
|
2019-12-02 14:31:00 +00:00
|
|
|
## Usage
|
|
|
|
|
|
2020-01-20 12:08:05 +00:00
|
|
|
Assuming SRV DNS records are properly set up (see [RFC 6186]):
|
|
|
|
|
|
2020-05-13 12:07:44 +00:00
|
|
|
go run ./cmd/alps example.org
|
2020-01-20 12:08:05 +00:00
|
|
|
|
|
|
|
|
To manually specify upstream servers:
|
|
|
|
|
|
2020-05-13 12:07:44 +00:00
|
|
|
go run ./cmd/alps imaps://mail.example.org:993 smtps://mail.example.org:465
|
2019-12-02 14:31:00 +00:00
|
|
|
|
2020-05-13 14:12:46 +00:00
|
|
|
Add `-theme alps` to use the alps theme. See `docs/cli.md` for more
|
2020-02-18 15:01:26 +00:00
|
|
|
information.
|
2019-12-04 17:30:01 +00:00
|
|
|
|
2020-02-14 14:50:39 +00:00
|
|
|
When developing themes and plugins, the script `contrib/hotreload.sh` can be
|
2020-05-13 12:07:44 +00:00
|
|
|
used to automatically reload alps on file changes.
|
2020-02-14 14:50:39 +00:00
|
|
|
|
2019-12-10 15:08:08 +00:00
|
|
|
## Contributing
|
|
|
|
|
|
2019-12-17 09:58:31 +00:00
|
|
|
Send patches on the [mailing list], report bugs on the [issue tracker].
|
2019-12-10 15:08:08 +00:00
|
|
|
|
2019-12-02 14:31:00 +00:00
|
|
|
## License
|
|
|
|
|
|
|
|
|
|
MIT
|
2019-12-17 09:58:31 +00:00
|
|
|
|
2020-05-13 14:08:08 +00:00
|
|
|
[alps]: https://sr.ht/~emersion/alps
|
2020-01-20 12:08:05 +00:00
|
|
|
[RFC 6186]: https://tools.ietf.org/html/rfc6186
|
2020-05-13 12:07:44 +00:00
|
|
|
[Go plugin helpers]: https://godoc.org/git.sr.ht/~emersion/alps#GoPlugin
|
2020-05-13 14:08:08 +00:00
|
|
|
[mailing list]: https://lists.sr.ht/~emersion/alps-dev
|
|
|
|
|
[issue tracker]: https://todo.sr.ht/~emersion/alps
|
