README: rework and reorder

but i am pretty sure this stems from a time where we had non-ephemeral
non-automated account setup (regular testrun.org) and does not apply to chatmail.

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,4 @@
+
+Please refer to 
+[Delta Chat community standards and practices](https://delta.chat/en/community-standards)
+which also apply for all chatmail developments. 

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023, chatmail and delta chat teams
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -18,14 +18,7 @@ after which the initially specified password is required for using them.
 We subsequently use `CHATMAIL_DOMAIN` as a placeholder for your fully qualified 
 DNS domain name (FQDN), for example `chat.example.org`.
 
-1. Setup DNS `A` and `AAAA` records for your `CHATMAIL_DOMAIN`. 
+1. Install the `cmdeploy` command in a virtualenv
-   Verify that DNS is set and SSH root login works:
-
-   ```
-        ssh root@CHATMAIL_DOMAIN 
-   ```
-
-2. Install the `cmdeploy` command in a virtualenv
 
    ```
     git clone https://github.com/deltachat/chatmail
@@ -33,12 +26,20 @@ DNS domain name (FQDN), for example `chat.example.org`.
     scripts/initenv.sh
    ```
   
-3. Create chatmail configuration file `chatmail.ini`:
+2. Create chatmail configuration file `chatmail.ini`:
 
    ```
     scripts/cmdeploy init CHATMAIL_DOMAIN
    ```
 
+3. Setup first DNS records for your `CHATMAIL_DOMAIN`,
+   according to the hints provided by `cmdeploy init`.
+   Verify that SSH root login works:
+
+   ```
+        ssh root@CHATMAIL_DOMAIN
+   ```
+
 4. Deploy to the remote chatmail server:
 
    ```
@@ -52,111 +53,106 @@ DNS domain name (FQDN), for example `chat.example.org`.
     scripts/cmdeploy dns
    ```
 
-6. To check status of your remotely running chatmail service: 
+### Other helpful commands:
 
-   ```
+To check the status of your remotely running chatmail service:
-    scripts/cmdeploy status
-   ```
 
-7. To test your chatmail service: 
+```
-
+scripts/cmdeploy status
-   ```
-    scripts/cmdeploy test
-   ```
-
-8. To benchmark your chatmail service: 
-
-   ```
-    scripts/cmdeploy bench
-   ```
-
-### Refining the web pages 
-
-
-``` 
-    scripts/cmdeploy webdev 
 ```
 
-This starts a local live development cycle for chatmail Web pages: 
+To test whether your chatmail service is working correctly:
 
-- uses the `www/src/page-layout.html` file for producing static 
+```
-  HTML pages from `www/src/*.md` files
+scripts/cmdeploy test
+```
 
-- continously builds the web presence reading files from `www/src` directory
+To measure the performance of your chatmail service:
-  and generating html files and copying assets to the `www/build` directory. 
 
-- Starts a browser window automatically where you can "refresh" as needed. 
+```
+scripts/cmdeploy bench
+```
 
+## Overview of this repository
 
-### Home page and getting started for users 
+This repository drives the development of "chatmail instances",
+comprised of minimal setups of
 
-`cmdeploy run` sets up mail services,
+- [postfix smtp server](https://www.postfix.org)
-and also creates default static Web pages and deploys them: 
+- [dovecot imap server](https://www.dovecot.org)
 
-- a default `index.html` along with a QR code that users can click to 
+as well as custom services that are integrated with these two:
-  create accounts on your chatmail provider,
-
-- a default `info.html` that is linked from the home page,
-
-- a default `policy.html` that is linked from the home page. 
-
-All `.html` files are generated 
-by the according markdown `.md` file in the `www/src` directory.
-
-
-### Ports
-
-Postfix listens on ports 25 (smtp) and 587 (submission) and 465 (submissions).
-Dovecot listens on ports 143(imap) and 993 (imaps).
-
-Delta Chat will, however, discover all ports and configurations 
-automatically by reading the `autoconfig.xml` file from the chatmail instance. 
-
-
-## Emergency Commands to disable automatic account creation 
-
-If you need to stop account creation,
-e.g. because some script is wildly creating accounts, run:
-
-    touch /etc/chatmail-nocreate
-
-While this file is present, account creation will be blocked. 
-
-
-## Running tests and benchmarks (offline and online) 
-
-1. Set `CHATMAIL_SSH` so that `ssh root@$CHATMAIL_SSH` allows 
-   to login to the chatmail instance server. 
-
-2. To run local and online tests: 
-
-    scripts/test.sh 
-
-3. To run benchmarks against your chatmail instance: 
-
-    scripts/bench.sh 
-
-
-## Development Background for chatmail instances 
-
-This repository drives the development of "chatmail instances", 
-comprised of minimal setups of 
-
-- [postfix smtp server](https://www.postfix.org) 
-- [dovecot imap server](https://www.dovecot.org) 
-
-as well as two custom services that are integrated with these two: 
 
 - `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. 
+  to send mails for them.
 
-- `chatmaild/src/chatmaild/filtermail.py` prevents 
+- `chatmaild/src/chatmaild/filtermail.py` prevents
   unencrypted e-mail from leaving the chatmail instance
-  and is integrated into postfix's outbound mail pipelines. 
+  and is integrated into postfix's outbound mail pipelines.
+
+There is also the `cmdeploy/src/cmdeploy/cmdeploy.py` command line tool
+which helps with setting up and managing the chatmail service.
+`cmdeploy run` uses [pyinfra-based scripting](https://pyinfra.com/)
+in `cmdeploy/src/cmdeploy/__init__.py`
+to automatically install all chatmail components on a server.
 
 
+### Home page and getting started for users
+
+`cmdeploy run` also creates default static Web pages and deploys them
+to an nginx web server under `https://CHATMAIL_DOMAIN`.
+
+- a default `index.html` along with a QR code that users can click to
+  create accounts on your chatmail provider,
+
+- a default `info.html` that is linked from the home page,
+
+- a default `policy.html` that is linked from the home page.
+
+All `.html` files are generated
+by the according markdown `.md` file in the `www/src` directory.
+
+
+### Refining the web pages
+
+
+```
+scripts/cmdeploy webdev
+```
+
+This starts a local live development cycle for chatmail Web pages:
+
+- uses the `www/src/page-layout.html` file for producing static
+  HTML pages from `www/src/*.md` files
+
+- continously builds the web presence reading files from `www/src` directory
+  and generating html files and copying assets to the `www/build` directory.
+
+- Starts a browser window automatically where you can "refresh" as needed.
+
+
+## Emergency Commands to disable automatic account creation
+
+If you need to stop account creation,
+e.g. because some script is wildly creating accounts,
+login to the server with ssh and run:
+
+```
+    touch /etc/chatmail-nocreate
+```
+
+While this file is present, account creation will be blocked.
+
+### Ports
+
+Postfix listens on ports 25 (smtp) and 587 (submission) and 465 (submissions).
+Dovecot listens on ports 143(imap) and 993 (imaps).
+
+Delta Chat apps will, however, discover all ports and configurations
+automatically by reading the `autoconfig.xml` file from the chatmail service.
+
 

cmdeploy/src/cmdeploy/tests/online/benchmark.py

@@ -30,10 +30,10 @@ def test_login_smtp(benchmark, smtp, gencreds):
 
 class TestDC:
     def test_autoconfigure(self, benchmark, cmfactory):
-        def autoconfig_and_idle_ready():
+        def dc_autoconfig_and_idle_ready():
             cmfactory.get_online_accounts(1)
 
-        benchmark(autoconfig_and_idle_ready, 5)
+        benchmark(dc_autoconfig_and_idle_ready, 5)
 
     def test_ping_pong(self, benchmark, cmfactory):
         ac1, ac2 = cmfactory.get_online_accounts(2)

www/src/privacy.md

@@ -218,97 +218,16 @@ on these or possible objections.
 A deletion can be made
 directly in the Delta Chat email messenger.
 
-a) request information about your personal data processed by us
+If you have any questions or complaints, 
-in accordance with Art. 15 GDPR.
+please feel free to contact us by email:  
-In particular,
+{{ config.privacy_mail }}
-you can request information about the processing purposes,
-the category of personal data,
-the categories of recipients to whom your data have been or will be disclosed,
-the planned storage period,
-the existence of a right to rectification, erasure, restriction of processing or objection,
-the existence of a right of complaint,
-the origin of your data if it has not been collected by us,
-as well as the existence of automated decision-making including profiling
-and, if applicable,
-meaningful information about its details;  
 
-b) in accordance with Art. 16 of the GDPR,
+As a rule, you can contact the supervisory authority of your usual place of residence
-immediately request the correction
-of inaccurate or incomplete personal data stored by us;  
-
-c) pursuant to Article 17 of the GDPR,
-to request the erasure of your personal data stored by us,
-unless the processing is necessary
-for the exercise of the right to freedom of expression and information,
-for compliance with a legal obligation,
-for reasons of public interest,
-or for the establishment, exercise or defence of legal claims;  
-
-d) pursuant to Art. 18 GDPR,
-to request the restriction of the processing of your personal data,
-insofar as the accuracy of the data is disputed by you,
-the processing is unlawful,
-but you object to its erasure
-and we no longer require the data,
-but you need it for the assertion, exercise or defence of legal claims
-or you have objected to the processing pursuant to Art. 21 GDPR;  
-
-e) pursuant to Art. 20 GDPR,
-to receive your personal data that you have provided to us
-in a structured, common and machine-readable format
-or to request that it be transferred to another controller;  
-
-f) in accordance with Art. 7 (3) of the GDPR,
-to revoke your consent given to us at any time.
-This has the consequence that we may no longer continue the data processing
-based on this consent in the future; and  
-
-g) complain to a supervisory authority
-in accordance with Article 77 of the GDPR.
-As a rule,
-you can contact the supervisory authority of your usual place of residence
 or workplace
 or our registered office for this purpose.
 The supervisory authority responsible for our place of business
 is the `{{ config.privacy_supervisor }}`.
 
-If you have any questions or complaints, please feel free to contact us by email:  
-{{ config.privacy_mail }}
-
-
-### 5.1 Right to object
-
-If your personal data is processed on the basis of our legitimate interests
-in accordance with Art. 6 (1) lit. f GDPR,
-you have the right to object to the processing of your personal data
-in accordance with Art. 21 GDPR,
-provided that there are grounds for this based on your particular situation
-or the objection is directed against direct advertising.
-In the latter case,
-you have a general right of objection,
-which will be implemented by us
-without specifying a particular situation.
-
-If you wish to exercise your right of objection,
-simply send an e-mail to: {{ config.privacy_mail }}
-
-### 5.2 Right to withdraw
-
-If your personal data is processed on the basis of your consent
-in accordance with Art. 6 (1) lit. a GDPR
-(e.g. via the mailing list),
-you can withdraw your consent at any time
-and without any disadvantages.
-As a result,
-we may no longer continue the data processing
-that was based on this consent for the future.
-However,
-the withdrawal of your consent
-does not affect the lawfulness of the processing
-carried out on the basis of the consent until the withdrawal.
-
-If you wish to make use of your right of withdrawal,
-simply send an e-mail to: {{ config.privacy_mail }}
 
 ## 6. Validity of this privacy policy