mirror of
https://github.com/chatmail/relay.git
synced 2026-05-10 16:04:37 +00:00
fix/rename
This commit is contained in:
26
README.md
26
README.md
@@ -4,6 +4,18 @@ This package deploys Postfix and Dovecot servers, including OpenDKIM for DKIM si
|
||||
|
||||
Postfix uses Dovecot for authentication as described in <https://www.postfix.org/SASL_README.html#server_dovecot>
|
||||
|
||||
## Getting started
|
||||
|
||||
prepare:
|
||||
|
||||
pip install -e chatmail-infra
|
||||
|
||||
|
||||
then run with pyinfra command line tool:
|
||||
|
||||
CHATMAIL_DOMAIN=c1.testrun.org pyinfra --ssh-user root c1.testrun.org deploy.py
|
||||
|
||||
|
||||
## Structure (wip)
|
||||
|
||||
```
|
||||
@@ -12,7 +24,7 @@ Postfix uses Dovecot for authentication as described in <https://www.postfix.org
|
||||
deploy.py
|
||||
|
||||
# chatmail pyinfra deploy package
|
||||
pyinfra-src
|
||||
chatmail-pyinfra
|
||||
pyproject.toml
|
||||
chatmail/__init__ ...
|
||||
|
||||
@@ -20,7 +32,7 @@ pyinfra-src
|
||||
tests/test_online_test.py
|
||||
|
||||
# doveauth tool used by dovecot's auth mechanism on the host system
|
||||
doveauth-src
|
||||
doveauth
|
||||
README.md
|
||||
pyproject.toml
|
||||
doveauth.py
|
||||
@@ -28,7 +40,9 @@ doveauth-src
|
||||
test_doveauth.py
|
||||
```
|
||||
|
||||
## Ports
|
||||
## Dovecot/Postfix configuration
|
||||
|
||||
### Ports
|
||||
|
||||
Postfix listens on ports 25 (smtp) and 587 (submission) and 465 (submissions).
|
||||
Dovecot listens on ports 143(imap) and 993 (imaps).
|
||||
@@ -36,9 +50,3 @@ Dovecot listens on ports 143(imap) and 993 (imaps).
|
||||
## DNS
|
||||
|
||||
For DKIM you must add a DNS entry as in /etc/opendkim/selector.txt (where selector is the opendkim_selector configured in the chatmail inventory).
|
||||
|
||||
## Run with pyinfra
|
||||
|
||||
```
|
||||
CHATMAIL_DOMAIN=c1.testrun.org pyinfra --ssh-user root c1.testrun.org deploy.py
|
||||
```
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
#!/bin/sh
|
||||
python3 -m venv venv
|
||||
venv/bin/pip install pyinfra
|
||||
venv/bin/pip install -e .
|
||||
venv/bin/pip install -e chatmail-pyinfra
|
||||
|
||||
Reference in New Issue
Block a user