diff --git a/docs/INSTALL.md b/docs/INSTALL.md index 627cad4e..96d29474 100644 --- a/docs/INSTALL.md +++ b/docs/INSTALL.md @@ -1,4 +1,4 @@ -**ffplayout-engine Installation** +**ffplayout_engine Installation** ================ Here are a description on how to install *ffplayout engine* on a standard Linux server. @@ -13,8 +13,8 @@ Installation ----- - install **ffmpeg**, **ffprobe** (and **ffplay** if you need the preview mode) -- clone repo to **/opt/**: `git clone https://github.com/ffplayout/ffplayout-engine.git` -- `cd /opt/ffplayout-engine` +- clone repo to **/opt/**: `git clone https://github.com/ffplayout/ffplayout_engine.git` +- `cd /opt/ffplayout_engine` - create virtual environment: `virtualenv -p python3 venv` - run `source ./venv/bin/activate` - install dependencies: `pip3 install -r requirements.txt` @@ -28,27 +28,27 @@ Single Channel Setup **systemd** is required -- copy **docs/ffplayout-engine.service** to **/etc/systemd/system/** +- copy **docs/ffplayout_engine.service** to **/etc/systemd/system/** - copy **ffplayout.yml** to **/etc/ffplayout/** - change user and group in service file (for example to **www-data**) -- activate service: `sudo systemctl enable ffplayout-engine` +- activate service: `sudo systemctl enable ffplayout_engine` - edit **/etc/ffplayout/ffplayout.yml** -- when playlists are exists, run service: `sudo systemctl start ffplayout-engine` +- when playlists are exists, run service: `sudo systemctl start ffplayout_engine` Multi Channel Setup ----- -- copy **docs/ffplayout-engine-multichannel.service** to **/etc/systemd/system/** +- copy **docs/ffplayout_engine-multichannel.service** to **/etc/systemd/system/** - change user and group in service file (for example to **www-data**) - copy **ffplayout.yml** to **/etc/ffplayout/ffplayout-001.yml** -- copy **supervisor** folder to **/etc/ffplayout/** +- copy **docs/supervisor** folder to **/etc/ffplayout/** - every channel needs its own engine config **ffplayout-002.yml**, **ffplayout-003.yml**, etc. - every channel needs also its own service file under **/etc/ffplayout/supervisor/config.d** - create for every channel a subfolder for logging: **/var/log/ffplayout/channel-001**, **/var/log/ffplayout/channel-002**, etc. - edit **/etc/ffplayout/ffplayout-00*.yml** - when you want to use the web frontend, create only the first channel and the other ones in the frontend -- activate service: `sudo systemctl enable ffplayout-engine-multichannel` -- when playlists are exists, run service: `sudo systemctl start ffplayout-engine-multichannel` +- activate service: `sudo systemctl enable ffplayout_engine-multichannel` +- when playlists are exists, run service: `sudo systemctl start ffplayout_engine-multichannel` Using it Without Installation ----- diff --git a/supervisor/README.md b/docs/supervisor/README.md similarity index 100% rename from supervisor/README.md rename to docs/supervisor/README.md diff --git a/supervisor/conf.d/engine-001.conf b/docs/supervisor/conf.d/engine-001.conf similarity index 100% rename from supervisor/conf.d/engine-001.conf rename to docs/supervisor/conf.d/engine-001.conf diff --git a/supervisor/supervisord.conf b/docs/supervisor/supervisord.conf similarity index 100% rename from supervisor/supervisord.conf rename to docs/supervisor/supervisord.conf