Quick Start

🚀 Quick Start

▶️ Try it

Spin up a local demo of Uptimer in two simple commands:

# Pull the latest image
docker pull myuptime/uptimer

# Run the container in demo mode (all-in-one)
docker run -p 2517:2517 myuptime/uptimer

Then open http://127.0.0.1:2517 in your browser:

1. On Monitoring, choose Add website monitoring (URL + interval + locations)
2. Set up a Slack webhook for notifications so incidents reach you

Saving website monitoring creates a monitoring subject with a built-in HTTP signal and a Reachability rule. Open the subject from Monitoring to see its timeline, the observations each location reported, and why the rule decided what it did.

🧪 Demo limitations

• Single built-in worker — no multi-region support
• No authentication — all users are treated as “Admin”
• No persistence — all data is lost when the container stops

⚠️ WARNING:

The demo version is for local testing only. Do not expose it to the internet. It has no authentication or security features.

➡️ What’s next?

After trying the demo, follow these steps for a production setup:

1. Check software requirements
2. Configuration basics
3. Persistent storage options
   1. Data files
   2. SQLite3 for simple deployments
   3. PostgreSQL for production use
4. Authentication methods
   1. Basic HTTP Auth
   2. OAuth (with Auth0 example)
5. Remote workers for distributed monitoring
6. Production configuration
   1. Component architecture explanation
   2. Docker Swarm deployment examples

For a complete guide on setting up a production environment, visit our Configuration section.