aboutsummaryrefslogtreecommitdiff
path: root/docs/installation/6_install_polylith.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/installation/6_install_polylith.md')
-rw-r--r--docs/installation/6_install_polylith.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/docs/installation/6_install_polylith.md b/docs/installation/6_install_polylith.md
new file mode 100644
index 00000000..375512f8
--- /dev/null
+++ b/docs/installation/6_install_polylith.md
@@ -0,0 +1,33 @@
+---
+title: Installing as a polylith
+parent: Installation
+has_toc: true
+nav_order: 6
+permalink: /installation/install/polylith
+---
+
+# Installing as a polylith
+
+You can install the Dendrite polylith binary into `$GOPATH/bin` by using `go install`:
+
+```sh
+go install ./cmd/dendrite-polylith-multi
+```
+
+Alternatively, you can specify a custom path for the binary to be written to using `go build`:
+
+```sh
+go build -o /usr/local/bin/ ./cmd/dendrite-polylith-multi
+```
+
+The `dendrite-polylith-multi` binary is a "multi-personality" binary which can run as
+any of the components depending on the supplied command line parameters.
+
+## Reverse proxy
+
+Polylith deployments require a reverse proxy in order to ensure that requests are
+sent to the correct endpoint. You must ensure that a suitable reverse proxy is installed
+and configured.
+
+A [sample configuration file](https://github.com/matrix-org/dendrite/blob/main/docs/nginx/polylith-sample.conf)
+is provided for [NGINX](https://www.nginx.com).