Write documentation for DKIM e-mail setting

Ocelot-Social-Community · Aug 22, 2023 · 9f5d32e · 9f5d32e
1 parent cd206c2
commit 9f5d32e
Show file tree

Hide file tree

Showing 5 changed files with 46 additions and 5 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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 → deployment/deployment.md b/deployment/README.deployment.md → deployment/deployment.md