README.md updated
This commit is contained in:
parent
f42c6b1dbe
commit
98efe210b3
40
README.md
40
README.md
@ -1,4 +1,38 @@
|
||||
# subrelay
|
||||
# Subrelay - stand alone mail list service
|
||||
|
||||
Subrelay is a mail list software, works standalone independently from SMTP server. It uses external SMTP server to send messages, and external IMAP server to listen for the incoming messages.
|
||||
|
||||
## Build instructions
|
||||
|
||||
In order to build run the following commands:
|
||||
|
||||
```sh
|
||||
./autogen.sh
|
||||
./configure --prefix=/usr/local # or your preffered path
|
||||
make
|
||||
sudo make install
|
||||
|
||||
## Documentation
|
||||
|
||||
You can find documentation after installation. There are few man pages:
|
||||
|
||||
- sbrlctrl (1)
|
||||
- subrelayd (8)
|
||||
- subrelay.conf (5)
|
||||
|
||||
## Requirements
|
||||
|
||||
In order to run this mail list server you should obtain:
|
||||
|
||||
- A mail box with IMAPs access
|
||||
- Remote SMTPs server
|
||||
- Credentials for them
|
||||
|
||||
You could run this software on a box of your homelab with internet access, or use cheap VPS
|
||||
hosting for that.
|
||||
|
||||
## Notes
|
||||
|
||||
Read KNOWN_ISSUES before starting to use this software. It's an early version, so consider
|
||||
backups.
|
||||
|
||||
Subrelay is a mail list software, works standalone independently from SMTP server. It uses external SMTP server to send
|
||||
messages, and external IMAP server to listen for the incoming messages.
|
||||
Loading…
x
Reference in New Issue
Block a user