Operational

DocsGithub Open app

Operational

Github Articles Pitch Usecases Playground API

Contents

Start here
Setup
Get started Send your first event Structured Events Actions Contexts Log limits and errors
Events API
API
Error handling Event parametersPOST Log event Sending actions in events
The Manual
Introduction PWA & push notifications Conventions Setup Manage projects and teammates Categories and search View events in your project Setup PWA on phone Test mode Notifications
Integrations
Nodejs SDK PHP SDK Wordpress plugin
Self hosting
Introduction Install locally Install on VPS Install on Render Install via Docker Install via Docker and Coolify Onboarding Setup .env Setup PWA & push notifications Best practices Durability testing
Other
Vision Roadmap Contributing

Self-hosting best practices

Host Operational on a VPS

A cheap VPS will give you the best bang-for-your-buck performance.

In our tests with Hetzner’s Ampere CPU line, we found Operational to perform extremely well.

Fork instead of git clone

Fork the project and git clone from there. There are two upsides:

  • If we accidently push a breaking change, you won’t be affected.
  • Easier to migrate from. Once we release a version, just pull upstream for the new version number.

Increase REMOVE_EVENTS_AFTER env var

This env var controls when events are flushed out of the system.

If you’re using Operational as a audit log or something similar, you want to increase this to 2-3 years.

2 years = REMOVE_EVENTS_AFTER="730"

Setup PWA & push notificationsDurability testing

Operational

PrivacyTerms
About the product
  • Use cases
  • Playground
  • API
  • Pitch
  • Pricing
  • Wordpress plugin
Related to the product
  • Open Source
  • Articles
  • VS Logsnag
Useful articles for your SaaS
  • My experience running a Commercial OSS project
  • Force post: The Payment Hack that lets Merchants charge you without approval
  • 6 Best practices for early stage B2B SaaS customer support
  • Setup event notifications for your SaaS