-
-
Notifications
You must be signed in to change notification settings - Fork 2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Improve debian package and docs (#26618)
- Loading branch information
Showing
5 changed files
with
86 additions
and
80 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| /usr/share/element-web/config.json | ||
| /etc/element-web/config.json |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| # Installing Element Web | ||
|
|
||
| **Familiarise yourself with the [Important Security Notes](../README.md#important-security-notes) before starting, they apply to all installation methods.** | ||
|
|
||
| _Note: that for the security of your chats will need to serve Element over HTTPS. | ||
| Major browsers also do not allow you to use VoIP/video chats over HTTP, as WebRTC is only usable over HTTPS. | ||
| There are some exceptions like when using localhost, which is considered a [secure context](https://developer.mozilla.org/docs/Web/Security/Secure_Contexts) and thus allowed._ | ||
|
|
||
| ## Release tarball | ||
|
|
||
| 1. Download the latest version from <https://github.com/vector-im/element-web/releases> | ||
| 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. 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 at <https://packages.element.io/element-release-key.asc>. | ||
|
|
||
| ## Debian package | ||
|
|
||
| Element Web is now also available as a Debian package for Debian and Ubuntu based systems. | ||
|
|
||
| ```shell | ||
| sudo apt install -y wget apt-transport-https | ||
| sudo wget -O /usr/share/keyrings/element-io-archive-keyring.gpg https://packages.element.io/debian/element-io-archive-keyring.gpg | ||
| echo "deb [signed-by=/usr/share/keyrings/element-io-archive-keyring.gpg] https://packages.element.io/debian/ default main" | sudo tee /etc/apt/sources.list.d/element-io.list | ||
| sudo apt update | ||
| sudo apt install element-web | ||
| ``` | ||
|
|
||
| Configure the app by modifying `/etc/element-web/config.json`. See the [configuration docs](docs/config.md) for details. | ||
|
|
||
| ## Docker | ||
|
|
||
| The Docker image can be used to serve element-web as a web server. The easiest way to use | ||
| it is to use the prebuilt image: | ||
|
|
||
| ```bash | ||
| docker run -p 80:80 vectorim/element-web | ||
| ``` | ||
|
|
||
| To supply your own custom `config.json`, map a volume to `/app/config.json`. For example, | ||
| if your custom config was located at `/etc/element-web/config.json` then your Docker command | ||
| would be: | ||
|
|
||
| ```bash | ||
| docker run -p 80:80 -v /etc/element-web/config.json:/app/config.json vectorim/element-web | ||
| ``` | ||
|
|
||
| To build the image yourself: | ||
|
|
||
| ```bash | ||
| git clone https://github.com/vector-im/element-web.git element-web | ||
| cd element-web | ||
| git checkout master | ||
| docker build . | ||
| ``` | ||
|
|
||
| If you're building a custom branch, or want to use the develop branch, check out the appropriate | ||
| element-web branch and then run: | ||
|
|
||
| ```bash | ||
| docker build -t \ | ||
| --build-arg USE_CUSTOM_SDKS=true \ | ||
| --build-arg REACT_SDK_REPO="https://github.com/matrix-org/matrix-react-sdk.git" \ | ||
| --build-arg REACT_SDK_BRANCH="develop" \ | ||
| --build-arg JS_SDK_REPO="https://github.com/matrix-org/matrix-js-sdk.git" \ | ||
| --build-arg JS_SDK_BRANCH="develop" \ | ||
| . | ||
| ``` | ||
|
|
||
| ## Kubernetes | ||
|
|
||
| The provided element-web docker image can also be run from within a Kubernetes cluster. | ||
| See the [Kubernetes example](docs/kubernetes.md) for more details. |