Ocelot-Social/deployment/deployment-values.md
Wolfgang Huß 16bd62f949
fix(other): leftover hetzner deployment (#8254)
* Ignore old configuration, still

* Add old branding value descriptions again and refine
2025-04-04 19:59:05 +02:00

2.4 KiB
Raw Blame History

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.

Webapp

We have several configuration possibilities just in the frontend.

Date Time

In file branding/constants/dateTime.js.

  • RELATIVE_DATETIME
    • true (default) or false
  • ABSOLUT_DATETIME_FORMAT
    • definition see date-fns, format:
      • P: just localized date
      • Pp: just localized date and time

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 in: .env, docker-compose.yml or Helm script values.yaml:

SMTP_DKIM_DOMAINNAME=<your e-mail sender domain>
SMTP_DKIM_KEYSELECTOR=ocelot # "free" name used in DNS as selector. we recommend this
SMTP_DKIM_PRIVATKEY="-----BEGIN RSA PRIVATE KEY-----\\n<your base64 encoded private 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 as DNS records with selector, 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

Neo4j Database

We have several configuration options for our Neo4j database.

DBMS_DEFAULT_DATABASE Default Database Name to be Used

If you need to set the default database name in Neo4j to be used for all operations and terminal commands like our backup scripts, you must set the appropriate environment variable in: .env, docker-compose.yml or Helm script values.yaml:

DBMS_DEFAULT_DATABASE: "graph.db"

The default value is neo4j if it is not set.

As example see files:

  • neo4j/.env.template
  • deployment/docker-compose.yml
  • deployment/configurations/stage.ocelot.social/kubernetes/values.yaml.template