Compare commits

...

2 Commits

Author SHA1 Message Date
holger krekel
0bfbff4400 strike this weird CHATMAIL_DOMAIN variable 2023-12-15 23:56:31 +01:00
holger krekel
0a42fd1a9f strike last mentins of "instance" in readme 2023-12-15 23:52:06 +01:00

View File

@@ -15,8 +15,8 @@ after which the initially specified password is required for using them.
## Deploying your own chatmail server ## Deploying your own chatmail server
We subsequently use `CHATMAIL_DOMAIN` as a placeholder for your fully qualified We use `chat.example.org` as the chatmail domain in the following steps.
DNS domain name (FQDN), for example `chat.example.org`. Please substitute it with your own domain.
1. Install the `cmdeploy` command in a virtualenv 1. Install the `cmdeploy` command in a virtualenv
@@ -25,19 +25,19 @@ DNS domain name (FQDN), for example `chat.example.org`.
cd chatmail cd chatmail
scripts/initenv.sh scripts/initenv.sh
``` ```
2. Create chatmail configuration file `chatmail.ini`: 2. Create chatmail configuration file `chatmail.ini`:
``` ```
scripts/cmdeploy init CHATMAIL_DOMAIN scripts/cmdeploy init chat.example.org # <-- use your domain
``` ```
3. Setup first DNS records for your `CHATMAIL_DOMAIN`, 3. Setup first DNS records for your chatmail domain,
according to the hints provided by `cmdeploy init`. according to the hints provided by `cmdeploy init`.
Verify that SSH root login works: Verify that SSH root login works:
``` ```
ssh root@CHATMAIL_DOMAIN ssh root@chat.example.org # <-- use your domain
``` ```
4. Deploy to the remote chatmail server: 4. Deploy to the remote chatmail server:
@@ -75,7 +75,7 @@ scripts/cmdeploy bench
## Overview of this repository ## Overview of this repository
This repository drives the development of "chatmail instances", This repository drives the development of chatmail services,
comprised of minimal setups of comprised of minimal setups of
- [postfix smtp server](https://www.postfix.org) - [postfix smtp server](https://www.postfix.org)
@@ -91,7 +91,7 @@ as well as custom services that are integrated with these two:
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 unencrypted e-mail from leaving the chatmail service
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 There is also the `cmdeploy/src/cmdeploy/cmdeploy.py` command line tool
@@ -104,7 +104,7 @@ to automatically install all chatmail components on a server.
### Home page and getting started for users ### Home page and getting started for users
`cmdeploy run` also creates default static Web pages and deploys them `cmdeploy run` also creates default static Web pages and deploys them
to an nginx web server under `https://CHATMAIL_DOMAIN`. to a nginx web server with:
- a default `index.html` along with a QR code that users can click to - a default `index.html` along with a QR code that users can click to
create accounts on your chatmail provider, create accounts on your chatmail provider,