aboutsummaryrefslogtreecommitdiff
path: root/docs/installation/manual/1_build.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/installation/manual/1_build.md')
-rw-r--r--docs/installation/manual/1_build.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/docs/installation/manual/1_build.md b/docs/installation/manual/1_build.md
new file mode 100644
index 00000000..73a62688
--- /dev/null
+++ b/docs/installation/manual/1_build.md
@@ -0,0 +1,33 @@
+---
+title: Building/Installing Dendrite
+parent: Manual
+grand_parent: Installation
+has_toc: true
+nav_order: 1
+permalink: /installation/manual/build
+---
+
+# Build all Dendrite commands
+
+Dendrite has numerous utility commands in addition to the actual server binaries.
+Build them all from the root of the source repo with:
+
+```sh
+go build -o bin/ ./cmd/...
+```
+
+The resulting binaries will be placed in the `bin` subfolder.
+
+# Installing Dendrite
+
+You can install the Dendrite binary into `$GOPATH/bin` by using `go install`:
+
+```sh
+go install ./cmd/dendrite
+```
+
+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
+```