Skip to content

Documentation

Guides and technical documentation for ServerScope.

Getting started

1 guides
  1. Getting started What ServerScope does, how to get access and how to find your way around the dashboard.

Servers and agent

4 guides
  1. Connect a server with one command Connect a Linux server with one command and a one-time enrollment token. Requirements, what the script does, running it again, uninstalling and troubleshooting.
  2. Service checks Let the agent watch services such as Nginx, MySQL, PHP-FPM and Redis (from version 0.2.0).
  3. The Bash agent The Bash agent for hosts and containers without Python or systemd, next to the manual installation of the regular agent.
  4. Agent updates from the dashboard Signed agent releases, the updater, automatic updates, rolling back, the local emergency switch and checking the fingerprint.

Monitoring

2 guides
  1. Server monitoring Add a server, install and configure the agent, verify that data arrives and fix common installation problems.
  2. Domain monitoring Monitor HTTP availability, SSL certificates, DNS records and domain registration, with the settings and when an incident is opened.

Alerts and status pages

3 guides
  1. Alerts and incidents How alert rules work, how to investigate an incident and follow its timeline, and how notifications are delivered.
  2. Discord notifications Create a Discord webhook, connect it to ServerScope, test it, and replace the URL securely.
  3. Public status pages Create a public status page for your servers and domains, decide what is visible, and share the page.

API and integrations

2 guides
  1. API and webhooks Use the REST API with a personal token, and receive and verify signed webhooks.
  2. API v1 reference All REST API v1 endpoints, permissions, error codes and repeatable write requests with Idempotency-Key.

Account, teams and security

3 guides
  1. Security and account management Two-factor authentication, passwords, inviting users, roles, the audit log, maintenance windows and data retention.
  2. Teams and roles What a team is, what each role (owner, admin or member) may do, how to switch teams and why every team only sees its own data.
  3. Security of the agent and your account What the agent does and does not do, why there are no remote commands, how tokens are stored, two-factor authentication and the audit log.

↑ ↓ navigate ↵ open Esc close