Skip to content

Commit

Permalink
readme edits
Browse files Browse the repository at this point in the history
  • Loading branch information
max-at-groundlight committed Nov 14, 2023
1 parent 13d8f18 commit 52aee52
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

Our Monitoring Notification Server is a server you can deploy anywhere to easily build Groundlight Detectors, and configure them to pull from custom image sources and post notifications.

The Monitoring Notification Server has a simple web interface (depected below) that allows you to configure your detector, and a backend that runs on your device to pull images from your camera and post notifications.
The Monitoring Notification Server has a simple web interface (depected below) that allows you to configure your detector(s), and a backend that runs on your device to pull images from your camera and post notifications.

### Intro Page

Expand All @@ -31,10 +31,12 @@ There are several ways to deploy the code:

### Running with Docker Compose

1. Use the file [`docker-compose.yml`](./deploy/docker-compose.yml) file.
1. Use the file [`docker-compose.yml`](./deploy/docker-compose.yml).

2. Run `docker-compose up` in the same directory as the `docker-compose.yml` file.

> If you're using Docker Compose v2, replace `docker-compose` with `docker compose`.
### Running from Docker Compose on 32-bit ARM (armv7)

32-bit arm requires different binary images.
Expand All @@ -43,6 +45,8 @@ There are several ways to deploy the code:

2. Run `docker-compose -f docker-compose-armv7.yml up`.

> If you're using Docker Compose v2, replace `docker-compose` with `docker compose`.
### Running with AWS Greengrass

Before creating the component, run `sudo usermod -aG docker ggc_user` on your Greengrass device to allow the Greengrass service to access the host's Docker daemon.
Expand Down

0 comments on commit 52aee52

Please sign in to comment.