Skip to content

Commit

Permalink
Update readme, add dummy ci for cabotage
Browse files Browse the repository at this point in the history
  • Loading branch information
ewdurbin committed Jun 25, 2024
1 parent 02e2187 commit e12418a
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 38 deletions.
12 changes: 12 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -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"
42 changes: 4 additions & 38 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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].

<!-- Links -->
[git-tags]: https://github.com/42wim/matterbridge/tags
[config]: config/config-heroku-template.toml
[config]: config/config-template.toml

0 comments on commit e12418a

Please sign in to comment.