Skip to content

Commit

Permalink
updating docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mfreeman451 committed Feb 24, 2025
1 parent ecc5833 commit 56957d8
Show file tree
Hide file tree
Showing 19 changed files with 170 additions and 571 deletions.
1 change: 0 additions & 1 deletion docs/CNAME

This file was deleted.

73 changes: 73 additions & 0 deletions docs/docs/configuration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
---
sidebar_position: 3
title: Configuration Basics
---

# Configuration Basics

ServiceRadar components are configured via JSON files in `/etc/serviceradar/`. Below are the essentials to get started.

## Agent Configuration
Edit `/etc/serviceradar/agent.json`:

```json
{
"checkers_dir": "/etc/serviceradar/checkers",
"listen_addr": ":50051",
"service_type": "grpc",
"service_name": "AgentService",
"security": {
"mode": "none",
"cert_dir": "/etc/serviceradar/certs",
"server_name": "changeme",
"role": "agent"
}
}
```

* Update server_name to your poller’s hostname/IP if using mTLS (set mode to mtls).

## Poller Configuration

Edit `/etc/serviceradar/poller.json`:

```json
{
"agents": {
"local-agent": {
"address": "localhost:50051",
"security": { "mode": "none" },
"checks": [
{ "service_type": "port", "service_name": "SSH", "details": "127.0.0.1:22" }
]
}
},
"cloud_address": "changeme:50052",
"listen_addr": ":50053",
"poll_interval": "30s",
"poller_id": "my-poller",
"security": { "mode": "none" }
}
```

* Set `cloud_address` to your cloud service’s hostname/IP.
* Adjust `agents` to list your monitored hosts.

## Cloud Configuration

Edit `/etc/serviceradar/cloud.json`:

```json
{
"listen_addr": ":8090",
"grpc_addr": ":50052",
"alert_threshold": "5m",
"known_pollers": ["my-poller"],
"security": { "mode": "none" }
}
```

* Update `known_pollers` with your poller IDs.

For mTLS setup and advanced options, see the full README on GitHub.

34 changes: 0 additions & 34 deletions docs/docs/getting-started/introduction.md

This file was deleted.

71 changes: 71 additions & 0 deletions docs/docs/installation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
---
sidebar_position: 2
title: Installation Guide
---

# Installation Guide

ServiceRadar components are distributed as Debian packages. Below are the recommended installation steps for a standard setup.

## Standard Setup (Recommended)

Install these components on your monitored host:

```bash
# Download and install core components
curl -LO https://github.com/mfreeman451/serviceradar/releases/download/1.0.19/serviceradar-agent_1.0.19.deb
curl -LO https://github.com/mfreeman451/serviceradar/releases/download/1.0.19/serviceradar-poller_1.0.19.deb
sudo dpkg -i serviceradar-agent_1.0.19.deb serviceradar-poller_1.0.19.deb
```

On a separate machine (recommended) or the same host for the cloud service:

```bash
curl -LO https://github.com/mfreeman451/serviceradar/releases/download/1.0.19/serviceradar-cloud_1.0.19.deb
sudo dpkg -i serviceradar-cloud_1.0.19.deb
```

## Optional Components

### SNMP Polling

For collecting and visualizing metrics:

```bash
curl -LO https://github.com/mfreeman451/serviceradar/releases/download/1.0.19/serviceradar-snmp-checker_1.0.19.deb
sudo dpkg -i serviceradar-snmp-checker_1.0.19.deb
```

### Dusk Node Monitoring

For specialized monitoring of Dusk nodes:

```bash
curl -LO https://github.com/mfreeman451/serviceradar/releases/download/1.0.19/serviceradar-agent_1.0.19.deb
sudo dpkg -i serviceradar-agent_1.0.19.deb
```

## Distributed Setup

For larger deployments, install components on separate hosts:

1. On monitored hosts:

```bash
curl -LO https://github.com/mfreeman451/serviceradar/releases/download/1.0.19/serviceradar-agent_1.0.19.deb
sudo dpkg -i serviceradar-agent_1.0.19.deb
```

2. On monitoring host:

```bash
curl -LO https://github.com/mfreeman451/serviceradar/releases/download/1.0.19/serviceradar-poller_1.0.19.deb
sudo dpkg -i serviceradar-poller_1.0.19.deb
```

3. On cloud host:

```bash
curl -LO https://github.com/mfreeman451/serviceradar/releases/download/1.0.19/serviceradar-cloud_1.0.19.deb
sudo dpkg -i serviceradar-cloud_1.0.19.deb
```
54 changes: 18 additions & 36 deletions docs/docs/intro.md
Original file line number Diff line number Diff line change
@@ -1,47 +1,29 @@
---
sidebar_position: 1
title: ServiceRadar Introduction
---

# Tutorial Intro
# ServiceRadar Introduction

Let's discover **Docusaurus in less than 5 minutes**.
ServiceRadar is a distributed network monitoring system designed for infrastructure and services in hard-to-reach places or constrained environments. It provides real-time monitoring of internal services with cloud-based alerting capabilities, ensuring you stay informed even during network or power outages.

## Getting Started
## What is ServiceRadar?

Get started by **creating a new site**.
ServiceRadar offers:
- Real-time monitoring of internal services
- Cloud-based alerting capabilities
- Continuous monitoring during network or power outages
- Distributed architecture for scalability and reliability

Or **try Docusaurus immediately** with **[docusaurus.new](https://docusaurus.new)**.
:::tip What you'll need
- Linux-based system (Ubuntu/Debian recommended)
- Root or sudo access
- Basic understanding of network services
- Target services to monitor
:::

### What you'll need
## Quick Start

- [Node.js](https://nodejs.org/en/download/) version 18.0 or above:
- When installing Node.js, you are recommended to check all checkboxes related to dependencies.
Get started in minutes:

## Generate a new site

Generate a new Docusaurus site using the **classic template**.

The classic template will automatically be added to your project after you run the command:

```bash
npm init docusaurus@latest my-website classic
```

You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor.

The command also installs all necessary dependencies you need to run Docusaurus.

## Start your site

Run the development server:

```bash
cd my-website
npm run start
```

The `cd` command changes the directory you're working with. In order to work with your newly created Docusaurus site, you'll need to navigate the terminal there.

The `npm run start` command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/.

Open `docs/intro.md` (this page) and edit some lines: the site **reloads automatically** and displays your changes.
Check out the Installation Guide (./installation.md) for full setup options.
8 changes: 0 additions & 8 deletions docs/docs/tutorial-basics/_category_.json

This file was deleted.

23 changes: 0 additions & 23 deletions docs/docs/tutorial-basics/congratulations.md

This file was deleted.

34 changes: 0 additions & 34 deletions docs/docs/tutorial-basics/create-a-blog-post.md

This file was deleted.

57 changes: 0 additions & 57 deletions docs/docs/tutorial-basics/create-a-document.md

This file was deleted.

Loading

0 comments on commit 56957d8

Please sign in to comment.