mirror of
https://codeberg.org/Hyperpipe/hyperpipe-backend
synced 2024-12-06 19:26:30 +01:00
Shiny Nematoda
80 lines
1.9 KiB
Markdown
80 lines
1.9 KiB
Markdown
## Hyperpipe-backend
|
|
|
|
Until NewPipeExtractor Supports Youtube Music Browse endpoints.
|
|
|
|
## Conifig
|
|
|
|
| env var | details |
|
|
| :---: | :---: |
|
|
| `HYP_PROXY=piped-proxy.example.tld` | hostname of the piped-proxy you would like to connect to |
|
|
| `HYP_PREFORK=1` | enable gofiber prefork (better performance, but may not work in all machines) |
|
|
|
|
## Self-Hosting
|
|
|
|
*Please see [Hyperpipe/Docker](https://codeberg.org/Hyperpipe/Docker) if hosting both the frontend and the backend*
|
|
|
|
### Docker
|
|
|
|
Run the [container](https://codeberg.org/Hyperpipe/-/packages/container/hyperpipe-backend/latest) with `HYP_PROXY` set as an env var
|
|
|
|
### Manual
|
|
|
|
```sh
|
|
go build -tags netgo -ldflags '-s -w' -o app
|
|
./app
|
|
```
|
|
|
|
## Official Frontend
|
|
|
|
https://codeberg.org/Hyperpipe/Hyperpipe
|
|
|
|
## Docs
|
|
|
|
### `GET` `/explore`
|
|
|
|
### `GET` `/genres`
|
|
|
|
### `GET` `/genres/:id`
|
|
|
|
- `:id` -> `ggMPO*`
|
|
|
|
### `GET` `/charts?params=${id}&code=${code}`
|
|
|
|
### `GET` `/next/:id?queue=${queue}`
|
|
|
|
- `:id` -> `song id (same as /watch?v=:id)`
|
|
- `$queue` -> `avoid` (optional)
|
|
|
|
### `GET` `/lyrics/:id`
|
|
|
|
- `:id` -> `MPLY*`
|
|
|
|
### `GET` `/channel/:id`
|
|
|
|
- `:id` -> `UC*`
|
|
|
|
### `GET` `/next/channel/:id/:params?ct=${click}&v=${visit}`
|
|
|
|
*Use with caution*
|
|
|
|
- `:id` -> `UC*`
|
|
|
|
## License
|
|
|
|
Hyperpipe-Backend
|
|
|
|
Copyright (C) 2022-24 Shiny Nematoda
|
|
|
|
This program is free software: you can redistribute it and/or modify
|
|
it under the terms of the GNU Affero General Public License as
|
|
published by the Free Software Foundation, either version 3 of the
|
|
License, or (at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU Affero General Public License for more details.
|
|
|
|
You should have received a copy of the GNU Affero General Public License
|
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|