Go to file
Evan Fiordeliso 20a9e6d01a Move routes to a struct and add a HEAD handler for /download/proxy 2023-04-24 08:14:36 -04:00
.trunk Add basic chart 2023-04-14 23:37:52 -04:00
charts/ytdl-web Update helm chart version 2023-04-15 22:14:29 -04:00
cmd Update README file and cobra descriptions 2023-04-15 18:07:48 -04:00
version Update goreleaser config 2023-04-15 18:24:23 -04:00
web Move routes to a struct and add a HEAD handler for /download/proxy 2023-04-24 08:14:36 -04:00
ytdl Move routes to a struct and add a HEAD handler for /download/proxy 2023-04-24 08:14:36 -04:00
.air.toml Add more excluded dirs to air config 2023-04-15 20:18:30 -04:00
.dockerignore Add chart and docker publish tasks and fix env vars 2023-04-15 17:28:18 -04:00
.gitignore Clean up gitignore 2023-04-15 19:26:35 -04:00
.goreleaser.yaml Change id for linux build 2023-04-15 20:14:48 -04:00
CODE_OF_CONDUCT.md Update README and add license, contibuting, and code_of_conduct files 2023-04-15 19:43:21 -04:00
CONTRIBUTING.md Update README and add license, contibuting, and code_of_conduct files 2023-04-15 19:43:21 -04:00
Dockerfile Update Dockerfile for goreleaser 2023-04-15 19:54:42 -04:00
LICENSE.md Update README and add license, contibuting, and code_of_conduct files 2023-04-15 19:43:21 -04:00
README.md Update README and add license, contibuting, and code_of_conduct files 2023-04-15 19:43:21 -04:00
Taskfile.yml Move routes to a struct and add a HEAD handler for /download/proxy 2023-04-24 08:14:36 -04:00
config.example.yml Add yt-dlp path config value 2023-04-15 15:45:27 -04:00
go.mod Tidy up deps 2023-04-15 12:38:54 -04:00
go.sum Tidy up deps 2023-04-15 12:38:54 -04:00
main.go Initial commit with server 2023-04-14 11:58:32 -04:00

README.md

YTDL Web

Usage

ytdl-web [OPTIONS]

Available options:

  • -b, --base-path string the base path, used when behind reverse proxy
  • --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")

Building from source

Prerequisites:

Steps:

  1. Download dependencies
task deps
  1. Build binary
task build

Releasing

Prerequisites:

Steps:

  1. Ensure gitea access token is in ~/.config/goreleaser/gitea_token

  2. Run release task

task release

Publishing Chart

Prerequisites:

Steps:

  1. Add the helm repo
helm repo add --username {username} --password {password} gitea-apps https://git.fifitido.net/api/packages/apps/helm
  1. Publish the chart
task publish-chart

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use Semantic Versioning for versioning. For the versions available, see the tags on this repository.

Authors

  • Evan Fiordeliso - Initial project work - efiordeliso
  • Billie Thompson - Provided README Template - PurpleBooth

License

The project is licensed under the GPL v3 License - see the LICENSE.md file for details.