Skip to content

Update config note in README for public release #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nullfox merged 2 commits into from
Jul 13, 2026
Merged

Update config note in README for public release #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9b9c055
Update config note in README for public release
claude Jul 13, 2026
3ed566b
Move deploy host to secrets.DEPLOY_HOST in CI workflow
claude Jul 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .github/workflows/main.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ jobs:
uses: wlixcc/SFTP-Deploy-Action@v1.2.4
with:
username: root
server: 193.43.134.230
server: ${{ secrets.DEPLOY_HOST }}
ssh_private_key: ${{ secrets.SSH_PRIVATE_KEY }}
# will put all file under this path
local_path: lib/*
Expand All @@ -53,7 +53,7 @@ jobs:
uses: fifsky/ssh-action@v0.0.6
with:
command: pm2 restart socket
host: 193.43.134.230
host: ${{ secrets.DEPLOY_HOST }}
user: root
key: ${{ secrets.SSH_PRIVATE_KEY }}

Expand All @@ -63,7 +63,7 @@ jobs:
uses: fifsky/ssh-action@v0.0.6
with:
command: pm2 restart api
host: 193.43.134.230
host: ${{ secrets.DEPLOY_HOST }}
user: root
key: ${{ secrets.SSH_PRIVATE_KEY }}

Expand All @@ -73,6 +73,6 @@ jobs:
uses: fifsky/ssh-action@v0.0.6
with:
command: pm2 restart queue
host: 193.43.134.230
host: ${{ secrets.DEPLOY_HOST }}
user: root
key: ${{ secrets.SSH_PRIVATE_KEY }}
11 changes: 4 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -555,13 +555,10 @@ processes with `TZ=UTC` and debug-level logging.
`total_volume`) that the code writes to — the live DB is ahead of the checked-in schema
definition. Keep this in mind when running `database:reset`.

- **Secrets are read from the environment.** Credentials (Polygon API key, Reddit client
id/secret, ClickSend auth, DB password, Redis URL, Yahoo cookie) are read from
environment variables — see `.env.example`. Historically these were committed inline in
source; that history still contains the leaked values, so **the leaked credentials must
be rotated with each provider**, and the git history should be scrubbed, before this repo
is made public. Rotation is the only step that actually neutralizes the leak — the
secrets must be assumed compromised.
- **Configuration is environment-driven.** All credentials (Polygon API key, Reddit client
id/secret, ClickSend auth, DB connection, Redis URL, Yahoo cookie) are read from
environment variables — copy `.env.example` to `.env` and fill it in. No secrets are
committed to the repository.

- **Legacy code retained.** `polygonLegacy.ts`, the Yahoo/TipRanks scrapers, `notifyMovers`,
and chunks of commented-out schema represent earlier iterations and half-built features
Expand Down
Loading