docs: add GitHub repo clone URL to self-hosting auth server setup#219
docs: add GitHub repo clone URL to self-hosting auth server setup#219Tresillo2017 wants to merge 1 commit intogitroomhq:mainfrom
Conversation
📝 WalkthroughWalkthroughDocumentation update to self-hosting instructions in the CLI authentication guide. Added a new "Clone the Repository" step with git commands and reorganized subsequent sections (OAuth, Postgres, environment, server execution, CLI configuration) by incrementing their numbering. Removed redundant directory change instruction from the server-running step. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
cli/authentication.mdx (1)
124-135: Addpnpmto prerequisites to prevent setup friction.Line 127+ requires
pnpm, but prerequisites currently list only Node.js and PostgreSQL. Please addpnpm(or a fallbacknpmpath) in the prerequisites section so readers don’t get blocked mid-setup.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@cli/authentication.mdx` around lines 124 - 135, Update the prerequisites section to include pnpm (or mention npm as an alternative) so users have the package manager required by the "Run the Server" commands; modify the "Prerequisites" header content in cli/authentication.mdx to list "pnpm" with an optional note like "or npm" and a short install hint so readers aren’t blocked when they reach the pnpm commands under the "Run the Server" section.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@cli/authentication.mdx`:
- Around line 124-135: Update the prerequisites section to include pnpm (or
mention npm as an alternative) so users have the package manager required by the
"Run the Server" commands; modify the "Prerequisites" header content in
cli/authentication.mdx to list "pnpm" with an optional note like "or npm" and a
short install hint so readers aren’t blocked when they reach the pnpm commands
under the "Run the Server" section.
There was a problem hiding this comment.
Pull request overview
Adds an explicit “Clone the Repository” step to the self-hosted auth server setup guide so readers know where to get the auth server code before creating an OAuth app.
Changes:
- Added Step 1 to clone
gitroomhq/postiz-agentandcdinto the server directory - Renumbered the remaining self-hosting steps accordingly
- Removed the now-redundant
cd serverline from the “Run the Server” step
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ### 5. Run the Server | ||
|
|
||
| ```bash | ||
| cd server | ||
| pnpm install | ||
|
|
There was a problem hiding this comment.
This section uses pnpm commands, but the setup prerequisites above don’t mention installing/enabling pnpm (e.g., via Corepack) or provide an npm alternative. Adding a brief note would prevent readers from hitting “pnpm: command not found”.
What
Adds a "Clone the Repository" step to the self-hosting section of
cli/authentication.mdx, pointing readers tohttps://github.com/gitroomhq/postiz-agentwith the exactgit clonecommand.Why
The current setup section jumps straight to creating an OAuth app with no indication of where the server code lives. A first-time reader has no way to know they need to clone
postiz-agentbefore following the remaining steps.Changes
gitroomhq/postiz-agentand thegit clone+cdcommandscd serverline from the "Run the Server" step (now covered in step 1)Summary by CodeRabbit