Skip to content

docs: add GitHub repo clone URL to self-hosting setup #6

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

Open
Tresillo2017 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add GitHub repo clone URL to self-hosting setup #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 11 additions & 4 deletions server/SERVER.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,19 +41,26 @@ CLI Auth Server Postiz

## Setup

### 1. Create an OAuth app in Postiz
### 1. Clone the repository

```bash
git clone https://github.com/gitroomhq/postiz-agent.git
cd postiz-agent/server
```

### 2. Create an OAuth app in Postiz

Go to Postiz Settings → Developer → OAuth Apps and create a new app. Set the callback URL to:

```
https://your-server-domain.com/device/callback
```
Comment on lines 55 to 57

@coderabbitai coderabbitai Bot Apr 6, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Add a language tag to the fenced code block to satisfy markdownlint (MD040).

The callback URL block is missing a fence language identifier.

Suggested doc fix 
-```
+```text
 https://your-server-domain.com/device/callback
</details>

<!-- suggestion_start -->

<details>
<summary>📝 Committable suggestion</summary>

> ‼️ **IMPORTANT**
> Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

```suggestion
🧰 Tools
🪛 markdownlint-cli2 (0.22.0)

[warning] 55-55: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@server/SERVER.md` around lines 55 - 57, The fenced code block showing
"https://your-server-domain.com/device/callback" is missing a language tag;
update that code fence to include a language identifier (e.g., add "text" after
the opening ```), so the block becomes ```text ... ``` to satisfy markdownlint
MD040 while preserving the exact URL content.


### 2. Set up Postgres
### 3. Set up Postgres

Create a database. The server auto-creates the `device_requests` table on startup.

### 3. Configure environment
### 4. Configure environment

```bash
export DATABASE_URL="postgresql://user:password@localhost:5432/postiz_auth"
Expand All @@ -62,7 +69,7 @@ export POSTIZ_OAUTH_CLIENT_SECRET="pcs_xxx"
export SERVER_URL="https://cli-auth.postiz.com"
```

### 4. Run
### 5. Run

```bash
# Install dependencies
Expand Down
Loading