History

jb-alvarado 28d4262b42 add domain argument for init DB		2022-07-08 14:44:21 +02:00
..
src	add domain argument for init DB	2022-07-08 14:44:21 +02:00
Cargo.toml	add domain argument for init DB	2022-07-08 14:44:21 +02:00
README.md	add more routes, channel id to presets, no full paths, change email to mail	2022-06-30 18:44:42 +02:00

README.md

ffplayout-api

ffplayout-api (ffpapi) is a non strict REST API for ffplayout. It makes it possible to control the engine, read and manipulate the config, save playlist, etc.

To be able to use the API it is necessary to initialize the settings database first. To do that, run:

ffpapi -i

Then add an admin user:

ffpapi -u <USERNAME> -p <PASSWORD> -m <MAIL ADDRESS>

Then run the API thru the systemd service, or like:

ffpapi -l 127.0.0.1:8080

If you plan to run ffpapi with systemd set permission from /usr/share/ffplayout and content to user www-data:www-data.

For possible endpoints read: api endpoints