From f32e18c32a4ac51de8f24b806e733454dc5e2747 Mon Sep 17 00:00:00 2001 From: Christian Hagenest Date: Sat, 18 May 2024 23:31:03 +0200 Subject: [PATCH] Recommend authentication via ssh key with ed25519 algorithm (#231) (#291) * fix #231 * CI: disable CI for markdown files * clarify need for ssh-add * Update README.md Co-authored-by: missytake --------- Co-authored-by: missytake --- .github/workflows/test-and-deploy.yaml | 3 +++ README.md | 2 ++ 2 files changed, 5 insertions(+) diff --git a/.github/workflows/test-and-deploy.yaml b/.github/workflows/test-and-deploy.yaml index b261d174..5ea6a9de 100644 --- a/.github/workflows/test-and-deploy.yaml +++ b/.github/workflows/test-and-deploy.yaml @@ -7,6 +7,9 @@ on: pull_request: paths-ignore: - 'scripts/**' + - '**/README.md' + - 'CHANGELOG.md' + - 'LICENSE' jobs: deploy: diff --git a/README.md b/README.md index faf508d0..b1264fca 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,8 @@ after which the initially specified password is required for using them. ## Deploying your own chatmail server +To deploy chatmail on your own server, you must have set-up ssh authentication and need to use an ed25519 key, due to an [upstream bug in paramiko](https://github.com/paramiko/paramiko/issues/2191). You also need to add your private key to the local ssh-agent, because you can't type in your password during deployment. + We use `chat.example.org` as the chatmail domain in the following steps. Please substitute it with your own domain.