docs: add installing and configuring guide for first deployment#329
Open
mason5052 wants to merge 2 commits into
Open
docs: add installing and configuring guide for first deployment#329mason5052 wants to merge 2 commits into
mason5052 wants to merge 2 commits into
Conversation
Issue vxcontrol#61 asked for a proper guide on how to start using PentAGI. A first-use guide (How to Use PentAGI After Login) already covers what to do after login, but the maintainer kept the issue open until an article about installing and configuring the product is published. Add examples/guides/installation_configuration.md, a concise ordered walkthrough that connects the existing detailed README sections into a single path: choose installer vs manual Docker Compose, set core server variables (PUBLIC_URL, CORS_ORIGINS, security vars), configure and test an LLM provider with ctester, configure and test the embedding provider with etester, optionally add search providers and the Graphiti/Langfuse/ observability stacks, then start and verify the stack and change the default admin password. It ends with a quick checklist and links forward to the existing post-login usage guide. The guide links to the relevant README reference sections rather than duplicating them. A single pointer link is added at the top of the README Quick Start section for discoverability. Docs only. No installer behavior, runtime code, env vars, or schema changes. Every environment variable named in the guide already exists in .env.example and backend/pkg/config/config.go.
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Adds a concise installation/configuration walkthrough and links it from the README to bridge setup → provider testing → first login.
Changes:
- Added a new step-by-step guide for installation, core
.envsettings, provider configuration/testing, and validation steps. - Linked the new guide from the README “Quick Start” section.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| examples/guides/installation_configuration.md | New end-to-end setup checklist-style guide (install → configure → test → first login). |
| README.md | Adds a pointer to the new guide from Quick Start to improve discoverability. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Use the package-path form for the tester utilities (go run ./cmd/ctester, go run ./cmd/etester test) instead of shell glob / single-file invocations, which are more portable and avoid the multi-file compile pitfall. - Add -verbose to the container etester example so it matches the local example. - Wrap the new README Quick Start pointer across multiple lines; rendered Markdown is unchanged.
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.
Summary
Add
examples/guides/installation_configuration.md, a concise ordered walkthrough that takes a new user from installation to a configured, verified first run, and link it from the README Quick Start section. Docs only.Problem
Issue #61 asked for a proper guide on how to start using PentAGI. A first-use guide (How to Use PentAGI After Login) already covers what to do after login. However, the maintainer kept the issue open with:
The README does contain detailed installer, manual-install, per-provider, and tester sections, but there is no single ordered "install -> configure -> test -> first run" article that threads them together. New users have to assemble that path themselves.
Solution
Add a standalone guide under
examples/guides/(matching the existingworker_node.md/vllm-qwen35-27b-fp8.mdconvention) that walks through, in order:PUBLIC_URL,CORS_ORIGINS, listen IP/port,COOKIE_SIGNING_SALT, DB passwords).ctester.etester.ctester/etester/ftester, changing the default admin password).It ends with a first-run checklist and links forward to the existing post-login usage guide. The guide links to the relevant README reference sections rather than duplicating them, and a single pointer link is added at the top of the README Quick Start section for discoverability.
User Impact
Test Plan
git diff --checkclean.README.md(+2 lines) and the newexamples/guides/installation_configuration.md. No runtime, installer, schema, or env-var changes..env.exampleand/orbackend/pkg/config/config.go.ctester,etester test,ftester).Refs #61