mjolnir/docs/setup_selfbuild.md

These instructions are to build and run mjolnir without using [Docker](./setup_docker.md).
To build mjolnir, you have to have installed [Node >=18](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 --branch <release tag>
cd mjolnir

yarn install
yarn build

# 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
```
Update selfbuld docs to no longer require on old behaviour. (#429) The package we used to load config in the past, `node-config`, would default to `development`. https://github.com/node-config/node-config/blob/f54b41990095c2b340ae129dfd8f623da1dfa20d/lib/config.js#L561 https://github.com/matrix-org/mjolnir/pull/347 2022-11-22 05:38:04 -05:00			`These instructions are to build and run mjolnir without using [Docker](./setup_docker.md).`
Bump node version to 18 (#496) * try win dns res * add dns hack to application service tests * fix unused import * update types * add note about why dns resolution order is necessary 2023-11-14 15:52:53 -05:00			`To build mjolnir, you have to have installed [Node >=18](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).`
Update setup_selfbuild.md to have more specific instructions (#434) 2022-12-09 07:22:13 -05:00
			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.
Improve documentation (#277) * improve documentation * incorperate documentation of configuration into sample file 2022-05-20 07:19:26 -04:00
			```bash
Update setup_selfbuild.md to have more specific instructions (#434) 2022-12-09 07:22:13 -05:00			`git clone https://github.com/matrix-org/mjolnir.git --branch <release tag>`
Improve documentation (#277) * improve documentation * incorperate documentation of configuration into sample file 2022-05-20 07:19:26 -04:00			`cd mjolnir`

			`yarn install`
			`yarn build`

Update setup_selfbuild.md to have more specific instructions (#434) 2022-12-09 07:22:13 -05:00			# Copy and edit the config. It is recommended to change `dataPath`,
Update selfbuld docs to no longer require on old behaviour. (#429) The package we used to load config in the past, `node-config`, would default to `development`. https://github.com/node-config/node-config/blob/f54b41990095c2b340ae129dfd8f623da1dfa20d/lib/config.js#L561 https://github.com/matrix-org/mjolnir/pull/347 2022-11-22 05:38:04 -05:00			# as this is set to `/data` by default for dockerized mjolnir.
			`cp config/default.yaml config/production.yaml`
			`nano config/production.yaml`
Improve documentation (#277) * improve documentation * incorperate documentation of configuration into sample file 2022-05-20 07:19:26 -04:00
Update setup_selfbuild.md to have more specific instructions (#434) 2022-12-09 07:22:13 -05:00			`# Start Mjolnir and use production.yaml (instead of default.yaml)`
Config fixes (#432) * Use the npm package `config` to load the config. This is what was used prior to https://github.com/matrix-org/mjolnir/pull/347. It was a nice idea motivated to drop a dependency that was confusing. It was just never followed through and was underestimated how much disruption it would cause. It was also believed that the library would mean there could only ever be one global copy of the config, It was followed up by: https://github.com/matrix-org/mjolnir/pull/369 https://github.com/matrix-org/mjolnir/pull/357 https://github.com/matrix-org/mjolnir/pull/429 https://github.com/matrix-org/mjolnir/pull/397/files https://github.com/matrix-org/mjolnir/issues/365 For simplicity sake I am reinstating the library. The practice of loading default.yaml by default is also dangerous and has led to issues multiple times in #mjolnir:matrix.org. It is a sample and not a default. In a following commit I will be adding the ability to specify the config to use from the cli. * Allow config to be specified with an explicit cli argument. * Update doc to transition away from old config handling 2022-11-23 05:55:22 -05:00			`node lib/index.js --mjolnir-config ./config/production.yaml`
Bump minimum node version to 16. (#316) * Bump minimum node version to 16. We already made the mistake of using features from 16 without realising Previously: https://github.com/matrix-org/mjolnir/pull/192 * Make sure CI uses specific version of node and we also lint. https://github.com/matrix-org/pipelines/blob/master/mjolnir/pipeline.yml#L13 2022-07-06 09:50:33 -04:00			```