mu-go/README.md

41 lines
989 B
Markdown
Raw Normal View History

2022-08-23 09:12:41 +02:00
# MU-GO
This project helps you to run a HTTP server and publish videos using an API.
2022-08-23 09:16:38 +02:00
A client gives you a way to play and download these videos in an interactive way.
2022-08-23 09:12:41 +02:00
## 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
```
2022-08-23 09:15:03 +02:00
muget serve --listen 127.0.0.1 --port 4000 --directory . --api-url http://127.0.0.1:4000
2022-08-23 09:12:41 +02:00
```
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
2022-08-23 09:15:03 +02:00
muget download --api-url http://127.0.0.1:4000 --directory .
2022-08-23 09:12:41 +02:00
```
2022-08-23 09:15:03 +02:00
`--directory` is optional.
2022-08-23 09:12:41 +02:00
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`.
2022-08-23 09:15:03 +02:00