diff --git a/deployment/TODO-next-update.md b/deployment/TODO-next-update.md index 591ce899f7..76b7ab56c5 100644 --- a/deployment/TODO-next-update.md +++ b/deployment/TODO-next-update.md @@ -2,9 +2,20 @@ When you introduce a new version and branding and deploy it on your network, you need to consider the following changes and actions: -## Version >= 3.3.0 with 'ocelotDockerVersionTag' 3.3.0-XXX +## Version >= 3.1.3 with 'ocelotDockerVersionTag' 3.1.3-XXX -- We have the new option to configure DKIM for sent e-mails in environment variables (`.env` or `values.yaml`), see [deployment-values.md](deployment-values.md): +- We have the new option to configure the default name of the Neo4j database to be used for operations and commands in environment variables (`.env`, `docker-compose.yml` or `values.yaml`). +For more details see [deployment-values.md](deployment-values.md): + +```yaml +DBMS_DEFAULT_DATABASE: "graph.db" +``` + +The default value is `neo4j` if it is not set. + +## Version >= 3.1.0 with 'ocelotDockerVersionTag' 3.1.0-555 + +- We have the new option to configure DKIM for sent e-mails in environment variables (`.env`, `docker-compose.yml` or `values.yaml`), see [deployment-values.md](deployment-values.md): - `SMTP_DKIM_DOMAINNAME=` - `SMTP_DKIM_KEYSELECTOR=` - `SMTP_DKIM_PRIVATKEY=` diff --git a/deployment/deployment-values.md b/deployment/deployment-values.md index 300a056dd5..0354ca8bb2 100644 --- a/deployment/deployment-values.md +++ b/deployment/deployment-values.md @@ -17,7 +17,7 @@ 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: +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`: ```bash SMTP_DKIM_DOMAINNAME= @@ -36,3 +36,23 @@ To create the private and public DKIM key, see here: Information about the required PEM format can be found here: + +## 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`: + +```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` diff --git a/neo4j/.env.template b/neo4j/.env.template index c58edee0ec..c22b27b5d9 100644 --- a/neo4j/.env.template +++ b/neo4j/.env.template @@ -1,2 +1,3 @@ NEO4J_USERNAME=neo4j NEO4J_PASSWORD=letmein +# DBMS_DEFAULT_DATABASE="neo4j" \ No newline at end of file