Sulkta-OSS/torttube
Archived
3
0
Fork 0
Code Issues 1 Pull requests Projects Releases Packages Wiki Activity Actions

Public-flip audit: generalize internal hosts/paths + drop Sulkta-internal refs

Browse source 
URLs, mount paths, and LAN host bindings parameterized via env or relative paths
so the repo stands up from a clean clone anywhere. Drop cross-codebase refs
internal client/merchant test fixtures,
and audit-changelog scaffolding from comments. README terser, technical content
preserved.
This commit is contained in:
Sulkta 2026-05-27 11:25:46 -07:00
parent 79af13b8ef
commit 9d70a23df5
6 changed files with 731 additions and 64 deletions
Download patch file Download diff file Expand all files Collapse all files

27
docs/install.md
View file

@ -5,27 +5,24 @@ contains the Python addon, a static aarch64 sidecar binary, and yt-dlp's
aarch64 release binary (for Tier 2/3 fallback). Nothing else needs to be
installed on the Pi.
## Build the zip (Sulkta-internal)
## Build the zip
```bash
bash scripts/build-addon-zip.sh
# → /srv/downloads/torttube/plugin.video.torttube-0.0.1.zip on the build host
# → dist/plugin.video.torttube-<version>.zip
```
The script cross-compiles the sidecar in a throwaway
`messense/rust-musl-cross:aarch64-musl` container, fetches yt-dlp's
official `yt-dlp_linux_aarch64` release binary, packages everything,
drops the result at `/srv/downloads/torttube/` (file share).
universal Python zipapp, and drops the result at `dist/` under the
repo root. Override `DEST_DIR=...` to land it elsewhere.
## Install on the Pi (Kodi UI flow)
1. On the Pi: Settings → File manager → Add source → enter
`smb://fileserver/downloads/` → name it `downloads`.
2. Settings → Add-ons → Install from zip file → `downloads` →
`torttube/plugin.video.torttube-<version>.zip`.
3. Kodi installs torttube **and automatically installs
`plugin.video.youtube`** from the official Kodi repo because it's
declared as a dep in our addon.xml. No separate install step needed.
1. Copy the zip onto the Pi (SMB share, scp, USB stick — anything).
2. Settings → Add-ons → Install from zip file → pick the zip.
3. Kodi installs torttube and pulls `plugin.video.youtube` from the
official Kodi repo (declared as a dep in addon.xml).
4. The addon appears under Video add-ons.
Unsigned addons need `Settings → System → Add-ons → Unknown sources` ON.
@ -41,7 +38,7 @@ ssh kodi-host 'cd /storage/.kodi/addons && unzip -o /tmp/plugin.video.torttube-0
ssh kodi-host 'systemctl restart kodi'
# wait ~5s for Kodi to come back, then enable the addon
curl -u kodi:<pw> -H "Content-Type: application/json" -X POST http://<kodi-host>:8080/jsonrpc \
curl -u kodi:<pw> -H "Content-Type: application/json" -X POST http://kodi-host:8080/jsonrpc \
-d '{"jsonrpc":"2.0","id":1,"method":"Addons.SetAddonEnabled","params":{"addonid":"plugin.video.torttube","enabled":true}}'
```
@ -82,6 +79,6 @@ few seconds (rustypipe resolve takes ~1s, then Kodi starts the stream).
## Updating
Just rebuild + bump the version in `addon/plugin.video.torttube/addon.xml`,
re-run `build-addon-zip.sh`, install the new zip from the same SMB
location. Kodi will treat it as an upgrade if the version is higher.
Bump the version in `addon/plugin.video.torttube/addon.xml`, re-run
`build-addon-zip.sh`, install the new zip. Kodi treats it as an
upgrade if the version is higher.

7
docs/remote-control.md
View file

@ -7,13 +7,14 @@ out of the box once the addon is installed.
## Endpoint
```
POST http://<rpi-host>:8080/jsonrpc
POST http://<kodi-host>:8080/jsonrpc
Authorization: Basic base64(kodi:<password>)
Content-Type: application/json
```
Example defaults: `http://kodi-host:8080`, user
`kodi`, password `<password>`.
Default Kodi user is `kodi`. The HTTP-control web server and a
password must be enabled via `Settings → Services → Control` before
JSON-RPC works.
## Play by YouTube ID