deblan/mu-go
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases 6 Wiki Activity

add readme

Browse source
This commit is contained in:
Simon Vieille 2022-08-23 09:12:41 +02:00
parent c527f7a4b8
commit 3efac6d7b7
Signed by: deblan
GPG key ID: 579388D585F70417
1 changed files with 37 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

37
README.md Normal file
View file

@ -0,0 +1,37 @@
# MU-GO
This project helps you to run a HTTP server and publish videos using an API.
A client gives you a way to play and download these videos.
## Installation
Builds are available for Linux (64 bits).
Download the latest binary from [releases](https://gitnet.fr/deblan/mu-go/releases).
`mpv` and `wget` are required.
## Usage
### Server side
```
muget serve --listen 127.0.0.1 --port 4000 --directory ./ --api-url http://127.0.0.1:4000
```
Arguments are optional.
In case of a reverse proxy, edit the API Url, eg: `--api-url https://videos.example.com`.
### Client side
```
muget play --api-url http://127.0.0.1:4000
muget download --api-url http://127.0.0.1:4000
```
Arguments are optionals.
In case of a reverse proxy, edit the API Url, eg: `--api-url https://videos.example.com`.
By default, videos are listed from oldest to newer. You can sort by name this using `--order name`.
To search videos by name, use `--name xxxxx`.