Open-source status page, incident response and uptime monitoring
TypeScript alertingincident-managementmcpmcp-servermonitoringmonitoring-as-codeobservabilityon-callopen-sourcesrestatus-pagestatuspagesynthetic-monitoringterraformtinybirdtursouptimeuptime-checkeruptime-monitor
add guide self-hosting (#1595)
Thibault Le Ouay2aa970b7fc2a
diff --git a/apps/docs/astro.config.mjs b/apps/docs/astro.config.mjsindex 21be5b707..4f03a12dd 100644--- a/apps/docs/astro.config.mjs+++ b/apps/docs/astro.config.mjs@@ -138,6 +138,10 @@ export default defineConfig({label: "How to deploy probes on Cloudflare Containers ",slug: "guides/how-to-deploy-probes-cloudflare-containers",},+ {+ label: "How to self-host openstatus",+ slug: "guides/self-hosting-openstatus",+ },],},{diff --git a/apps/docs/src/assets/guides/self-hosting-openstatus/local-openstatus.png b/apps/docs/src/assets/guides/self-hosting-openstatus/local-openstatus.pngnew file mode 100644index 000000000..4bd017ae5Binary files /dev/null and b/apps/docs/src/assets/guides/self-hosting-openstatus/local-openstatus.png differdiff --git a/apps/docs/src/content/docs/guides/self-hosting-openstatus.mdx b/apps/docs/src/content/docs/guides/self-hosting-openstatus.mdxnew file mode 100644index 000000000..04b9cda4c--- /dev/null+++ b/apps/docs/src/content/docs/guides/self-hosting-openstatus.mdx@@ -0,0 +1,109 @@+---+title: How to self host openstatus+description: Learn how to self host openstatus in your own infra.+---+import { Image } from 'astro:assets';++import localOpenstatus from '../../../assets/guides/self-hosting-openstatus/local-openstatus.png';+++If you want to self host openstatus, we provide a [docker-compose](https://www.github.com/) file to get you started quickly.+++## Known limitations++- It only works with private locations. You have to deploy our probes to the cloud provider of your choice.++## Get started++1. Clone the repository++```bash+git clone+```++2. Copy the `.env.example` file to `.env` and modify the environment variables as needed.++```bash+cp .env.docker.example .env.docker+```++3. Build the containers+```+export DOCKER_BUILDKIT=1+docker compose up -d+```++4. Migrate the database++```bash+cd packages/db+pnpm migrate+```++5. Create Tinybird datasources, pipes and endpoints++```bash+cd packages/tinybird+tb --local deploy+```++7. Access Tinybird local UI and get your TOKEN++```bash+tb --local open+```++8. Update the `.env.docker` file with your Tinybird TOKEN++9. Connect to your OpenStatus instance and create a new workspace.++10. Update your newly created workspace with the following limits:++```json+{+ "monitors": 100,+ "periodicity": ["30s", "1m", "5m", "10m", "30m", "1h"],+ "multi-region": true,+ "data-retention": "24 months",+ "status-pages": 20,+ "maintenance": true,+ "status-subscribers": true,+ "custom-domain": true,+ "password-protection": true,+ "white-label": true,+ "notifications": true,+ "sms": true,+ "pagerduty": true,+ "notification-channels": 50,+ "members": "Unlimited",+ "audit-log": true,+ "private-locations": true+}+```++11. Create a new private location in the dashboard.++12. Deploy the private location to your cloud provider of choice with they API key++13. Create monitors and start monitoring your services!+++ <Image+ src={localOpenstatus}+ alt="Openstatus running locally"+ />+++## Our services Services++| Service | Port | Purpose |+|---------|------|---------|+| workflows | 3000 | Background jobs |+| server | 3001 | API backend (tRPC) |+| dashboard | 3002 | Admin interface |+| status-page | 3003 | Public status pages |+| private-location | 8081 | Monitoring agent |+| libsql | 8080 | Database (HTTP) |+| libsql | 5001 | Database (gRPC) |+| tinybird-local | 7181 | Analytics |