diff --git a/README.md b/README.md index 75049acdaec..5d35bf74975 100644 --- a/README.md +++ b/README.md @@ -41,8 +41,9 @@ released version of Element: 1. Untar the tarball on your web server 1. Move (or symlink) the `element-x.x.x` directory to an appropriate name 1. Configure the correct caching headers in your webserver (see below) -1. Configure the app by copying `config.sample.json` to `config.json` and - modifying it. See the [configuration docs](docs/config.md) for details. +1. Configure the app by making a copy of the `config.sample.json` and renaming it as + `config.json` within the same directory. You can also customize it. See the + [configuration docs](docs/config.md) for details. 1. Enter the URL into your browser and log into Element! Releases are signed using gpg and the OpenPGP standard, and can be checked against the public key located @@ -132,9 +133,10 @@ guide](https://classic.yarnpkg.com/en/docs/install) if you do not have it alread environment](#setting-up-a-dev-environment) below). Alternatively, you can use - the continuous integration release of the develop branch. -1. Configure the app by copying `config.sample.json` to `config.json` and - modifying it. See the [configuration docs](docs/config.md) for details. -1. `yarn dist` to build a tarball to deploy. Untaring this file will give +1. Configure the app by making a copy of the `config.sample.json` and renaming it as +`config.json` within the same directory. You can also customize it. See the +[configuration docs](docs/config.md) for details. +3. `yarn dist` to build a tarball to deploy. Untaring this file will give a version-specific directory containing all the files that need to go on your web server. @@ -311,9 +313,12 @@ Clone the repo and switch to the `element-web` directory: git clone https://github.com/vector-im/element-web.git cd element-web ``` +The `matrix-js-sdk`, `matrix-react-sdk` and `element-web` folders should be at the same level. -Configure the app by copying `config.sample.json` to `config.json` and -modifying it. See the [configuration docs](docs/config.md) for details. + +Configure the app by making a copy of the `config.sample.json` and renaming it as +`config.json` within the same directory. You can also customize it. +See the [configuration docs](docs/config.md) for details. Finally, build and start Element itself: diff --git a/docs/config.md b/docs/config.md index 833754e107f..0fcf47cb06d 100644 --- a/docs/config.md +++ b/docs/config.md @@ -1,8 +1,8 @@ # Configuration -You can configure the app by copying `config.sample.json` to `config.json` and customising it. The possible options are -described here. If you run into issues, please visit [#element-web:matrix.org](https://matrix.to/#/#element-web:matrix.org) -on Matrix. +You can configure the app by making a copy of the `config.sample.json` and renaming it as `config.json` +within the same directory. The possible options are described here. If you run into issues, please visit +[#element-web:matrix.org](https://matrix.to/#/#element-web:matrix.org) on Matrix. For a good example of a production-tuned config, see https://app.element.io/config.json