You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: apps/public/content/docs/self-hosting/self-hosting.mdx
+45Lines changed: 45 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -112,6 +112,51 @@ Features that require e-mail:
112
112
- Invitations
113
113
- more will be added over time
114
114
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
+
<Callouttype="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
+
<Callouttype="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
+
115
160
### Managed Redis
116
161
117
162
If you use a managed Redis service, you may need to set the `notify-keyspace-events` manually.
description: Get access to OpenPanel's latest private Docker images with bleeding-edge features built on every commit.
4
4
---
5
5
6
-
## Thank You for Your Support! 🙏
6
+
## Thank you for your support! 🙏
7
7
8
8
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.
9
9
10
10
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.
11
11
12
-
## Why Latest Images Matter
12
+
## Why latest images matter
13
13
14
-
### Bleeding-Edge Features
14
+
### Bleeding-edge features
15
15
-**Instant access**: Get new features the moment they're merged
16
16
-**Early bug fixes**: Patches and fixes deployed immediately
17
17
-**Continuous improvements**: Performance enhancements and optimizations in real-time
18
18
-**Stay ahead**: Run the most advanced version of OpenPanel available
19
19
20
-
### Built on Every Commit
20
+
### Built on every commit
21
21
We maintain a continuous integration pipeline that builds new Docker images with every single commit to our repository. This means:
22
22
- Zero delay between development and deployment
23
23
- Production-ready images tested and validated automatically
24
24
- Access to features weeks or months before stable releases
25
25
26
-
## How It Works
26
+
## How it works
27
27
28
28
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.
29
29
30
-
## Getting Started
30
+
## Getting started
31
31
32
-
### Step 1: Become a Supporter
32
+
### Step 1: Become a supporter
33
33
34
34
Support starts at just **$20/month** and includes:
35
35
- Access to all private Docker images
36
36
- Priority support in our Discord community
37
37
- Direct impact on OpenPanel's development
38
38
- Our eternal gratitude ❤️
39
39
40
-
### Step 2: Get Your API Key
40
+
### Step 2: Get your API key
41
41
42
42
Once you become a supporter, you'll receive a unique API key that grants access to our Docker proxy.
43
43
44
-
### Step 3: Login to Docker Registry
44
+
### Step 3: Login to docker registry
45
45
46
46
On your server, authenticate with our Docker proxy using your API key:
47
47
@@ -55,7 +55,7 @@ Replace `your_api_key` with the actual API key provided to you.
55
55
Make sure to keep your API key secure and never commit it to version control!
56
56
</Callout>
57
57
58
-
### Step 4: Update to Latest Images
58
+
### Step 4: Update to latest images
59
59
60
60
We've created a convenient script to make updating your images effortless. Navigate to your self-hosting folder and run:
61
61
@@ -79,7 +79,7 @@ You can also check what tags are available without applying them:
79
79
./get_latest_images --list # List all available tags
80
80
```
81
81
82
-
### Step 5: Restart Your Services
82
+
### Step 5: Restart your services
83
83
84
84
After pulling the latest images, simply restart your services:
85
85
@@ -89,7 +89,7 @@ After pulling the latest images, simply restart your services:
89
89
90
90
That's it! Your OpenPanel instance is now running the latest and greatest version.
91
91
92
-
## Quick Update Workflow
92
+
## Quick update workflow
93
93
94
94
Once you're set up, updating to the latest version is as simple as:
95
95
@@ -107,13 +107,13 @@ The `get_latest_images` script will:
107
107
3. Update your `docker-compose.yml` with images pointing to the latest commit SHAs
108
108
4. Create a backup of your docker-compose file before making changes
109
109
110
-
## Important Notes
110
+
## Important notes
111
111
112
112
-**Stability**: While these images are tested, they may occasionally contain bugs that haven't been discovered yet. We recommend having a backup strategy.
113
113
-**Breaking changes**: We strive to maintain backwards compatibility, but occasionally breaking changes may occur. Always check the [changelog](/docs/self-hosting/changelog) before updating.
114
114
-**Support**: As a supporter, you have priority access to support. If you encounter any issues, reach out to us on Discord or via email.
115
115
116
-
## Need Help?
116
+
## Need help?
117
117
118
118
If you have any questions or run into issues:
119
119
- 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:
0 commit comments