Skip to content

Installation

OpenUptimes offers multiple installation methods to fit your specific needs. Choose the approach that works best for you.

The easiest way to get started with OpenUptimes is to deploy directly to Vercel with our one-click deploy button.

Visit the OpenUptimes repository and click the Deploy with Vercel button.

Fill in the project name and connect your GitHub account.

Leave all the default settings as they are.

Click Deploy and wait for the deployment to complete.

Setting up Redis on Vercel

Once your site is deployed, you'll need to add Redis for data storage:

  1. Go to your Vercel dashboard and open your newly deployed project
  2. Click on Storage in the left sidebar
  3. Click Add and select Vercel Redis
  4. Follow the prompts to create a new Redis database
  5. Once completed, Vercel will automatically add the Redis connection details to your project

Option 2: Self-Hosted Deployment

For users who want more control over their deployment:

Prerequisites

  • Node.js 18 or later
  • Redis database
  • Git

Installation Steps

  1. Fork and clone the repository:
git clone https://github.com/jexxme/openuptimes.git
cd openuptimes
  1. Install dependencies:
npm install
  1. Set up Redis:
  2. Install Redis locally: Redis Quick Start
  3. Or use Docker: docker run -p 6379:6379 redis

  4. Or use a managed Redis service like Upstash or Redis Cloud

  5. Create a .env.local file:

REDIS_URL=redis://localhost:6379
NEXT_PUBLIC_SITE_NAME="OpenUptimes"
NEXT_PUBLIC_SITE_DESCRIPTION="Service Status Monitor"
NEXT_PUBLIC_REFRESH_INTERVAL=60000
  1. Run the development server:
npm run dev

  1. Navigate to http://localhost:3000/admin to configure your services

  2. For production, build and start:

npm run build
npm run start

Next Steps

After installation, you should:

  1. Set up GitHub Actions for monitoring
  2. Configure your services
  3. Customize your instance to match your brand

Default Admin Access

When you first access /admin, you'll be prompted to create an admin password. Keep this password safe as it's required for all administrative operations.

Redis Connection

Make sure your Redis connection is properly configured. You can test it by visiting the /api/test-redis endpoint on your deployed instance.