docs: fix self-host first-run break, pgvector prereq, licensing drift - #3
Merged
Merged
Conversation
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
Contributor
Author
There was a problem hiding this comment.
Devin Review found 1 potential issue.
1 flag not posted on this PR by your GitHub settings — view it in Devin Review. (Configure)
Comment on lines
+80
to
+83
| `.env.example` defaults `DASHBOARD_BASE_URL` / `API_BASE_URL` to localhost and | ||
| `GITHUB_APP_SLUG` to a placeholder on purpose: unset, the backend falls back to | ||
| the hosted `argus.reviews` origins and the `argus-eye` slug, and your install | ||
| would post GitHub comments linking to a dashboard you don't run. |
Contributor
Author
There was a problem hiding this comment.
🟡 Direct setup ignores copied configuration
After users edit .env, the documented go run commands never load it. Startup fails because required database and GitHub settings remain unset.
Prompt for agents
Update docs/self-hosting.md's direct backend setup to distinguish shell execution from Docker Compose. The Go binaries read process environment variables and do not load backend/.env. Tell users to export the file before running go run (for example with set -a; source .env; set +a), or provide an equivalent command that explicitly loads it. Keep the note that Docker Compose loads backend/.env automatically.
Was this helpful? React with 👍 or 👎 to provide feedback.
Co-Authored-By: Dhruv <dhruvkhara167@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Open-source audit of the repo. Secrets/leftovers came back clean (gitleaks over all 430 commits found only the dummy
pk_test_Y2xlcmsuZXhhbXBsZS5jb20kin CI; no keys, PEMs, personal data,.env, or internal links in tree or history). The fixes here are all self-hosting/licensing accuracy:backend/.env.examplecrash-loops a fresh self-host. It shippedMERMAID_VALIDATOR_BASE_URL=http://localhost:3000with an emptyMERMAID_VALIDATOR_SECRET, andconfig.Loadrejects a half-set pair — so the documented path (cp .env.example .env→docker compose up) never starts:loading config: MERMAID_VALIDATOR_BASE_URL and MERMAID_VALIDATOR_SECRET must be configured together, restarting forever. Both are now commented out, with the pairing rule stated in the file and in the self-hosting guide.DASHBOARD_BASE_URL=https://argus.reviews/API_BASE_URL=https://api.argus.reviews/GITHUB_APP_SLUG=argus-eyemeant a self-host that copied the example posted GitHub comments linking to a dashboard it doesn't run. Example now defaults to localhost +your-app-slug, and the fallback behaviour is documented.057hard-fails below pgvector 0.8.2, but README only said "PostgreSQL (or Neon)". Added a Postgres requirements section (required pgvector ≥ 0.8.2, optional pgcontext,CREATE EXTENSIONprivilege).docs/architecture.mdclaimed a different license than the repo has — a "Sustainable Use License" core/enterprise split with.ee.files (no such files exist,LICENSEis AGPL-3.0, README says no feature gating). Rewritten to AGPL-3.0.api.voyageai.com/v1+voyage-4) nor the example file;EMBEDDINGS_DIMENSIONSwas the one env var in code but not in.env.example. Both fixed.testcommand (@<slug> test [--code]) was missing from the architecture command table/regex/flowchart; CONTRIBUTING now says theCLAUDE.mdadversarial gate is maintainer-side so external contributors don't try to run it.Why
The repo is public and self-hosting is the headline promise, but the documented first run does not boot, and the license section contradicts
LICENSE.Verified end to end on a clean machine:
docker compose down -vthencp .env.example .env+ENCRYPTION_KEY→ migrations apply to version 85 andGET /healthzreturns{"status":"ok"}. Before the change the same sequence crash-loops.Checklist
web/unchangedLink to Devin session: https://app.devin.ai/sessions/574b4293927945cead22d3c0c80c5767
Open in Devin Desktop: https://app.devin.ai/desktop/session/574b4293927945cead22d3c0c80c5767?variant=devin
Requested by: @BeLazy167