ytdl-web/README.md

99 lines
1.7 KiB
Markdown
Raw Normal View History

2023-04-14 17:17:11 -04:00
# YTDL Web
2023-04-15 17:32:44 -04:00
## Usage
```sh
ytdl-web [OPTIONS]
```
Available options:
- -b, --base-path string the base path, used when behind reverse proxy
2023-04-15 17:32:44 -04:00
- --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 "127.0.0.1")
- -p, --port int port to listen on (default 8080)
- -y, --ytdlp-path string the path to the yt-dlp binary, used when it is not in $PATH (default "yt-dlp")
2023-04-15 17:32:44 -04:00
## 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
```
2023-04-15 18:24:23 -04:00
## Releasing
Prerequisites:
- [go v1.20](https://go.dev/doc/install)
- [goreleaser](https://goreleaser.com/install/)
- [task cli](https://taskfile.dev/installation/)
Steps:
1. Ensure gitea access token is in `~/.config/goreleaser/gitea_token`
2. Run release task
```sh
task release
```
## Publishing Docker Image
2023-04-15 18:24:23 -04:00
Prerequisites:
- [docker](https://docs.docker.com/engine/install/)
- [task cli](https://taskfile.dev/installation/)
Steps:
1. Login to the container registry
```sh
docker login git.fifitido.net
```
2. Publish the container image
```sh
task docker:publish
```
## Publishing Chart
2023-04-15 18:24:23 -04:00
Prerequisites:
- [helm cli](https://helm.sh/docs/intro/install/)
- [cm-push helm plugin](https://github.com/chartmuseum/helm-push/).
- [task cli](https://taskfile.dev/installation/)
Steps:
1. Add the helm repo
```sh
2023-04-15 17:32:44 -04:00
helm repo add --username {username} --password {password} gitea-apps https://git.fifitido.net/api/packages/apps/helm
```
2. Publish the chart
```sh
task chart:publish
```