Skip to content

Latest commit

 

History

History
52 lines (31 loc) · 2.66 KB

README.md

File metadata and controls

52 lines (31 loc) · 2.66 KB

GoAlert

GoAlert provides on-call scheduling, automated escalations and notifications (like SMS or voice calls) to automatically engage the right person, the right way, and at the right time.

main-screen-updated

Installation

GoAlert is distributed as a single binary with release notes available from the GitHub Releases page. Additionally, images are published on Docker Hub for each release. The latest tag is the most recent release, and nightly is the latest build from the master branch.

See our Getting Started Guide for running GoAlert in a production environment.

Quick Start

docker run -it --rm -p 8081:8081 goalert/demo

GoAlert will be running at localhost:8081. You can log in with admin/admin123.

If you're using the demo container for integration testing:

  • A non-admin user is available as user/user1234.
  • You can specify the ENV variable SKIP_SEED=1 to skip the initial seed data step.
  • You can get a session token via curl -XPOST -H 'Referer: http://localhost:8081' -d 'username=admin&password=admin123' 'http://localhost:8081/api/v2/identity/providers/basic?noRedirect=1'.

Contributing (Local Development)

If you'd like to contribute to GoAlert, please see our Contributing Guidelines and the Development Setup Guide.

Please also see our Code of Conduct.

For most purposes, you can use make start from the root of this repo to start a development server.

  • It will be running at http://localhost:3030
  • Default login is admin/admin123
  • Changes you make locally, UI and backend, should be reflected in the running server within a few seconds (no need to restart the server).

Contact Us

If you need help or have a question, the #goalert Slack channel is available on gophers.slack.com.

To access Gophers Slack and the #goalert channel, you will need an invitation. You request one through the automated process here: https://invite.slack.golangbridge.org/

License

GoAlert is licensed under the Apache License, Version 2.0.