diff --git a/README.md b/README.md index 727d3b48..d48506aa 100644 --- a/README.md +++ b/README.md @@ -103,19 +103,7 @@ More informations in [Wiki](https://github.com/ffplayout/ffplayout-engine/wiki/R Installation ----- -- install ffmpeg, ffprobe (and ffplay if you need the preview mode) -- `cd` to **/opt/** -- clone repo: `git clone https://github.com/ffplayout/ffplayout-engine.git` -- `cd ffplayout-engine` -- run **make** -- copy ffplayout.yml to **/etc/ffplayout/** -- create folder with correct permissions for logging (check config) -- copy **docs/ffplayout.service** to **/etc/systemd/system/** -- change user in **/etc/systemd/system/ffplayout.service** -- create playlists folder, in that format: **/playlists/year/month** -- set variables in config file to your needs -- use **docs/gen_playlist_from_subfolders.sh /path/to/mp4s/** as a starting point for your playlists (path in script needs to change) -- activate service and start it: **sudo systemctl enable ffplayout && sudo systemctl start ffplayout** +Check [INSTALL.md](docs/INSTALL.md) Start with Arguments ----- diff --git a/docs/INSTALL.md b/docs/INSTALL.md new file mode 100644 index 00000000..45265d2e --- /dev/null +++ b/docs/INSTALL.md @@ -0,0 +1,30 @@ +**ffplayout-engine installation** +================ + +Here are a description on how to install *ffplayout engine* on a standard linux server. + +Requirements +----- +- python version 3.6+ +- **ffmpeg v4.2+** and **ffprobe** +- systemd (if ffplayout should run as a daemon) + +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 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 +- use `docs/gen_playlist_from_subfolders.sh /path/to/mp4s/` as a starting point for your playlists (path in script needs to change) +- activate service and start it: `sudo systemctl enable ffplayout && sudo systemctl start ffplayout` + +Cleanup +----- +- run `make clean` to remove virtual environment + +Deinstallation +----- +- run `make uninstall` it will remove all created folders (also the **ffplayout.yml** configuration file!)