PrivateCoffee/element-web
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 3

Improve install.md docs

Browse source
This commit is contained in:
Michael Telatynski 2023-12-13 14:53:58 +00:00 committed by GitHub
parent 1038500e71
commit fc1f706540
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
docs/install.md
View file

@ -13,7 +13,7 @@ There are some exceptions like when using localhost, which is considered a [secu
1. Move (or symlink) the `element-x.x.x` directory to an appropriate name 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 correct caching headers in your webserver (see below)
1. Configure the app by copying `config.sample.json` to `config.json` and 1. Configure the app by copying `config.sample.json` to `config.json` and
modifying it. See the [configuration docs](docs/config.md) for details. modifying it. See the [configuration docs](config.md) for details.
1. Enter the URL into your browser and log into Element! 1. Enter the URL into your browser and log into Element!
Releases are signed using gpg and the OpenPGP standard, Releases are signed using gpg and the OpenPGP standard,
@ -31,7 +31,9 @@ sudo apt update
sudo apt install element-web sudo apt install element-web
``` ```
Configure the app by modifying `/etc/element-web/config.json`. See the [configuration docs](docs/config.md) for details. Configure the app by modifying `/etc/element-web/config.json`. See the [configuration docs](config.md) for details.
Then point your chosen web server (e.g. Caddy, Nginx, Apache, etc) at the `/usr/share/element-web` webroot.
## Docker ## Docker
@ -75,4 +77,4 @@ docker build -t \
## Kubernetes ## Kubernetes
The provided element-web docker image can also be run from within a Kubernetes cluster. 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. See the [Kubernetes example](kubernetes.md) for more details.