zias/stats
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

improve self-hosting docs

Browse Source
This commit is contained in:
Carl-Gerhard Lindesvärd
2024-09-02 11:37:54 +02:00
parent 38e60fab1c
commit 561f804909
1 changed files with 9 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
apps/docs/src/pages/docs/self-hosting/index.mdx
View File

@@ -11,6 +11,7 @@ This is a simple guide how to get started with OpenPanel on your own VPS.
### Prerequisites ### Prerequisites
- VPS of any kind (only tested on Ubuntu 24.04) - VPS of any kind (only tested on Ubuntu 24.04)
- 🙋‍♂️ This should work on any system if you have pre-installed docker, node and pnpm
- [Clerk.com](https://clerk.com) account (they have a free tier) - [Clerk.com](https://clerk.com) account (they have a free tier)
### Quickstart ### Quickstart
@@ -39,13 +40,20 @@ The setup script will do 3 things
3. Execute a node script that will ask some questions about your setup 3. Execute a node script that will ask some questions about your setup
4. After this is done you'll need to point a webhook inside Clerk (https://your-domain.com/api/webhook/clerk) 4. After this is done you'll need to point a webhook inside Clerk (https://your-domain.com/api/webhook/clerk)
> Setup takes 5-10 minutes depending on your VPS. It'll build all the docker images. > Setup takes 1-2 minutes depending on your VPS
```bash ```bash
cd openpanel/self-hosting cd openpanel/self-hosting
./setup ./setup
``` ```
⚠️ If the `./setup` script fails to run, you can do it manually.
1. Install docker
2. Install node
3. Install pnpm
4. Run the `npx jiti ./quiz.ts` script inside the self-hosting folder
### Start 🚀 ### Start 🚀
Run the `./start` script located inside the self-hosting folder Run the `./start` script located inside the self-hosting folder