Skip to content

Commit e004a5e

Browse files
authored
Merge pull request #528 from chatmail/r10s/update-readme
update some links
2 parents 31faf2c + acf6e86 commit e004a5e

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

README.md

+15-15
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Chatmail addresses are automatically created by a first login,
2727
after which the initially specified password is required
2828
for sending and receiving messages through them.
2929

30-
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,
30+
Please see [this list of known apps and client projects](https://chatmail.at/apps.html) which offer instant onboarding on chatmail servers,
3131
and [this list of known public 3rd party chatmail servers](https://delta.chat/en/chatmail).
3232

3333

@@ -57,7 +57,7 @@ Please substitute it with your own domain.
5757
1. Install the `cmdeploy` command in a virtualenv
5858

5959
```
60-
git clone https://github.com/deltachat/chatmail
60+
git clone https://github.com/chatmail/server
6161
cd chatmail
6262
scripts/initenv.sh
6363
```
@@ -116,11 +116,11 @@ scripts/cmdeploy bench
116116

117117
This repository has four directories:
118118

119-
- [cmdeploy](https://github.com/deltachat/chatmail/tree/main/cmdeploy)
119+
- [cmdeploy](https://github.com/chatmail/server/tree/main/cmdeploy)
120120
is a collection of configuration files
121121
and a [pyinfra](https://pyinfra.com)-based deployment script.
122122

123-
- [chatmaild](https://github.com/deltachat/chatmail/tree/main/chatmaild)
123+
- [chatmaild](https://github.com/chatmail/server/tree/main/chatmaild)
124124
is a python package containing several small services
125125
which handle authentication,
126126
trigger push notifications on new messages,
@@ -129,12 +129,12 @@ This repository has four directories:
129129
and some other minor things.
130130
chatmaild can also be installed as a stand-alone python package.
131131

132-
- [www](https://github.com/deltachat/chatmail/tree/main/www)
132+
- [www](https://github.com/chatmail/server/tree/main/www)
133133
contains the html, css, and markdown files
134134
which make up a chatmail server's web page.
135135
Edit them before deploying to make your chatmail server stand out.
136136

137-
- [scripts](https://github.com/deltachat/chatmail/tree/main/scripts)
137+
- [scripts](https://github.com/chatmail/server/tree/main/scripts)
138138
offers two convenience tools for beginners;
139139
`initenv.sh` installs the necessary dependencies to a local virtual environment,
140140
and the `scripts/cmdeploy` script enables you
@@ -173,39 +173,39 @@ If you deploy them with cmdeploy,
173173
they are run by systemd services in the background.
174174
A short overview:
175175

176-
- [`doveauth`](https://github.com/deltachat/chatmail/blob/main/chatmaild/src/chatmaild/doveauth.py) implements
176+
- [`doveauth`](https://github.com/chatmail/server/blob/main/chatmaild/src/chatmaild/doveauth.py) implements
177177
create-on-login account creation semantics and is used
178178
by Dovecot during login authentication and by Postfix
179179
which in turn uses [Dovecot SASL](https://doc.dovecot.org/configuration_manual/authentication/dict/#complete-example-for-authenticating-via-a-unix-socket)
180180
to authenticate users
181181
to send mails for them.
182182

183-
- [`filtermail`](https://github.com/deltachat/chatmail/blob/main/chatmaild/src/chatmaild/filtermail.py) prevents
183+
- [`filtermail`](https://github.com/chatmail/server/blob/main/chatmaild/src/chatmaild/filtermail.py) prevents
184184
unencrypted e-mail from leaving the chatmail service
185185
and is integrated into postfix's outbound mail pipelines.
186186

187-
- [`chatmail-metadata`](https://github.com/deltachat/chatmail/blob/main/chatmaild/src/chatmaild/metadata.py) is contacted by a
188-
[dovecot lua script](https://github.com/deltachat/chatmail/blob/main/cmdeploy/src/cmdeploy/dovecot/push_notification.lua)
187+
- [`chatmail-metadata`](https://github.com/chatmail/server/blob/main/chatmaild/src/chatmaild/metadata.py) is contacted by a
188+
[dovecot lua script](https://github.com/chatmail/server/blob/main/cmdeploy/src/cmdeploy/dovecot/push_notification.lua)
189189
to store user-specific server-side config.
190190
On new messages,
191-
it [passes the user's push notification token](https://github.com/deltachat/chatmail/blob/main/chatmaild/src/chatmaild/notifier.py)
191+
it [passes the user's push notification token](https://github.com/chatmail/server/blob/main/chatmaild/src/chatmaild/notifier.py)
192192
to [notifications.delta.chat](https://delta.chat/help#instant-delivery)
193193
so the push notifications on the user's phone can be triggered
194194
by Apple/Google.
195195

196-
- [`delete_inactive_users`](https://github.com/deltachat/chatmail/blob/main/chatmaild/src/chatmaild/delete_inactive_users.py)
196+
- [`delete_inactive_users`](https://github.com/chatmail/server/blob/main/chatmaild/src/chatmaild/delete_inactive_users.py)
197197
deletes users if they have not logged in for a very long time.
198198
The timeframe can be configured in `chatmail.ini`.
199199

200-
- [`lastlogin`](https://github.com/deltachat/chatmail/blob/main/chatmaild/src/chatmaild/lastlogin.py)
200+
- [`lastlogin`](https://github.com/chatmail/server/blob/main/chatmaild/src/chatmaild/lastlogin.py)
201201
is contacted by dovecot when a user logs in
202202
and stores the date of the login.
203203

204-
- [`echobot`](https://github.com/deltachat/chatmail/blob/main/chatmaild/src/chatmaild/echo.py)
204+
- [`echobot`](https://github.com/chatmail/server/blob/main/chatmaild/src/chatmaild/echo.py)
205205
is a small bot for test purposes.
206206
It simply echoes back messages from users.
207207

208-
- [`chatmail-metrics`](https://github.com/deltachat/chatmail/blob/main/chatmaild/src/chatmaild/metrics.py)
208+
- [`chatmail-metrics`](https://github.com/chatmail/server/blob/main/chatmaild/src/chatmaild/metrics.py)
209209
collects some metrics and displays them at `https://example.org/metrics`.
210210

211211
### Home page and getting started for users

0 commit comments

Comments
 (0)