alps/README.md

36 lines
966 B
Markdown
Raw Normal View History

# [alps]
2019-12-02 14:31:00 +00:00
2020-05-13 12:07:44 +00:00
[![GoDoc](https://godoc.org/git.sr.ht/~emersion/alps?status.svg)](https://godoc.org/git.sr.ht/~emersion/alps)
2019-12-11 13:05:16 +00:00
A simple and extensible webmail.
2019-12-02 14:31:00 +00:00
## Usage
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
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
Add `-theme alps` to use the alps theme. See `docs/cli.md` for more
2020-02-18 15:01:26 +00:00
information.
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.
## Contributing
2019-12-17 09:58:31 +00:00
Send patches on the [mailing list], report bugs on the [issue tracker].
2019-12-02 14:31:00 +00:00
## License
MIT
2019-12-17 09:58:31 +00:00
[alps]: https://sr.ht/~emersion/alps
[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
[mailing list]: https://lists.sr.ht/~emersion/alps-dev
[issue tracker]: https://todo.sr.ht/~emersion/alps