Skip to content

Keep the production server's details out of the public README - #32

Merged
zanwenfu merged 1 commit into
mainfrom
docs/readme-no-server-details
Oct 4, 2026
Merged

zanwenfu merged 1 commit into
mainfrom
docs/readme-no-server-details

Conversation

@zanwenfu

@zanwenfu zanwenfu commented Oct 4, 2026

Copy link
Copy Markdown
Collaborator

The public README's deployment section printed the production host's address and a root SSH command. The app and API sit behind Cloudflare so the origin address stays hidden; this line gave it away.

The section also had two stale items:

  • a Docker Hub badge and link for fuzanwenn/stock-analyst, an image that no longer exists (404);
  • a push-and-pull release recipe the project no longer uses (production builds on the host and pins by digest).

Changes

  • Remove the dead Docker Hub badge.
  • "The published image (…)" becomes "The image is linux/amd64".
  • Replace the server-specific release steps with one accurate sentence. Production builds the image from source on the production host, and the API runs it by its immutable digest, never :latest. The steps stay in the private operations notes.

Docs only; no code change.

Note: the address remains in this repo's git history (3 earlier commits). Removing it here stops new readers from seeing it; protecting SSH on the host is the lasting fix.

🤖 Generated with Claude Code

https://claude.ai/code/session_01PnXmSYpqKrQVxdzGZyq9Ct

The deployment section printed the production host's address and a
root SSH command, which undoes the origin masking the app and API get
from Cloudflare. It also linked a Docker Hub image that no longer
exists (404) and described a push-and-pull release the project no
longer uses. The section now says how production runs the worker
(built from source, run by immutable digest) and leaves the steps to
the private operations notes. The dead Docker badge goes too.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01PnXmSYpqKrQVxdzGZyq9Ct
Copilot AI balanced review requested due to automatic review settings October 4, 2026 05:06

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@zanwenfu
zanwenfu merged commit 176a62b into main Oct 4, 2026
1 check passed
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.

2 participants