https://github.com/sensu/web
Open-source Web UI for Sensu Go clusters
https://github.com/sensu/web
apollo looking-for-maintainer react sensu sensu-go
Last synced: 5 months ago
JSON representation
Open-source Web UI for Sensu Go clusters
- Host: GitHub
- URL: https://github.com/sensu/web
- Owner: sensu
- License: mit
- Created: 2019-03-28T23:21:11.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-07-24T15:04:52.000Z (about 2 years ago)
- Last Synced: 2025-04-03T11:36:33.035Z (6 months ago)
- Topics: apollo, looking-for-maintainer, react, sensu, sensu-go
- Language: TypeScript
- Homepage:
- Size: 78.6 MB
- Stars: 30
- Watchers: 15
- Forks: 26
- Open Issues: 56
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
Sensu Go Web
A web interface for insight and management of your Sensu Go clusters.
## Roadmap
As of version 6.0, the official Sensu web app has moved to the commercial product codebase. Users who want an officially supported web app for use with Sensu Go should try the commercial distribution available at https://sensu.io/downloads
Users who download and compile Sensu Go from source and want a web UI will need to download and run this web app as a separate component (see [INSTALL.md](INSTALL.md)). Please note that the web interface included in the commercial distribution no longer shares a common codebase with this project. For more details regarding these changes, please see [Building a better UI for Sensu].
### Goals
The primary goal of this project was to offer a simple web interface that provides visibility into Sensu Go's "stateful" data (e.g., real-time invetory and real-time event dashboards). At this time, this includes the following:
* Basic auth (login using Sensu Go user credentials)
* Namespace switching
* Views reflecting event, entity, and silence state. (Scoped by namespace.)
### Non-Goals
This project does not aim to provide a web-based interface for every feature of the open-source Sensu Go platform, specifically including the configuration of Sensu Go pipelines. As a result, certain features of this project may break with new releases of Sensu Go. The Sensu Engineering team will review and merge PRs submitted by the community, and/or periodically publish new releases to mark certain features as "deprecated" (or just remove them).
_NOTE: although "PRs are **always** welcome" (!), any PR which implements features that are non-goals of this project may be closed as "won't fix". Furthermore, any issues and/or PRs proposing enhancements that are already implemented -OR- that are on our roadmap for the commercial distribution **may** also be closed as "won't fix"; conversely, we may from time to time choose to port features from the commercial distribution into this project._
This project will maintain its permissive MIT license, and may be used as a baseline for new Sensu Go web interface projects and/or forks of this project.
## Getting Started
To start the UI, simply run the following:
```bash
yarn install
NODE_ENV=production PORT=80 API_URL=https://my-sensu-backend-api:8080 yarn node scripts serve
```
For more detailed installation instructions, see [INSTALL.md](INSTALL.md)
## Contributing
Sensu is and always will be open source, and we continue to highly value
community contributions. For guidelines on how to contribute to this project, how
to hack on Sensu, and information about what we require from project
contributors, please see [CONTRIBUTING.md].
[sensu go]: https://sensu.io/products/core
[installation documentation]: https://docs.sensu.io/sensu-go/latest/installation/install-sensu/
[contributing.md]: CONTRIBUTING.md
[Building a better UI for Sensu]: https://discourse.sensu.io/t/building-a-better-ui-for-sensu/1859