Update README file
This commit is contained in:
parent
17f427644e
commit
ababeaacf8
38
README.md
38
README.md
|
@ -1,5 +1,41 @@
|
|||
# YTDL Web
|
||||
|
||||
## Usage
|
||||
|
||||
```sh
|
||||
ytdl-web [OPTIONS]
|
||||
```
|
||||
|
||||
Available options:
|
||||
|
||||
- -b, --base-path string the base path, used when behind reverse proxy (default is "")
|
||||
- --config string config file (default is $XDG_CONFIG_HOME/ytdl-web/config.yml)
|
||||
- -h, --help help for ytdl-web
|
||||
- -l, --listen string address to listen on (default is 127.0.0.1) (default "127.0.0.1")
|
||||
- -p, --port int port to listen on (default is 8080) (default 8080)
|
||||
- -y, --ytdlp-path string the path to the yt-dlp binary, used when it is not in $PATH (default is yt-dlp) (default "yt-dlp")
|
||||
|
||||
## Building from source
|
||||
|
||||
Prerequisites:
|
||||
|
||||
- [go v1.20](https://go.dev/doc/install)
|
||||
- [task cli](https://taskfile.dev/installation/)
|
||||
|
||||
Steps:
|
||||
|
||||
1. Download dependencies
|
||||
|
||||
```sh
|
||||
task deps
|
||||
```
|
||||
|
||||
2. Build binary
|
||||
|
||||
```sh
|
||||
task build
|
||||
```
|
||||
|
||||
## Publishing Docker Image
|
||||
|
||||
Prerequsites:
|
||||
|
@ -34,7 +70,7 @@ Steps:
|
|||
1. Add the helm repo
|
||||
|
||||
```sh
|
||||
helm repo add --username {username} --password {password} gitea-apps https://gitea.example.com/api/packages/apps/helm
|
||||
helm repo add --username {username} --password {password} gitea-apps https://git.fifitido.net/api/packages/apps/helm
|
||||
```
|
||||
|
||||
2. Publish the chart
|
||||
|
|
Loading…
Reference in New Issue