From e12418a23985c8e3a57c2d8f14d709429506bdec Mon Sep 17 00:00:00 2001 From: Ee Durbin Date: Tue, 25 Jun 2024 10:51:17 -0400 Subject: [PATCH] Update readme, add dummy ci for cabotage --- .github/workflows/ci.yml | 12 ++++++++++++ README.md | 42 ++++------------------------------------ 2 files changed, 16 insertions(+), 38 deletions(-) create mode 100644 .github/workflows/ci.yml diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..01baad5 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,12 @@ +name: CI +on: + push: + branches: + - main + pull_request: +jobs: + test: + runs-on: ubuntu-latest + steps: + - name: Dummy CI + run: echo "OK" diff --git a/README.md b/README.md index ba195fb..b39182a 100644 --- a/README.md +++ b/README.md @@ -1,45 +1,12 @@ -# Matterbridge-Heroku +# Matterbridge -[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy) - -An inline buildpack for hosting Matterbridge on Heroku. - -[**Heroku**][heroku] is a platform for easily deploying applications. - -A [**buildpack**][buildpacks] provides framework and runtime support for -apps running on platforms like Heroku. - -An [**_inline_ buildpack**][inline-buildpacks] is a special buildpack -that includes code for both the app and the buildpack that _runs_ the -app. - -[**Matterbridge**][matterbridge] is a simple _bridge_ that can relay -messages between a number of different chat services, essentially -connecting separate chat tools. - - [heroku]: https://www.heroku.com/what - [buildpacks]: https://docs.cloudfoundry.org/buildpacks/ - [inline-buildpacks]: https://github.com/kr/heroku-buildpack-inline#readme - [matterbridge]: https://github.com/42wim/matterbridge#readme - -This repo includes [a custom config file][config] specific to a sample -implementation, but this is intended to be modified in your own fork. +This repository holds the configuration of the PSF matterbridge instance ## Configuration Configuration happens via environment variables and a configuration template file. -### Environment: Buildpack - -- `MATTERBRIDGE_VERSION` Required. Use a [matterbridge git tag][git-tags]. -- `MATTERBRIDGE_URL` Optional. Use this to download the binary from a - custom url instead of the tagged release from the official GitHub -repo. (Setting this makes `MATTERBRIDGE_VERSION` ignored.) - * With caution, you may want to use the [latest nightly matterbridge - build](https://bintray.com/42wim/nightly/Matterbridge/_latestVersion) - while waiting on the next official release. - ### Environment: Matterbridge Matterbridge has some configuration of its own, which is mostly @@ -70,8 +37,7 @@ configuration file template. ### Template: Matterbridge -* Edit channel bridge config via [`config/config-heroku-template.toml`][config]. +* Edit channel bridge config via [`config/config-template.toml`][config]. - [git-tags]: https://github.com/42wim/matterbridge/tags - [config]: config/config-heroku-template.toml + [config]: config/config-template.toml