Skip to content

Commit d208d98

Browse files
author
Mauricio Siu
committed
docs: update installation documentation to include port requirements
- Added a new section detailing the required ports (80, 443, and 3000) for Dokploy installation. - Included a warning about the necessity of ensuring these ports are free before installation to prevent errors.
1 parent 1ba0c62 commit d208d98

File tree

2 files changed

+20
-1
lines changed

2 files changed

+20
-1
lines changed

apps/docs/content/docs/core/installation.mdx

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,18 @@ import { Callout } from "fumadocs-ui/components/callout";
5151
Hetzner as the best value-for-money VPS provider.
5252
</Callout>
5353

54+
### Port Requirements
55+
56+
Before installing Dokploy, ensure the following ports are available on your server:
57+
58+
- **Port 80**: HTTP traffic (used by Traefik)
59+
- **Port 443**: HTTPS traffic (used by Traefik)
60+
- **Port 3000**: Dokploy web interface
61+
62+
<Callout type='warn'>
63+
**Important:** The installation will fail if any of these ports are already in use. Make sure to stop any services using these ports before running the installation script.
64+
</Callout>
65+
5466
### Docker
5567

5668
Dokploy utilizes Docker, so it is essential to have Docker installed on your server. If Docker is not already installed, Dokploy's installation script will install it automatically. Use the following command to install Dokploy:

apps/docs/content/docs/core/manual-installation.mdx

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ If you wish to customize the Dokploy installation on your server, you can modify
1515

1616
## Installation Script
1717

18-
Here is a Bash script for installing Dokploy on a Linux server. Make sure you run this as root on a Linux environment that is not a container, and ensure ports 80 and 443 are free.
18+
Here is a Bash script for installing Dokploy on a Linux server. Make sure you run this as root on a Linux environment that is not a container, and ensure ports 80, 443, and 3000 are free.
1919

2020

2121
```bash
@@ -50,6 +50,13 @@ install_dokploy() {
5050
exit 1
5151
fi
5252

53+
# check if something is running on port 3000
54+
if ss -tulnp | grep ':3000 ' >/dev/null; then
55+
echo "Error: something is already running on port 3000" >&2
56+
echo "Dokploy requires port 3000 to be available. Please stop any service using this port." >&2
57+
exit 1
58+
fi
59+
5360
command_exists() {
5461
command -v "$@" > /dev/null 2>&1
5562
}

0 commit comments

Comments
 (0)