Skip to content

Commit

Permalink
chore: Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
stmh committed Dec 10, 2024
1 parent 1430549 commit 15fe655
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,9 @@ Here's a short list of avaiable commands
app (similar to `docker-compose rm`)
* `scottyctl app:create` Create a new app
* `scottyctl app:destroy` Destroy a managed app
* `scottyctl app:migrate <app_name>` Migrates a legacy app, so it can be
controlled by scotty. Please not that most likely you need to adjust the
created `.scotty.yml` file to match your needs.
* `scottyctl app:info` Display some info about the app
* `scottyctl notify:add` Adds a new service to notify on app changes
* `scottyctl notify:remove` Removes a notification to a service
Expand Down Expand Up @@ -241,12 +244,12 @@ You can provide the information either via env-vars or by passing the

## Notifications

Scotty supports notifications to other services, e.g. Gitlab, Mattermost or
via webhooks. Notifications recipients need to be configured on the server
Scotty supports notifications to other services, e.g. Gitlab, Mattermost or
via webhooks. Notifications recipients need to be configured on the server
side, but `scottyctl` can provide parameters to steer the delivery, e.g.
the channel-name for mattermost or the merge-request-id for gitlab.

Here's a config-sample-snippet for mattermost (Create an incoming webhook
Here's a config-sample-snippet for mattermost (Create an incoming webhook
and note down the hook_id):

```yaml
Expand Down

0 comments on commit 15fe655

Please sign in to comment.