Skip to content

Commit

Permalink
Add readme for startup
Browse files Browse the repository at this point in the history
  • Loading branch information
Chrisbattarbee committed Mar 26, 2024
1 parent 202c7ea commit 19ec07b
Showing 1 changed file with 28 additions and 1 deletion.
29 changes: 28 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,31 @@ They're orchestrated in the following way:

<div align="center">
<img src="./docs/static/statusphere-architecture-white.png" height="300" alt="Statusphere logo">
</div>
</div>


## Usage

### Scraper

The scrapers need to be started with the following environment variables:

```bash
STATUSPHERE_POSTGRES_HOST=...
STATUSPHERE_POSTGRES_PORT=...
STATUSPHERE_POSTGRES_USER=...
STATUSPHERE_POSTGRES_PASSWORD=...
STATUSPHERE_POSTGRES_DATABASE=...
```

### API

The api needs to be started with the following environment variables:

```bash
STATUSPHERE_POSTGRES_HOST=...
STATUSPHERE_POSTGRES_PORT=...
STATUSPHERE_POSTGRES_USER=...
STATUSPHERE_POSTGRES_PASSWORD=...
STATUSPHERE_POSTGRES_DATABASE=...
```

0 comments on commit 19ec07b

Please sign in to comment.