From 9f5d32e527151854f1888614c59e0aa5f2b504d0 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Wolfgang=20Hu=C3=9F?= <wolle.huss@pjannto.com>
Date: Tue, 22 Aug 2023 14:20:10 +0200
Subject: [PATCH] Write documentation for DKIM e-mail setting

---
 README.md                                     |  2 +
 SUMMARY.md                                    |  2 +-
 deployment/README.md                          |  9 +++--
 deployment/deployment-values.md               | 38 +++++++++++++++++++
 .../{README.deployment.md => deployment.md}   |  0
 5 files changed, 46 insertions(+), 5 deletions(-)
 create mode 100644 deployment/deployment-values.md
 rename deployment/{README.deployment.md => deployment.md} (100%)

diff --git a/README.md b/README.md
index 06e8d4929..2062865dd 100644
--- a/README.md
+++ b/README.md
@@ -8,9 +8,11 @@
 
 [ocelot.social](https://ocelot.social) is free and open source software program code to run social networks. Its development is supported by a community of programmers and interested network operators.
 
+<!-- markdownlint-disable MD033 -->
 <p align="center">
   <a href="https://ocelot.social" target="_blank"><img src="webapp/static/img/custom/logo-squared.svg" alt="ocelot.social" width="40%" height="40%"></a>
 </p>
+<!-- markdownlint-enable MD033 -->
 
 Our goal is to enable people to participate fairly and equally in online social networks. The equality of opportunity applies both to the fundamental equality of all people and to the possibility of letting their diverse voices be heard.
 
diff --git a/SUMMARY.md b/SUMMARY.md
index f848633d5..453a809b4 100644
--- a/SUMMARY.md
+++ b/SUMMARY.md
@@ -16,7 +16,7 @@
   * [Frontend tests](webapp/testing.md)
   * [Backend tests](backend/testing.md)
 * [Docker More Closely](DOCKER_MORE_CLOSELY.md)
-* [Deployment](https://github.com/Ocelot-Social-Community/Ocelot-Social-Deploy-Rebranding/blob/master/deployment/README.md)
+* [Deployment](deployment/README.md)
 * [Contributing](CONTRIBUTING.md)
 * [Feature Specification](cypress/features.md)
 * [Code of conduct](CODE_OF_CONDUCT.md)
diff --git a/deployment/README.md b/deployment/README.md
index 030eb8a44..93d3fb86c 100644
--- a/deployment/README.md
+++ b/deployment/README.md
@@ -6,11 +6,11 @@
 [![Open Source Helpers](https://www.codetriage.com/ocelot-social-community/ocelot-social-deploy-rebranding/badges/users.svg)](https://www.codetriage.com/ocelot-social-community/ocelot-social-deploy-rebranding)
 
 This repository is an in use template to rebrand, configure, and deploy [ocelot.social](https://github.com/Ocelot-Social-Community/Ocelot-Social) networks.
-The forked original repository is [Ocelot-Social-Deploy-Rebranding](https://github.com/Ocelot-Social-Community/Ocelot-Social-Deploy-Rebranding).
+The forked original repository is [stage.ocelot.social](https://github.com/Ocelot-Social-Community/stage.ocelot.social).
 
 <!-- markdownlint-disable MD033 -->
 <p align="center">
-  <a href="https://ocelot.social" target="_blank"><img src="branding/static/img/custom/logo-squared.svg" alt="Ocelot-Social" width="40%" height="40%"></a>
+  <a href="https://ocelot.social" target="_blank"><img src="../webapp/static/img/custom/logo-squared.svg" alt="ocelot.social" width="40%" height="40%"></a>
 </p>
 <!-- markdownlint-enable MD033 -->
 
@@ -47,7 +47,8 @@ Since all deployment methods described here depend on [Docker](https://docker.co
 
 The next step is:
 
-- [Configure And Branding](/branding/README.md)
+- [Set Environment Variables and Configurations](./deployment-values.md)
+- [Configure And Branding](./configurations/stage.ocelot.social/branding/README.md)
 
 ### Optional: Locally Testing Configuration And Branding
 
@@ -99,7 +100,7 @@ See the login details and browser addresses above.
 
 ### Deployment
 
-Afterwards you can [deploy](/deployment/README.md) it on your server:
+Afterwards you can [deploy](/deployment/deployment.md) it on your server:
 
 - [Kubernetes with Helm](/deployment/kubernetes/README.md)
 
diff --git a/deployment/deployment-values.md b/deployment/deployment-values.md
new file mode 100644
index 000000000..300a056dd
--- /dev/null
+++ b/deployment/deployment-values.md
@@ -0,0 +1,38 @@
+# Deployment Values
+
+For each deployment, you need to set the environment variables and configurations.
+Here is some specific information on how to set the values.
+
+## E-Mails
+
+You need to set environment variables to send registration and invitation information or notifications to users, for example.
+
+### SPF and DKIM
+
+More and more e-mail providers require settings for authorization and verification of e-mail senders.
+
+### SPF
+
+Sometimes it is enough to create an SPF record in your DNS.
+
+### DKIM
+
+However, if you need DKIM authorization and verification, you must set the appropriate environment variables:
+
+```bash
+SMTP_DKIM_DOMAINNAME=<your e-mail sender domain>
+SMTP_DKIM_KEYSELECTOR=2017
+SMTP_DKIM_PRIVATKEY="-----BEGIN RSA PRIVATE KEY-----\n<your base64 encoded privat key data>\n-----END RSA PRIVATE KEY-----\n"
+```
+
+You can find out how DKIM works here:
+
+<https://www.ionos.com/digitalguide/e-mail/e-mail-security/dkim-domainkeys/>
+
+To create the private and public DKIM key, see here:
+
+<https://knowledge.ondmarc.redsift.com/en/articles/2141592-generating-2048-bits-dkim-public-and-private-keys-using-openssl-on-a-mac>
+
+Information about the required PEM format can be found here:
+
+<https://docs.progress.com/bundle/datadirect-hybrid-data-pipeline-installation-46/page/PEM-file-format.html>
diff --git a/deployment/README.deployment.md b/deployment/deployment.md
similarity index 100%
rename from deployment/README.deployment.md
rename to deployment/deployment.md