Add instructions to put config.json inside public/
This commit is contained in:
parent
62988e6b46
commit
12079ded4f
2 changed files with 6 additions and 4 deletions
2
.gitignore
vendored
2
.gitignore
vendored
|
@ -5,4 +5,4 @@ dist
|
||||||
dist-ssr
|
dist-ssr
|
||||||
*.local
|
*.local
|
||||||
.idea/
|
.idea/
|
||||||
config.json
|
public/config.json
|
||||||
|
|
|
@ -16,9 +16,10 @@ git clone https://github.com/vector-im/element-call.git
|
||||||
cd element-call
|
cd element-call
|
||||||
yarn
|
yarn
|
||||||
cp .env.example .env
|
cp .env.example .env
|
||||||
|
cp sample.config.json public/config.json
|
||||||
```
|
```
|
||||||
|
|
||||||
You can now edit the configuration in `.env` to your liking. The most important thing is to set `VITE_DEFAULT_HOMESERVER` to the homeserver that the app should use, such as `https://call.ems.host`.
|
You can now edit the configuration in `.env` and `public/config.json` to your liking. (See the [configuration](#Configuration) section for details.) The most important thing is to set `VITE_DEFAULT_HOMESERVER` to the homeserver that the app should use, such as `https://call.ems.host`.
|
||||||
|
|
||||||
Next, build the project:
|
Next, build the project:
|
||||||
|
|
||||||
|
@ -59,6 +60,7 @@ cd element-call
|
||||||
yarn
|
yarn
|
||||||
yarn link matrix-js-sdk
|
yarn link matrix-js-sdk
|
||||||
cp .env.example .env
|
cp .env.example .env
|
||||||
|
cp sample.config.json public/config.json
|
||||||
```
|
```
|
||||||
|
|
||||||
By default, the app expects you to have [Synapse](https://matrix-org.github.io/synapse/latest/setup/installation.html) installed locally and running on port 8008. If you wish to use another homeserver, you can set it in your `.env` file.
|
By default, the app expects you to have [Synapse](https://matrix-org.github.io/synapse/latest/setup/installation.html) installed locally and running on port 8008. If you wish to use another homeserver, you can set it in your `.env` file.
|
||||||
|
@ -69,9 +71,9 @@ You're now ready to launch the development server:
|
||||||
yarn dev
|
yarn dev
|
||||||
```
|
```
|
||||||
|
|
||||||
## Config
|
## Configuration
|
||||||
|
|
||||||
Configuration options are documented in the `.env` file.
|
There are currently two different config files. `.env` holds variables that are used at build time, while `public/config.json` holds variables that are used at runtime. Documentation and default values for `public/config.json` can be found in [ConfigOptions.ts](src/config/ConfigOptions.ts).
|
||||||
|
|
||||||
## Translation
|
## Translation
|
||||||
|
|
||||||
|
|
Loading…
Add table
Reference in a new issue