Skip to content

Commit

Permalink
Add documentation on configuration and usage
Browse files Browse the repository at this point in the history
  • Loading branch information
penguineer committed Nov 2, 2024
1 parent 72146c5 commit df536c8
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,36 @@
This could be done in NodeRed, but it is part of our critical infrastrukture and should
run independently.

## Usage

### Configuration

Configuration is done using environment variables:

* `PORT`: Target port when used with docker-compose (default `8080`)

### Run with Docker

```bash
docker run --rm -it \
-p 8080:8080 \
netz39/ampel-controller
```

### Run with Docker-Compose (Development)

To run with [docker-compose](https://docs.docker.com/compose/) copy [`.env.template`](.env.template) to `.env` and edit the necessary variables. Then start with:

```bash
docker-compose up --build
```

Please note that this compose file will rebuild the image based on the repository. This is helpful during development and not intended for production use.

When done, please don't forget to remove the deployment with
```bash
docker-compose down
```

## Maintainers

Expand Down

0 comments on commit df536c8

Please sign in to comment.