zishuo/videostreamer
1
0
Fork 0
mirror of https://github.com/horgh/videostreamer.git synced 2024-05-03 10:44:50 +08:00
Code Issues Packages Projects Releases Wiki Activity

update: getting started doc

Browse Source 
to support docker usage

https://github.com/horgh/videostreamer/issues/22
This commit is contained in:
fpaupier 2022-02-21 20:03:14 +01:00
parent ca60c46b4c
commit 4921387848
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -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.