Skip to content

Commit

Permalink
Adopt README
Browse files Browse the repository at this point in the history
  • Loading branch information
tschaefer committed Dec 22, 2024
1 parent 92c2481 commit 5f55996
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 0 deletions.
Binary file added .screenshots/supervisor-dashboard.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ Supervisor is a Docker GitOps service that allows you to manage `docker-compose`
* [Delete Stack](#delete-stack)
* [Get Stack Log](#get-stack-log)
* [Control Stack](#control-stack)
* [Dashboard](#dashboard)
* [License](#license)
* [Is it any good?](#is-it-any-good)

Expand Down Expand Up @@ -236,6 +237,17 @@ curl --request POST \
https://supervisor.example.com/stacks/<stack_uuid>/control
```

## Dashboard

Supervisor provides a simple dashboard to view and manage stacks. The
dashboard is accessible at the URL path `/dashboard` of the Supervisor service.
The access is restricted by basic authentication. The credentials are set
via the environment variables `SUPERVISOR_DASHBOARD_USERNAME` and
`SUPERVISOR_DASHBOARD_PASSWORD`. The default credentials username is
`supervisor` and the password is `supervisor` as well.

![Dashboard view](.screenshots/supervisor-dashboard.jpg "Dashboard view")

## License

Supervisor is released under the [MIT License](https://opensource.org/licenses/MIT).
Expand Down

0 comments on commit 5f55996

Please sign in to comment.