diff --git a/docs/INSTALL.md b/docs/INSTALL.md index 0d7963b0..72100437 100644 --- a/docs/INSTALL.md +++ b/docs/INSTALL.md @@ -1,7 +1,7 @@ -**ffplayout-engine installation** +**ffplayout-engine Installation** ================ -Here are a description on how to install *ffplayout engine* on a standard linux server. +Here are a description on how to install *ffplayout engine* on a standard Linux server. Requirements ----- @@ -14,7 +14,7 @@ Installation - install ffmpeg, ffprobe (and ffplay if you need the preview mode) - clone repo: `git clone https://github.com/ffplayout/ffplayout-engine.git` - `cd ffplayout-engine` -- run `make` +- run `make` (virtualenv is required) - run `sudo make install USER=www-data`, use any other user which need write access - create playlists folder, in that format: **/playlists/year/month** - set variables in config file to your needs @@ -23,8 +23,20 @@ Installation Cleanup ----- -- run `make clean` to remove virtual environment +- run `make clean` to remove the virtual environment Deinstallation ----- - run `sudo make uninstall` it will remove all created folders (also the **ffplayout.yml** configuration file!) + +Manual Installation +----- +The routine with `make` build a virtual environment with all dependencies, and install ffplayout to **/opt/ffplayout-engine**. If you do not want to install to this path, or you want to install the dependencies globally, you can do everything by hand. + +Just copy the project where you want to have it, run inside `pip3 install -r requirements.txt`. For logging you have to create the folder **ffplayout** under **/var/log/**, or adjust the settings in config. **ffplayout.yml** have to go to **/etc/ffplayout/**, or should stay in same folder. + +If you want to use the systemd service, edit the service file in **docs/ffplayout.service**, copy it to **/etc/systemd/system/** and activate it with: `sudo systemctl enable ffplayout`. + +Using it Without Installation +----- +Of course you can just run it too. Install only the dependencies from **requirements.txt** and run it with **python ffplayout.py [parameters]**.