Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update setup_selfbuild.md #397

Closed
wants to merge 5 commits into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
13 changes: 8 additions & 5 deletions docs/setup_selfbuild.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,18 @@
To build mjolnir, you have 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).

Get the latest release-version https://github.com/matrix-org/mjolnir/releases/latest/ - for example `v1.6.0`.

```bash
git clone https://github.com/matrix-org/mjolnir.git
git clone https://github.com/matrix-org/mjolnir.git --branch v1.6.0
cd mjolnir

yarn install
yarn build

# Copy and edit the config. It *is* recommended to change the data path.
cp config/default.yaml config/development.yaml
nano config/development.yaml
cp config/default.yaml config/production.yaml
nano config/production.yaml

node lib/index.js
# Start Mjolnir and make use of the production.yaml (instead of default.yaml)
NODE_ENV=production node lib/index.js
```