Skip to content

Commit

Permalink
update: getting started doc
Browse files Browse the repository at this point in the history
to support docker usage

horgh/videostreamer#22
  • Loading branch information
nickorzha committed Feb 21, 2022
1 parent a91c2c8 commit f8ac78d
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,21 @@ website.
* Run the daemon. Its usage output shows the possible flags. There is no
configuration file.

## Running with docker-compose

1. Copy the provided example environment file `.env.example`
```shell
cp .env.example .env
```
2. Edit the `.env` environment file with your config, especially the path towards your source input.

3. Run the app with docker-compose
```shell
docker-compose up
# docker-compose up --build # if you wish to rebuild the docker image
```

4. Use your favorite browser to open the `index.html` and you're good!

## Components
* `videostreamer`: The daemon.
Expand Down

0 comments on commit f8ac78d

Please sign in to comment.