Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #110

Merged
merged 1 commit into from
Nov 6, 2023
Merged

Update README.md #110

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,21 @@
# Node Monitor

Node monitoring software for notifications of changes to Internet Computer Nodes.
Queries the API with a specified interval and reports changes to email and other various communication channels.
Node monitoring is an open-source notification service for [Internet Computer Nodes](https://internetcomputer.org/node-providers).
It queries the Internet Computer API with a specified interval and reports status changes to email and communication channels like [Slack and Telegram](https://github.com/aviate-labs/node-monitor#free-hosted-version).

You can run Node Monitor yourself or use the free __[hosted version](https://www.aviatelabs.co/node-monitor).__
## Setup

Place a `.env` file in this directory.
Use `.env.example` as a template.
You will also need a running Postgres database to store user information.

### Free hosted version
### 🚀 Hosted version

🚀 Don't want the hassle of hosting the code yourself? We've got you covered! Introducing our free hosted version - instant monitoring, zero setup. [Sign up here](https://www.aviatelabs.co/node-monitor)!
Don't want the hassle of hosting the service yourself? We've got you covered!
Introducing our free hosted version - instant monitoring, zero setup. Sign up here: [aviatelabs.co/node-monitor](https://www.aviatelabs.co/node-monitor)

The service uses the same functionality as the open-source service, with Slack and Telegram already integrated. Features will be added to provide management and incident-handling support to Node Providers.

## Running

Expand Down
Loading