diff --git a/README.md b/README.md index 85ee974..f4e9a94 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,10 @@ You need access to the following endpoints: See also [Synapse administration endpoints](https://matrix-org.github.io/synapse/develop/reverse_proxy.html#synapse-administration-endpoints) -## Step-By-Step install +## How To Use +Besides from installing the tool yourself (see section below), you can use the deployed version on our [GitHub Pages](https://awesome-technologies.github.io/synapse-admin/). + +### Step-By-Step install You have three options: @@ -27,7 +30,7 @@ You have three options: 2. [Download the source code from github and run using nodejs](#steps-for-2) 3. [Run the Docker container](#steps-for-3) -### Steps for 1) +#### Steps for 1) - make sure you have a webserver installed that can serve static files (any webserver like nginx or apache will do) - configure a vhost for synapse admin on your webserver @@ -36,7 +39,7 @@ You have three options: - move or symlink the `synapse-admin-x.x.x` into your vhosts root dir - open the url of the vhost in your browser -### Steps for 2) +#### Steps for 2) - make sure you have installed the following: git, yarn, nodejs - download the source code: `git clone https://github.com/Awesome-Technologies/synapse-admin.git` @@ -49,7 +52,7 @@ Either you define it at startup (e.g. `REACT_APP_SERVER=https://yourmatrixserver or by editing it in the [.env](.env) file. See also the [documentation](https://create-react-app.dev/docs/adding-custom-environment-variables/). -### Steps for 3) +#### Steps for 3) - run the Docker container from the public docker registry: `docker run -p 8080:80 awesometechnologies/synapse-admin` or use the [docker-compose.yml](docker-compose.yml): `docker-compose up -d`