Skip to content

Commit 437111c

Browse files
committed
docs: improve self-hosting docs
1 parent 0ddd1f6 commit 437111c

File tree

4 files changed

+63
-18
lines changed

4 files changed

+63
-18
lines changed

apps/public/content/docs/self-hosting/changelog.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,4 +54,4 @@ volumes:
5454

5555
## 0.0.6
5656

57-
Removed Clerk.com and added self-hosted authentication.
57+
Removed Clerk.com and added self-hosted authentication. For more info read our [migrating from clerk](/docs/self-hosting/migrating-from-clerk)

apps/public/content/docs/self-hosting/meta.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"defaultOpen": true,
44
"pages": [
55
"[Get started](/docs/self-hosting/self-hosting)",
6-
"changelog",
7-
"migrating-from-clerk"
6+
"supporter-access-latest-docker-images",
7+
"changelog"
88
]
99
}

apps/public/content/docs/self-hosting/self-hosting.mdx

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,51 @@ Features that require e-mail:
112112
- Invitations
113113
- more will be added over time
114114

115+
### AI integration
116+
117+
OpenPanel includes an AI-powered analytics assistant that can help you analyze data, create reports, and answer questions about your analytics. To enable this feature, you need to configure an API key for either OpenAI or Anthropic.
118+
119+
#### Supported Models
120+
121+
- **OpenAI** (default)
122+
- `gpt-4o` - More powerful but higher cost
123+
- `gpt-4o-mini` - Default model, good balance of performance and cost
124+
- **Anthropic**
125+
- `claude-3-5-haiku-latest` - Fast and cost-effective
126+
127+
#### Configuration
128+
129+
Add the following environment variables to your `.env` file in the `self-hosting` directory:
130+
131+
**For OpenAI (default):**
132+
133+
```bash title=".env"
134+
OPENAI_API_KEY=sk-your-openai-api-key-here
135+
AI_MODEL=gpt-4o-mini # Optional: defaults to gpt-4o-mini
136+
```
137+
138+
**For Anthropic:**
139+
140+
```bash title=".env"
141+
ANTHROPIC_API_KEY=your-anthropic-api-key-here
142+
AI_MODEL=claude-3-5
143+
```
144+
145+
#### Getting API Keys
146+
147+
- **OpenAI**: Get your API key from [platform.openai.com/api-keys](https://platform.openai.com/api-keys)
148+
- **Anthropic**: Get your API key from [console.anthropic.com](https://console.anthropic.com)
149+
150+
<Callout type="info">
151+
The AI assistant is optional. Without an API key configured, the AI chat feature will not be available, but all other OpenPanel features will continue to work normally.
152+
</Callout>
153+
154+
<Callout type="warn">
155+
AI features will incur costs based on your usage and the model you choose. Monitor your API usage through your provider's dashboard to avoid unexpected charges.
156+
</Callout>
157+
158+
159+
115160
### Managed Redis
116161

117162
If you use a managed Redis service, you may need to set the `notify-keyspace-events` manually.

apps/public/content/docs/self-hosting/supporter-access-latest-docker-images.mdx

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -3,45 +3,45 @@ title: Supporter Access - Latest Docker Images
33
description: Get access to OpenPanel's latest private Docker images with bleeding-edge features built on every commit.
44
---
55

6-
## Thank You for Your Support! 🙏
6+
## Thank you for your support! 🙏
77

88
First and foremost, **thank you** for supporting OpenPanel! Your contribution means the world to us and helps keep this project alive, maintained, and constantly improving. Every dollar you contribute goes directly into development, infrastructure, and making OpenPanel better for everyone.
99

1010
As a supporter, you get exclusive access to our private Docker images that are built with every commit, giving you the absolute latest features and fixes before they're publicly released.
1111

12-
## Why Latest Images Matter
12+
## Why latest images matter
1313

14-
### Bleeding-Edge Features
14+
### Bleeding-edge features
1515
- **Instant access**: Get new features the moment they're merged
1616
- **Early bug fixes**: Patches and fixes deployed immediately
1717
- **Continuous improvements**: Performance enhancements and optimizations in real-time
1818
- **Stay ahead**: Run the most advanced version of OpenPanel available
1919

20-
### Built on Every Commit
20+
### Built on every commit
2121
We maintain a continuous integration pipeline that builds new Docker images with every single commit to our repository. This means:
2222
- Zero delay between development and deployment
2323
- Production-ready images tested and validated automatically
2424
- Access to features weeks or months before stable releases
2525

26-
## How It Works
26+
## How it works
2727

2828
Our private Docker images are hosted on GitHub's container registry and protected from public access. As a supporter, you get an API key that grants you access to our private Docker proxy at `docker.openpanel.dev`, which seamlessly pulls these images for you.
2929

30-
## Getting Started
30+
## Getting started
3131

32-
### Step 1: Become a Supporter
32+
### Step 1: Become a supporter
3333

3434
Support starts at just **$20/month** and includes:
3535
- Access to all private Docker images
3636
- Priority support in our Discord community
3737
- Direct impact on OpenPanel's development
3838
- Our eternal gratitude ❤️
3939

40-
### Step 2: Get Your API Key
40+
### Step 2: Get your API key
4141

4242
Once you become a supporter, you'll receive a unique API key that grants access to our Docker proxy.
4343

44-
### Step 3: Login to Docker Registry
44+
### Step 3: Login to docker registry
4545

4646
On your server, authenticate with our Docker proxy using your API key:
4747

@@ -55,7 +55,7 @@ Replace `your_api_key` with the actual API key provided to you.
5555
Make sure to keep your API key secure and never commit it to version control!
5656
</Callout>
5757

58-
### Step 4: Update to Latest Images
58+
### Step 4: Update to latest images
5959

6060
We've created a convenient script to make updating your images effortless. Navigate to your self-hosting folder and run:
6161

@@ -79,7 +79,7 @@ You can also check what tags are available without applying them:
7979
./get_latest_images --list # List all available tags
8080
```
8181

82-
### Step 5: Restart Your Services
82+
### Step 5: Restart your services
8383

8484
After pulling the latest images, simply restart your services:
8585

@@ -89,7 +89,7 @@ After pulling the latest images, simply restart your services:
8989

9090
That's it! Your OpenPanel instance is now running the latest and greatest version.
9191

92-
## Quick Update Workflow
92+
## Quick update workflow
9393

9494
Once you're set up, updating to the latest version is as simple as:
9595

@@ -107,13 +107,13 @@ The `get_latest_images` script will:
107107
3. Update your `docker-compose.yml` with images pointing to the latest commit SHAs
108108
4. Create a backup of your docker-compose file before making changes
109109

110-
## Important Notes
110+
## Important notes
111111

112112
- **Stability**: While these images are tested, they may occasionally contain bugs that haven't been discovered yet. We recommend having a backup strategy.
113113
- **Breaking changes**: We strive to maintain backwards compatibility, but occasionally breaking changes may occur. Always check the [changelog](/docs/self-hosting/changelog) before updating.
114114
- **Support**: As a supporter, you have priority access to support. If you encounter any issues, reach out to us on Discord or via email.
115115

116-
## Need Help?
116+
## Need help?
117117

118118
If you have any questions or run into issues:
119119
- Join our [Discord community](https://go.openpanel.dev/discord) (supporters get a special role!)
@@ -122,7 +122,7 @@ If you have any questions or run into issues:
122122

123123
---
124124

125-
## Your Impact
125+
## Your impact
126126

127127
Every contribution helps us:
128128
- Dedicate more time to development

0 commit comments

Comments
 (0)