status-page/README.md

Status Page

This is a simple way to create customizable status pages.

Usage

With Docker Compose (Recommended)

1. Copy the examples/docker-compose.yml file inside an empty directory.
2. Create a database/ directory and add a database.json file following the example database: database/example.json5.
   • Note: This example may not be up-to-date, if that's the case, please open a PR or issue and I'll take care of it.
   • Note: The schema is always available at src/db.ts.
3. (Optional) If you want to add additional styles to make changes on top of the default stylesheet do the following:
   1. Uncomment the lines of the docker-compose.yml.
   2. Create a styles/ directory.
   3. Create your stylesheet inside the styles/ directory: exampleStyle.css.
   4. Add exampleStyle to the ADDITIONAL_STYLES environment variable.
   5. Note: This doesn't overwrite the default styles, if you want to do that, create a volume that points to /home/bun/app/public/. Warning: Unexpected things might happen if you overwrite the public folder.
4. Run docker compose up -d

Manually

1. Clone the repository.
2. Add a database.json file following the example database: database/example.json5.
   • Note: This example may not be up-to-date, if that's the case, please open a PR or issue and I'll take care of it.
   • Note: The schema is always available at src/db.ts.
3. (Optional) If you want to add additional styles to make changes on top of the default stylesheet do the following:
   1. Create your stylesheet inside the public/additional/ directory: exampleStyle.css.
   2. Add exampleStyle to the ADDITIONAL_STYLES environment variable.
   3. Note: This doesn't overwrite the default styles, if you want to do that, overwrite the public/style.css file.
4. Run bun start.