Skip to content

Commit

Permalink
docs: add usage instructions to README
Browse files Browse the repository at this point in the history
  • Loading branch information
Data5tream committed Apr 18, 2023
1 parent af3cd58 commit 0d72269
Showing 1 changed file with 22 additions and 4 deletions.
26 changes: 22 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,38 @@
# Simple Status Page

A simple web app that does status checking. Configured through a simple `config.toml`.
A web app that does status checking. Configured through a simple `config.toml` (or environment variables).

## Structure
## Usage

Copy the `docker-compose.yml` and `config_example.toml` to a local folder. Rename `config_example.toml` to `config.toml`
and fill out the configuration. Then run:

```shell
docker compose up -d
```

This will pull the latest `redis` and `simple-status-page` images and run them. The status page will be available on port
`8080`.

It's recommended to run the app behind a reverse proxy that does TLS termination, like [caddy](https://caddyserver.com/).

Configuration can also be done via environmental variables. The env vars take precedence over the config file.

## Development

### Backend

[Actix Web](https://actix.rs/) with [Redis](https://redis.io/) as a datastore.
[Actix Web](https://actix.rs/) with [Redis](https://redis.io/) as a datastore. You will need a locally available redis
instance for development.

```shell
cargo run
```

### Frontend

[SvelteKit](https://kit.svelte.dev/) Webapp written in TypeScript.
[SvelteKit](https://kit.svelte.dev/) Webapp written in TypeScript. Set the `webserver.url` config value to your svelte
`host:port`, otherwise you will have CORS issues.

```shell
pnpm i
Expand Down

0 comments on commit 0d72269

Please sign in to comment.