Skip to content

Open-source status page, incident response and uptime monitoring

chore: content slack agent (#1895)

Thibault Le Ouay617c8a444b65
diff --git a/apps/docs/astro.config.mjs b/apps/docs/astro.config.mjs
index 6e2a0bb08..e73b65432 100644
--- a/apps/docs/astro.config.mjs
+++ b/apps/docs/astro.config.mjs
@@ -108,6 +108,10 @@ export default defineConfig({
label: "Get Started with OpenStatus CLI",
slug: "tutorial/get-started-with-openstatus-cli",
},
+ {
+ label: "How to set up the Slack Agent",
+ slug: "tutorial/how-to-setup-slack-agent",
+ },
],
},
diff --git a/apps/docs/src/content/docs/index.mdx b/apps/docs/src/content/docs/index.mdx
index 4f06731b8..d7e704775 100644
--- a/apps/docs/src/content/docs/index.mdx
+++ b/apps/docs/src/content/docs/index.mdx
@@ -1,41 +1,68 @@
---
-title: Welcome to openstatus
-description: Openstatus is an open-source global uptime monitoring platform that offers a status page and monitoring as code.
+title: "OpenStatus Docs — Open Source Status Page & Uptime Monitoring"
+description: "OpenStatus documentation — learn how to create your open-source status page, monitor your websites and APIs from 35+ global locations, and configure alerts."
template: doc
topic: docs
next: false
hero:
- title: Welcome to openstatus
- tagline: Explore our documentation to get started with openstatus and start monitoring your services.
+ title: OpenStatus Documentation
+ tagline: Learn how to create your status page, monitor your services, and keep your users informed — all open source.
---
-import { Card, CardGrid, LinkCard } from '@astrojs/starlight/components';
-import "../../custom.css"
+import { Card, CardGrid, LinkCard } from "@astrojs/starlight/components";
+import "../../custom.css";
### What is openstatus?
[openstatus](https://www.openstatus.dev) is an open-source status page platform with uptime monitoring. Monitor your websites, APIs, and services from multiple global locations and share real-time status updates with your users.
+### Why OpenStatus?
+
+- **Open source** — fully open-source, self-hostable, and transparent
+- **Beautiful status pages** — keep your users informed with public or audience specific status pages
+- **30+ global locations** — monitor from your users' perspective, not just your own
+- **HTTP, TCP & DNS monitors** — check APIs, servers, and DNS resolution
+- **12 notification channels** — Slack, Discord, PagerDuty, OpsGenie, email, SMS, and more
+- **Monitoring as code** — define monitors in YAML, manage with CLI or Terraform
+- **OpenTelemetry export** — send metrics to Grafana, Datadog, Honeycomb, or any OTLP endpoint
+- **Private locations** — deploy lightweight probes inside your own infrastructure
+
### How to use this documentation
Our documentation follows the [Diátaxis framework](https://diataxis.fr/), organizing content into four distinct categories to help you find what you need:
-<CardGrid >
- <LinkCard title="📚 Tutorials" href="/tutorial/getting-started/" description="Step-by-step lessons to learn openstatus from scratch. Start here if you're new!" />
- <LinkCard title="🛠️ How-to Guides" href="/guides/getting-started/" description="Practical guides to solve specific problems and accomplish particular tasks." />
- <LinkCard title="💡 Concepts" href="/concept/getting-started/" description="In-depth explanations of key concepts, design decisions, and best practices." />
- <LinkCard title="📖 Reference" href="/reference" description="Technical specifications, API documentation, and configuration references." />
+<CardGrid>
+ <LinkCard
+ title="📚 Tutorials"
+ href="/tutorial/getting-started/"
+ description="Step-by-step lessons to learn openstatus from scratch. Start here if you're new!"
+ />
+ <LinkCard
+ title="🛠️ How-to Guides"
+ href="/guides/getting-started/"
+ description="Practical guides to solve specific problems and accomplish particular tasks."
+ />
+ <LinkCard
+ title="💡 Concepts"
+ href="/concept/getting-started/"
+ description="In-depth explanations of key concepts, design decisions, and best practices."
+ />
+ <LinkCard
+ title="📖 Reference"
+ href="/reference"
+ description="Technical specifications, API documentation, and configuration references."
+ />
</CardGrid>
**Not sure where to start?**
+
- **New users**: Begin with our [tutorials](/tutorial/getting-started/) to create your first monitor
- **Experienced users**: Check out [how-to guides](/guides/getting-started/) for specific tasks
- **Need help?** Visit our [help section](/help/support/) or join our community
-
### Join the community
-Join the commmunity to get help, share your ideas or just to say hi.
+Join the community to get help, share your ideas or just to say hi.
<CardGrid>
<LinkCard href="https://bsky.app/profile/openstatus.dev" title="Bluesky" />
diff --git a/apps/docs/src/content/docs/tutorial/how-to-setup-slack-agent.mdx b/apps/docs/src/content/docs/tutorial/how-to-setup-slack-agent.mdx
new file mode 100644
index 000000000..bb9f9119e
--- /dev/null
+++ b/apps/docs/src/content/docs/tutorial/how-to-setup-slack-agent.mdx
@@ -0,0 +1,85 @@
+---
+title: Set Up the OpenStatus Slack Agent
+description: "A step-by-step tutorial to install the OpenStatus Slack agent and manage incidents directly from Slack"
+---
+
+import { Aside } from '@astrojs/starlight/components';
+
+## What you'll learn
+
+In this tutorial, you'll learn how to install the OpenStatus Slack agent so you can manage incidents directly from your Slack workspace — no need to switch to the dashboard.
+
+### Prerequisites
+
+- An OpenStatus account ([openstatus.dev](https://www.openstatus.dev))
+- A Slack workspace where you have permission to install apps
+
+### What you'll get
+
+By the end of this tutorial, you'll have:
+- The OpenStatus Slack agent installed in your workspace
+- The ability to create, update, and resolve incidents from Slack
+
+## Install the Slack Agent
+
+### 1. Go to Settings
+
+Navigate to **Settings** > **Integrations** in your OpenStatus dashboard.
+
+### 2. Install the Slack Integration
+
+Click the **Install Slack** button. You'll be redirected to Slack's authorization page where you can select the workspace and channel you want to connect.
+
+Grant the requested permissions and click **Allow** to complete the installation.
+
+<Aside>Make sure you select the correct Slack workspace if you belong to multiple workspaces.</Aside>
+
+### 3. Start Managing Incidents from Slack
+
+Once installed, mention **@openstatus** in any channel to interact with the agent. This keeps threads clean — the bot only responds when mentioned.
+
+Here are some examples:
+
+#### Create an incident
+
+Notify your subscribers about a new issue.
+
+```
+@openstatus create an incident for the payment API – high latency detected.
+```
+
+#### Update an incident
+
+Keep your status page updated while you investigate.
+
+```
+@openstatus keep the status page updated that we are still monitoring the issue.
+```
+
+#### Resolve an incident
+
+Close an active incident and let your subscribers know.
+
+```
+@openstatus resolve the ongoing incident on my API status page.
+```
+
+#### Schedule maintenance
+
+Plan downtime so subscribers are informed in advance.
+
+```
+@openstatus schedule a maintenance window for my database next Friday from 2–3 PM.
+```
+
+## What you've accomplished
+
+Congratulations! You've successfully:
+- Installed the OpenStatus Slack agent in your workspace
+- Connected your OpenStatus account to Slack
+- Learned how to manage incidents directly from Slack
+
+## What's next?
+
+- **[Create a Status Page](/tutorial/how-to-create-status-page)** — share your service status publicly with users
+- **[Create a Monitor](/tutorial/how-to-create-monitor)** — set up uptime monitoring for your endpoints
diff --git a/apps/web/public/assets/changelog/slack-agent.png b/apps/web/public/assets/changelog/slack-agent.png
new file mode 100644
index 000000000..2ac331807
Binary files /dev/null and b/apps/web/public/assets/changelog/slack-agent.png differ
diff --git a/apps/web/src/content/pages/changelog/slack-agent.mdx b/apps/web/src/content/pages/changelog/slack-agent.mdx
new file mode 100644
index 000000000..dc1efb687
--- /dev/null
+++ b/apps/web/src/content/pages/changelog/slack-agent.mdx
@@ -0,0 +1,21 @@
+---
+title: "Slack Agent"
+description: "Manage incidents directly from Slack with the OpenStatus agent."
+publishedAt: "2026-02-27"
+image: "/assets/changelog/slack-agent.png"
+author: "openstatus"
+category: "notifications"
+---
+
+Meet the OpenStatus Slack agent — manage your incidents without leaving Slack.
+
+Mention `@openstatus` in any channel to create, update, and resolve incidents or schedule maintenance windows. Your status page and subscribers stay in sync automatically.
+
+Here's what you can do:
+
+- **Create incidents** — `@openstatus create an incident for the payment API – high latency detected.`
+- **Update incidents** — `@openstatus keep the status page updated that we are still monitoring the issue.`
+- **Resolve incidents** — `@openstatus resolve the ongoing incident on my API status page.`
+- **Schedule maintenance** — `@openstatus schedule a maintenance window for my database next Friday from 2–3 PM.`
+
+Head to **Settings > Integrations** in your dashboard to install the Slack agent.