Skip to content

docs: add GitHub repo clone URL to self-hosting auth server setup#219

Open
Tresillo2017 wants to merge 1 commit intogitroomhq:mainfrom
Tresillo2017:main
Open

docs: add GitHub repo clone URL to self-hosting auth server setup#219
Tresillo2017 wants to merge 1 commit intogitroomhq:mainfrom
Tresillo2017:main

Conversation

@Tresillo2017
Copy link
Copy Markdown

@Tresillo2017 Tresillo2017 commented Apr 6, 2026

What

Adds a "Clone the Repository" step to the self-hosting section of cli/authentication.mdx, pointing readers to https://github.com/gitroomhq/postiz-agent with the exact git clone command.

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-agent before following the remaining steps.

Changes

  • Added Step 1 – Clone the Repository with a link to gitroomhq/postiz-agent and the git clone + cd commands
  • Renumbered existing steps: 1→2, 2→3, 3→4, 4→5, 5→6
  • Removed the redundant cd server line from the "Run the Server" step (now covered in step 1)

Summary by CodeRabbit

  • Documentation
    • Enhanced self-hosting setup documentation by reorganizing step-by-step instructions with clearer guidance for repository cloning and server initialization. Removed redundant command sequences and streamlined the configuration workflow to make the deployment process more accessible and easier for users to follow and implement.

Copilot AI review requested due to automatic review settings April 6, 2026 21:52
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 6, 2026

📝 Walkthrough

Walkthrough

Documentation 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

Cohort / File(s) Summary
Documentation Updates
cli/authentication.mdx
Reordered self-hosting instructions with new "Clone the Repository" step, renumbered all following sections, and simplified "Run the Server" commands by removing redundant cd server direction.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A hop through the docs, so neat and so clear,
New steps in order bring joy to the ear!
Clone, then configure, no fuss, no delay,
Instructions aligned brighten up the day!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately reflects the main change: adding a GitHub repository clone instruction to the self-hosting authentication server setup documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@postiz-agent
Copy link
Copy Markdown

postiz-agent bot commented Apr 6, 2026

Snyk checks have passed. No issues have been found so far.

Status Scan Engine Critical High Medium Low Total (0)
Code Security 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

🧹 Nitpick comments (1)
cli/authentication.mdx (1)

124-135: Add pnpm to prerequisites to prevent setup friction.

Line 127+ requires pnpm, but prerequisites currently list only Node.js and PostgreSQL. Please add pnpm (or a fallback npm path) 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.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: c11fb65c-a1ed-4331-884d-2d94d11928d7

📥 Commits

Reviewing files that changed from the base of the PR and between 11afbcd and 9df2f4e.

📒 Files selected for processing (1)
  • cli/authentication.mdx

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

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-agent and cd into the server directory
  • Renumbered the remaining self-hosting steps accordingly
  • Removed the now-redundant cd server line from the “Run the Server” step

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines +124 to 128
### 5. Run the Server

```bash
cd server
pnpm install

Copy link

Copilot AI Apr 6, 2026

Choose a reason for hiding this comment

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

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”.

Copilot uses AI. Check for mistakes.
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