History

jb-alvarado bf516b6ace cargo fmt		2022-07-26 11:47:08 +02:00
..
src	cargo fmt	2022-07-26 11:47:08 +02:00
Cargo.toml	add frontend, remove preview config	2022-07-24 19:23:52 +02:00
README.md	include public in assets	2022-07-25 17:26:49 +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:8787

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

ffpapi can also serve the browser based frontend, just run in your browser 127.0.0.1:8787.