From 865fc98336a1505f268065f8d85dd8e2452903df Mon Sep 17 00:00:00 2001 From: csett86 Date: Thu, 19 Aug 2021 12:12:27 +0200 Subject: [PATCH] Add github action that packages a release tarball (#148) Change-Id: I368a834a27f69550596a041c1e6b84afd40011b7 --- .github/workflows/github-release.yml | 28 ++++++++++++++++++++++++++++ README.md | 18 ++++++++++++++---- 2 files changed, 42 insertions(+), 4 deletions(-) create mode 100644 .github/workflows/github-release.yml diff --git a/.github/workflows/github-release.yml b/.github/workflows/github-release.yml new file mode 100644 index 0000000..02a8d2c --- /dev/null +++ b/.github/workflows/github-release.yml @@ -0,0 +1,28 @@ +name: Create release tarball and attach to tag + +on: + push: + tags: + - "*" + +jobs: + build: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v2 + - uses: actions/setup-node@v2 + with: + node-version: "14" + - run: yarn install + - run: yarn build + - run: | + version=`git describe --dirty --tags || echo unknown` + mkdir -p dist + cp -r build synapse-admin-$version + tar chvzf dist/synapse-admin-$version.tar.gz synapse-admin-$version + - uses: softprops/action-gh-release@b7e450da2a4b4cb4bfbae528f788167786cfcedf + with: + files: dist/*.tar.gz + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/README.md b/README.md index e6c9780..96ab28c 100644 --- a/README.md +++ b/README.md @@ -21,13 +21,23 @@ See also [Synapse administration endpoints](https://matrix-org.github.io/synapse ## Step-By-Step install: -You have two options: +You have three options: -1. Download the source code from github and run using nodejs -2. Run the Docker container +1. Download the tarball and serve with any webserver +2. Download the source code from github and run using nodejs +3. Run the Docker container 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 +- download the .tar.gz from the latest release: https://github.com/Awesome-Technologies/synapse-admin/releases/latest +- unpack the .tar.gz +- 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): + - make sure you have installed the following: git, yarn, nodejs - download the source code: `git clone https://github.com/Awesome-Technologies/synapse-admin.git` - change into downloaded directory: `cd synapse-admin` @@ -39,7 +49,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 2): +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`