diff --git a/README.md b/README.md index 575c404a..9e38b711 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ Chatmail addresses are automatically created by a first login, after which the initially specified password is required for sending and receiving messages through them. -Please see [this list of known apps and client projects](https://support.delta.chat/t/list-of-all-known-client-projects/3059) which offer instant onboarding on chatmail servers, +Please see [this list of known apps and client projects](https://chatmail.at/apps.html) which offer instant onboarding on chatmail servers, and [this list of known public 3rd party chatmail servers](https://delta.chat/en/chatmail). @@ -57,7 +57,7 @@ Please substitute it with your own domain. 1. Install the `cmdeploy` command in a virtualenv ``` - git clone https://github.com/deltachat/chatmail + git clone https://github.com/chatmail/server cd chatmail scripts/initenv.sh ``` @@ -116,11 +116,11 @@ scripts/cmdeploy bench This repository has four directories: -- [cmdeploy](https://github.com/deltachat/chatmail/tree/main/cmdeploy) +- [cmdeploy](https://github.com/chatmail/server/tree/main/cmdeploy) is a collection of configuration files and a [pyinfra](https://pyinfra.com)-based deployment script. -- [chatmaild](https://github.com/deltachat/chatmail/tree/main/chatmaild) +- [chatmaild](https://github.com/chatmail/server/tree/main/chatmaild) is a python package containing several small services which handle authentication, trigger push notifications on new messages, @@ -129,12 +129,12 @@ This repository has four directories: and some other minor things. chatmaild can also be installed as a stand-alone python package. -- [www](https://github.com/deltachat/chatmail/tree/main/www) +- [www](https://github.com/chatmail/server/tree/main/www) contains the html, css, and markdown files which make up a chatmail server's web page. Edit them before deploying to make your chatmail server stand out. -- [scripts](https://github.com/deltachat/chatmail/tree/main/scripts) +- [scripts](https://github.com/chatmail/server/tree/main/scripts) offers two convenience tools for beginners; `initenv.sh` installs the necessary dependencies to a local virtual environment, and the `scripts/cmdeploy` script enables you @@ -173,39 +173,39 @@ If you deploy them with cmdeploy, they are run by systemd services in the background. A short overview: -- [`doveauth`](https://github.com/deltachat/chatmail/blob/main/chatmaild/src/chatmaild/doveauth.py) implements +- [`doveauth`](https://github.com/chatmail/server/blob/main/chatmaild/src/chatmaild/doveauth.py) implements create-on-login account creation semantics and is used by Dovecot during login authentication and by Postfix which in turn uses [Dovecot SASL](https://doc.dovecot.org/configuration_manual/authentication/dict/#complete-example-for-authenticating-via-a-unix-socket) to authenticate users to send mails for them. -- [`filtermail`](https://github.com/deltachat/chatmail/blob/main/chatmaild/src/chatmaild/filtermail.py) prevents +- [`filtermail`](https://github.com/chatmail/server/blob/main/chatmaild/src/chatmaild/filtermail.py) prevents unencrypted e-mail from leaving the chatmail service and is integrated into postfix's outbound mail pipelines. -- [`chatmail-metadata`](https://github.com/deltachat/chatmail/blob/main/chatmaild/src/chatmaild/metadata.py) is contacted by a - [dovecot lua script](https://github.com/deltachat/chatmail/blob/main/cmdeploy/src/cmdeploy/dovecot/push_notification.lua) +- [`chatmail-metadata`](https://github.com/chatmail/server/blob/main/chatmaild/src/chatmaild/metadata.py) is contacted by a + [dovecot lua script](https://github.com/chatmail/server/blob/main/cmdeploy/src/cmdeploy/dovecot/push_notification.lua) to store user-specific server-side config. On new messages, - it [passes the user's push notification token](https://github.com/deltachat/chatmail/blob/main/chatmaild/src/chatmaild/notifier.py) + it [passes the user's push notification token](https://github.com/chatmail/server/blob/main/chatmaild/src/chatmaild/notifier.py) to [notifications.delta.chat](https://delta.chat/help#instant-delivery) so the push notifications on the user's phone can be triggered by Apple/Google. -- [`delete_inactive_users`](https://github.com/deltachat/chatmail/blob/main/chatmaild/src/chatmaild/delete_inactive_users.py) +- [`delete_inactive_users`](https://github.com/chatmail/server/blob/main/chatmaild/src/chatmaild/delete_inactive_users.py) deletes users if they have not logged in for a very long time. The timeframe can be configured in `chatmail.ini`. -- [`lastlogin`](https://github.com/deltachat/chatmail/blob/main/chatmaild/src/chatmaild/lastlogin.py) +- [`lastlogin`](https://github.com/chatmail/server/blob/main/chatmaild/src/chatmaild/lastlogin.py) is contacted by dovecot when a user logs in and stores the date of the login. -- [`echobot`](https://github.com/deltachat/chatmail/blob/main/chatmaild/src/chatmaild/echo.py) +- [`echobot`](https://github.com/chatmail/server/blob/main/chatmaild/src/chatmaild/echo.py) is a small bot for test purposes. It simply echoes back messages from users. -- [`chatmail-metrics`](https://github.com/deltachat/chatmail/blob/main/chatmaild/src/chatmaild/metrics.py) +- [`chatmail-metrics`](https://github.com/chatmail/server/blob/main/chatmaild/src/chatmaild/metrics.py) collects some metrics and displays them at `https://example.org/metrics`. ### Home page and getting started for users