aboutsummaryrefslogtreecommitdiff
path: root/docs/installation/helm/1_helm.md
diff options
context:
space:
mode:
authorTill <2353100+S7evinK@users.noreply.github.com>2023-05-30 10:02:53 +0200
committerGitHub <noreply@github.com>2023-05-30 10:02:53 +0200
commitf956a8c1d9172f6bbfb9f7515feacd477a0e35f5 (patch)
tree18a02759cc674eb79b3b1b1168abd3d6d5a65e54 /docs/installation/helm/1_helm.md
parent11b557097c6745309c09b58f681080d3fcc4f9f5 (diff)
Docs restructure (#2953)
Needs to be merged into `gh-pages` later on.
Diffstat (limited to 'docs/installation/helm/1_helm.md')
-rw-r--r--docs/installation/helm/1_helm.md58
1 files changed, 58 insertions, 0 deletions
diff --git a/docs/installation/helm/1_helm.md b/docs/installation/helm/1_helm.md
new file mode 100644
index 00000000..00fe4fdc
--- /dev/null
+++ b/docs/installation/helm/1_helm.md
@@ -0,0 +1,58 @@
+---
+title: Installation
+parent: Helm
+grand_parent: Installation
+has_toc: true
+nav_order: 1
+permalink: /installation/helm/install
+---
+
+# Installing Dendrite using Helm
+
+To install Dendrite using the Helm chart, you first have to add the repository using the following commands:
+
+```bash
+helm repo add dendrite https://matrix-org.github.io/dendrite/
+helm repo update
+```
+
+Next you'll need to create a `values.yaml` file and configure it to your liking. All possible values can be found
+[here](https://github.com/matrix-org/dendrite/blob/main/helm/dendrite/values.yaml), but at least you need to configure
+a `server_name`, otherwise the chart will complain about it:
+
+```yaml
+dendrite_config:
+ global:
+ server_name: "localhost"
+```
+
+If you are going to use an existing Postgres database, you'll also need to configure this connection:
+
+```yaml
+dendrite_config:
+ global:
+ database:
+ connection_string: "postgresql://PostgresUser:PostgresPassword@PostgresHostName/DendriteDatabaseName"
+ max_open_conns: 90
+ max_idle_conns: 5
+ conn_max_lifetime: -1
+```
+
+## Installing with PostgreSQL
+
+The chart comes with a dependency on Postgres, which can be installed alongside Dendrite, this needs to be enabled in
+the `values.yaml`:
+
+```yaml
+postgresql:
+ enabled: true # this installs Postgres
+ primary:
+ persistence:
+ size: 1Gi # defines the size for $PGDATA
+
+dendrite_config:
+ global:
+ server_name: "localhost"
+```
+
+Using this option, the `database.connection_string` will be set for you automatically. \ No newline at end of file