Skip to content

Latest commit

 

History

History
59 lines (41 loc) · 1.77 KB

README.md

File metadata and controls

59 lines (41 loc) · 1.77 KB

Status for Systems

A full-stack system status monitoring application.

Warning: This project is heavily in-inprogress and is not yet ready for production use.

Website: https://statusfor.systems/

Demo: https://demo.statusfor.systems/

Prerequisites

  • Docker
  • Node.js >= v20.0.0
  • MongoDB

Quick Start

See Releases for available versions.

  1. Generate a JWT secret by running:

    openssl rand -base64 32

  2. Pull the Docker image:

    docker pull ghcr.io/codox/status-for-systems:<VERSION>

    Replace <VERSION> with the desired version tag.

  3. Run the Docker container:

    docker run -d -p 3000:3000 \
-e MONGODB_URI="mongodb://admin:admin@localhost:27017/status_for_systems" \
-e JWT_SECRET="<YOUR_JWT_SECRET>" \
-e NEXT_PUBLIC_DASHBOARD_TITLE="Rexchopper's Status Page" \
-e NEXT_PUBLIC_DASHBOARD_DESCRIPTION="Find out if something is broken here"
ghcr.io/codox/status-for-systems:<VERSION>

  4. Access the status page at http://localhost:3000. The admin panel is available at http://localhost:3000/admin. Use the credentials set in the environment variables for authentication.

Project Structure

  • app/: Next.js full-stack application (frontend and API routes)
  • docs/: MKDocs documentation

Development

Navigate to the app/ directory and follow the instructions on the README

Contributing

Contributions are welcome! Please read the CONTRIBUTING guide for details on how to contribute to this project.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Credits