From 9677617c7f36faad7f047a89a78b1fb9c1bc865c Mon Sep 17 00:00:00 2001 From: Christian Hagenest Date: Fri, 17 May 2024 13:11:45 +0200 Subject: [PATCH] edit README --- scripts/dovecot/README.md | 30 ++++++++++++++++-------------- 1 file changed, 16 insertions(+), 14 deletions(-) diff --git a/scripts/dovecot/README.md b/scripts/dovecot/README.md index 278850ca..145520ca 100644 --- a/scripts/dovecot/README.md +++ b/scripts/dovecot/README.md @@ -38,7 +38,7 @@ While in theory a package can be created entirely over the web interface, the use of the cli-tool `osc` is more convenient and is described in the [official documentation](https://openbuildservice.org/help/manuals/obs-user-guide/art.obs.bg#sec.obsbg.obsconfig). -### How to build the dovecot debian package for all platforms via our script +### How to build the dovecot debian package on the via our script In scripts/dovecot/ is a shell script that prepares the required files and pushes them to build.opensuse.org. @@ -48,26 +48,28 @@ The script assumes you are on Debian. It automatically installs any needed depen Use `source build-obs.sh` to run it. -### Adding the resulting OBS repository to Debian +### Adding the resulting OBS repository to Debian 12 -XXX suggested: -XXX - use the in-repo key for addition (if OBS key changes, we also need to update i in our repo anyway) -XXX - also link to the deployment code adding the key (https://github.com/deltachat/chatmail/blob/main/cmdeploy/src/cmdeploy/__init__.py) +Our dovecot fork is automatically installed as part of the chatmail deployment. You can see it in cmdeploy/src/cmdeploy/__init__.py. If you want to add our fork manually to a system, you can do the following: -XXX (question: what is missing/why is "apt-add-repository" not possible?) +First add our signing key to your apt keyring: -To add the OBS-managed signing key to your local install: +``` +sudo cp cmdeploy/src/cmdeploy/obs-home-deltachat.gpg /etc/apt/keyrings/obs-home-deltachat.gpg` +``` - curl https://build.opensuse.org/projects/home:deltachat/signing_keys/download?kind=gpg | sudo cp scripts/dovecot/home:deltachat.gpg /etc/apt/keyrings/obs-home-deltachat.gpg` +Now add our repository and key to /etc/apt/sources.list with a text editor of your choice: -Add to /etc/apt/sources.list: +``` +deb [signed-by=/etc/apt/keyrings/obs-home-deltachat.gpg] https://download.opensuse.org/repositories/home:/deltachat/Debian_12/ ./ +``` -`deb [signed-by=/etc/apt/keyrings/obs-home-deltachat.gpg] https://download.opensuse.org/repositories/home:/deltachat/Debian_12/ ./` +You can now install dovecot like normal. -Install dovecot 🥳 - -`sudo apt update -sudo apt install dovecot-core` +``` +sudo apt update +sudo apt install dovecot-core +``` ### Security concerns