38 lines
1.7 KiB
Markdown
38 lines
1.7 KiB
Markdown
# Grzegorz API
|
|
<img align="right" width="250" src="res/logo.png">
|
|
|
|
Grzegorz is simple REST API for managing an instance of MPV.
|
|
Why the name Grzegorz? [We have a bad taste in humor!](https://youtu.be/t-fcrn1Edik)
|
|
|
|
When Grzegorz starts, it launches an instance of MPV and maintains it. It is designed to be used as an info screen or HTPC, and supports multiple users to push changes to the MPV instance.
|
|
|
|
The API is described and can be tested at `http:/localhost:8080/swagger` while the server is running. All API endpoints are available under `/api`
|
|
|
|
|
|
## How to run it
|
|
|
|
First of we need to install any needed dependencies. If you want to, you may do so in a virtual environment.
|
|
|
|
To install the needed dependencies, run this with sufficient rights (as root?):
|
|
|
|
pip install -r requirements.txt
|
|
|
|
Gregorz manages a MPV process, meaning you need MPV installed on your system. Look for it in your package manager.
|
|
|
|
When finished, you may run the server with:
|
|
|
|
python3 main.py
|
|
|
|
The server should now be available at `http://localhost:8080/`.
|
|
You may change the address and port in the file named `config.py` which is copied from `default_config.py` when running `main.py` the first time
|
|
|
|
## Making Grzegorz run on boot
|
|
|
|
When setting up a info screen or HTPC using Grzegors, you may configure it to run automatically on startup.
|
|
|
|
We recommend installing a headless linux, and create a user for Grzegorz to run as. (We named ours `grzegorz`, obviously)
|
|
Clone this repo into the home directory. Then make systemd automatically spin up a X session to run Grzegorz in: Copy the files in the folder `dist` into the folder `$HOME/.config/systemd/user` and run the following commands as your user:
|
|
|
|
$ systemctl --user enable grzegorz@0.service
|
|
$ systemctl --user start grzegorz@0.service
|