Matrix-Mirrors/mjolnir
1
0
Fork 0
mirror of https://github.com/matrix-org/mjolnir.git synced 2024-10-01 01:36:06 -04:00
Code Issues Packages Projects Releases Wiki Activity

Update setup_selfbuild.md to have more specific instructions (#434)

Browse Source
This commit is contained in:
Stefan 2022-12-09 13:22:13 +01:00 committed by GitHub
parent dafbd20393
commit 7534fbc73c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/setup_selfbuild.md
View File

@ -1,17 +1,20 @@
These instructions are to build and run mjolnir without using [Docker](./setup_docker.md).
You need to have installed `yarn` 1.x and Node 16.
To build mjolnir, you have to have installed [Node >=16](https://nodejs.org/en/download/), [npm](https://docs.npmjs.com/cli/v7/configuring-npm/install) and [yarn >1.x](https://classic.yarnpkg.com/en/docs/install).
Copy the latest release tag from https://github.com/matrix-org/mjolnir/releases/latest/ to use when cloning. For example `v1.6.1` - please check the link for the current version as this mentioned example might be outdated.
```bash
git clone https://github.com/matrix-org/mjolnir.git
git clone https://github.com/matrix-org/mjolnir.git --branch <release tag>
cd mjolnir
yarn install
yarn build
# Copy and edit the config. It *is* recommended to change the data path,
# Copy and edit the config. It *is* recommended to change `dataPath`,
# as this is set to `/data` by default for dockerized mjolnir.
cp config/default.yaml config/production.yaml
nano config/production.yaml
# Start Mjolnir and use production.yaml (instead of default.yaml)
node lib/index.js --mjolnir-config ./config/production.yaml
```