A webmail client. Forked from https://git.sr.ht/~migadu/alps

Simon Ser ad1d2ee7f4 Implement plugin/template reload on SIGUSR1 There's no way around having a global mutex, because we need to update the HTTP routes when reloading plugins. During reload we need to lock the whole server. Closes: https://todo.sr.ht/~sircmpwn/koushin/43		4 yıl önce
cmd/koushin	Implement plugin/template reload on SIGUSR1	4 yıl önce
plugins/base	Add Server.Reload	4 yıl önce
themes	themes/sourcehut: add search input to mailbox view	4 yıl önce
.gitignore	Introduce base plugin	4 yıl önce
LICENSE	Correct license ownership	4 yıl önce
README.md	Allow Lua plugins to inject all templates	4 yıl önce
go.mod	Add a form to set message flags	4 yıl önce
go.sum	Add a form to set message flags	4 yıl önce
imap.go	Introduce base plugin	4 yıl önce
plugin.go	Add Context to Plugin.Inject	4 yıl önce
plugin_go.go	Make Go plugin handlers take a *Context	4 yıl önce
plugin_lua.go	Add Context to Plugin.Inject	4 yıl önce
server.go	Implement plugin/template reload on SIGUSR1	4 yıl önce
session.go	Document that plugins don't have access to passwords	4 yıl önce
smtp.go	Introduce base plugin	4 yıl önce
template.go	Implement plugin/template reload on SIGUSR1	4 yıl önce

README.md

koushin

Usage

go run ./cmd/koushin imaps://mail.example.org:993 smtps://mail.example.org:465

See -h for more information.

Themes

They should be put in themes/<name>/.

Templates in themes/<name>/*.html override default templates in plugins. Assets in themes/<name>/assets/* are served by the HTTP server at /themes/<name>/assets/*.

Plugins

Plugins can be written in Go or in Lua and live in plugins/<name>/.

Plugins can provide their own templates in plugins/<name>/public/*.html. Assets in plugins/<name>/public/assets/* are served by the HTTP server at /plugins/<name>/assets/*.

Go plugins

They can use the Go plugin helpers and need to be included at compile-time in cmd/koushin/main.go.

Lua plugins

The entry point is at plugins/<name>/main.lua.

API:

koushin.on_render(name, f): prior to rendering the template name, call f with the template data (the special name * matches all templates)
koushin.set_filter(name, f): set a template function
koushin.set_route(method, path, f): register a new HTTP route, f will be called with the HTTP context

Contributing

Send patches on the mailing list, report bugs on the issue tracker.

License

MIT