Skip to content

Commit

Permalink
Add instructions to put config.json inside public/
Browse files Browse the repository at this point in the history
  • Loading branch information
robintown committed Nov 9, 2022
1 parent 62988e6 commit 12079de
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ dist
dist-ssr
*.local
.idea/
config.json
public/config.json
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,10 @@ git clone https://github.com/vector-im/element-call.git
cd element-call
yarn
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:

Expand Down Expand Up @@ -59,6 +60,7 @@ cd element-call
yarn
yarn link matrix-js-sdk
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.
Expand All @@ -69,9 +71,9 @@ You're now ready to launch the development server:
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

Expand Down

0 comments on commit 12079de

Please sign in to comment.