UniqueSoft/openpanel
2
0
Fork 0
mirror of https://github.com/stefanpejcic/openpanel synced 2025-06-26 18:28:26 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Update 000_intro.md

Browse Source
This commit is contained in:
Stefan Pejcic 2024-11-22 13:37:30 +01:00 committed by GitHub
parent 7be6347778
commit c096981cbc
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 38 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
website/docs/admin/000_intro.md
View File

@ -32,10 +32,12 @@ If you are using external firewall, the following ports should be opened: `53`
## Installation ## Installation
OpenPanel can be installed on both VPS and bare-metal servers.
### Install OpenPanel on VPS
The installation process takes about 5 minutes. To install openpanel follow these steps: The installation process takes about 5 minutes. To install openpanel follow these steps:
<Tabs> <Tabs>
<TabItem value="openpanel-install-on-dedicated" label="Install script" default> <TabItem value="openpanel-install-on-dedicated" label="Install script" default>
@ -52,7 +54,7 @@ The installation script supports [optional flags](/install) that can be used to
If you encountered any errors while running the installation script, please copy & paste the installation log file to [the community forums](https://community.openpanel.org). If you encountered any errors while running the installation script, please copy & paste the installation log file to [the community forums](https://community.openpanel.org).
</TabItem> </TabItem>
<TabItem value="openpanel-install-on-digitalocean" label="DigitalOcean"> <TabItem value="openpanel-install-on-digitalocean" label="DigitalOcean Droplet">
OpenPanel is available as a 1-Click app (droplet) on DigitalOcean. Click on the button to spin a droplet with OpenPanel already installed: OpenPanel is available as a 1-Click app (droplet) on DigitalOcean. Click on the button to spin a droplet with OpenPanel already installed:
@ -70,6 +72,39 @@ curl -X POST -H 'Content-Type: application/json' \
</TabItem> </TabItem>
</Tabs> </Tabs>
### Installing OpenPanel on a bare-metal server
When installing OpenPanel on a bare-metal server, it is recommended to format the disk with the XFS filesystem and enable the 'pquota' mount option. This is required for Docker's OverlayFS storage driver to function properly, as it allows setting user quotas and limiting container sizes on newer kernels. More details on these requirements can be found in the [Docker OverlayFS documentation](https://docs.docker.com/engine/storage/drivers/overlayfs-driver/#prerequisites).
If your disk is not formatted with XFS, the OpenPanel installation script will automatically allocate 50% of the available storage. It will then create an XFS storage file and mount it at `/var/lib/docker/`. This process may take a considerable amount of time on servers with large storage capacities (e.g., several terabytes). In such cases, we recommend manually setting the filesystem to XFS or adjusting the storage file size. Alternatively, you can specify a custom size during installation by using the `--docker-space` flag. For instance, to allocate only 100GB for Docker, you can use: `--docker-space=100`.
To install OpenPanel on a bare-metal server:
<Tabs>
<TabItem value="openpanel-install-on-baremetal" label="Allocate 50% of disk to Docker" default>
```shell
bash <(curl -sSL https://openpanel.org)
```
</TabItem>
<TabItem value="openpanel-install-on-baremetal-size" label="Set disk size for Docker (faster install)">
*replace `250` with the disk size in GB to allocate to Docker.
```shell
bash <(curl -sSL https://openpanel.org) --docker-space=250
```
</TabItem>
</Tabs>
The installation script supports [additional flags](/install) that can be used to configure openpanel, skip certain installation steps or simply display debugging information.
If you encountered any errors while running the installation script, please copy & paste the installation log file to [the community forums](https://community.openpanel.org).
## Post Install Steps ## Post Install Steps