Skip to content

docs(readme): document env vars, missing endpoints and the published image - #15

Open
odntht wants to merge 2 commits into
got-feedBack:mainfrom
odntht:docs/env-vars-and-endpoints
Open

odntht wants to merge 2 commits into
got-feedBack:mainfrom
odntht:docs/env-vars-and-endpoints

Conversation

@odntht

@odntht odntht commented Oct 16, 2026 •

Copy link
Copy Markdown

What was wrong

  • The README listed three env vars (SLOPSMITH_DEMUCS_MODEL, SLOPSMITH_DEMUCS_DEVICE, SLOPSMITH_API_KEY). server.py also reads SLOPSMITH_DEMUCS_CACHE_MAX_JOBS (server.py:254), MODEL_IDLE_TIMEOUT (:215) and SLOPSMITH_MAX_WHISPERX_ALIGNERS (:543). The Docker table did not list PORT / HOST, which docker-entrypoint.sh:105 passes to server.py.
  • SLOPSMITH_DEMUCS_DEVICE is read into DEMUCS_DEVICE (server.py:80) but never used. _device starts as "" (:320) and only --device or GPU detection sets it. So the README's claim that it overrides the CLI default is not true today.
  • The API section did not mention POST /separate-url (server.py:487) or DELETE /cache/{job_id} (server.py:1776).

What changed

  • Replaced the one-line env var list under Run with a table (variable, default from code, behavior). SLOPSMITH_DEMUCS_DEVICE is left out. Use --device until the variable is wired up.
  • Added PORT and HOST rows to the Docker env table.
  • The upstream docker pull used ghcr.io/byrongamatos/slopsmith-demucs-server. It now uses ghcr.io/got-feedback/feedback-demucs-server:latest. That is the lowercased name CI tags (${REPO_NAME,,} in docker-build.yml), the image: in docker-compose.yml, and an anonymous manifest fetch for :latest returns 200.
  • Documented POST /separate-url (JSON body {"url": ...}, same stems/model query params, 400 on missing URL or failed download) and DELETE /cache/{job_id} (returns {"ok": true}, 400 on an invalid job ID).

Not in this PR

The title, intro link and badge rename is already covered by #12, so this PR leaves those lines alone. This PR does fix the docker pull line, because #12 changes it to ghcr.io/got-feedBack/feedBack-demucs-server:latest. Docker rejects that reference since registry repository names must be lowercase. #12 also renames the variables to FEEDBACK_*. Whichever PR lands second needs the names in the new table adjusted. I can rebase this one if #12 merges first.

Verification

Every default was read from server.py, docker-entrypoint.sh and the Dockerfile on main. The new #cache-cleanup anchor matches the existing heading.

🤖 Generated with Claude Code

Add a table of the environment variables server.py reads, with defaults from the code. Add PORT and HOST to the Docker table. Document POST /separate-url and DELETE /cache/{job_id}, which exist in server.py but were missing from the API section. Drop SLOPSMITH_DEMUCS_DEVICE from the list: it is read but never applied.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Signed-off-by: odntht <odntht@gmail.com>
@coderabbitai

coderabbitai Bot commented Oct 16, 2026 •

Copy link
Copy Markdown

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: fda4fda0-42eb-48e5-be43-5414d587c611
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

The upstream docker pull used byrongamatos/slopsmith-demucs-server. CI publishes ghcr.io/got-feedback/feedback-demucs-server (lowercased repo name), which is also what docker-compose.yml uses.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Signed-off-by: odntht <odntht@gmail.com>
@odntht odntht changed the title docs(readme): document server env vars and missing endpoints docs(readme): document env vars, missing endpoints and the published image Oct 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant