mirror of
https://github.com/Dokploy/website
synced 2025-06-26 18:16:01 +00:00
docs: add multi-server documentation for deployments, security, and validation
This commit is contained in:
38
apps/docs/content/docs/core/multi-server/deployments.mdx
Normal file
38
apps/docs/content/docs/core/multi-server/deployments.mdx
Normal file
@@ -0,0 +1,38 @@
|
||||
---
|
||||
title: Deployments
|
||||
description: "Configure and set up your remote server deployment"
|
||||
---
|
||||
|
||||
import { ImageZoom } from "fumadocs-ui/components/image-zoom";
|
||||
import { Callout } from "fumadocs-ui/components/callout";
|
||||
|
||||
To get started with multi-server, you'll need to configure the initial setup for your remote server.
|
||||
|
||||
## Server Setup
|
||||
|
||||
The server setup process prepares the necessary environment for securely and efficiently deploying applications.
|
||||
|
||||
<Callout title="Important" type="info">
|
||||
Root access to the server is required. We currently do not support non-root deployments.
|
||||
</Callout>
|
||||
|
||||
<ImageZoom
|
||||
src="/assets/images/server-deploy.png"
|
||||
alt="Multi-Server Setup"
|
||||
width={1000}
|
||||
height={600}
|
||||
/>
|
||||
|
||||
We provide two main actions to configure your server:
|
||||
|
||||
- **Modify Script**: Allows you to view and customize the installation script that will be executed on your server. You can adjust it according to your specific needs.
|
||||
- **Setup Server**: Initiates the configuration process on the remote server. When clicked, it will open a modal window showing real-time logs of the script execution.
|
||||
|
||||
Example of the server setup logs:
|
||||
|
||||
<ImageZoom
|
||||
src="/assets/images/server-drawer.png"
|
||||
alt="Multi-Server Setup"
|
||||
width={1000}
|
||||
height={600}
|
||||
/>
|
||||
@@ -23,7 +23,4 @@ All the features we have documented previously are supported by Dokploy Multi Se
|
||||
4. **View Actions**: Lets you perform actions like managing the Traefik instance, storage, and activating Docker cleanup.
|
||||
5. **Show Traefik File System**: Displays the contents of the remote server's directory.
|
||||
6. **Show Docker Containers**: Shows the Docker containers running on the remote server.
|
||||
|
||||
<Callout>
|
||||
Remote server monitoring is not supported due to performance reasons.
|
||||
</Callout>
|
||||
7. **Show Docker Swarm Overview**: Shows the Docker Swarm overview of the remote server.
|
||||
|
||||
56
apps/docs/content/docs/core/multi-server/security.mdx
Normal file
56
apps/docs/content/docs/core/multi-server/security.mdx
Normal file
@@ -0,0 +1,56 @@
|
||||
---
|
||||
title: Security
|
||||
description: "Security features of Dokploy"
|
||||
---
|
||||
|
||||
Dokploy provides comprehensive security recommendations to protect your remote server. Our security checks ensure your server follows best practices for a secure deployment environment.
|
||||
|
||||
## Security Recommendations
|
||||
|
||||
### Operating System
|
||||
- Currently supports Ubuntu/Debian OS (Experimental)
|
||||
- Regular system updates recommended
|
||||
|
||||
### UFW (Uncomplicated Firewall)
|
||||
UFW is an essential security component that manages incoming and outgoing network traffic.
|
||||
|
||||
**Recommended Configuration:**
|
||||
- ✅ UFW should be installed
|
||||
- ✅ UFW should be active
|
||||
- ✅ Default incoming policy should be set to 'deny'
|
||||
- ✅ Only necessary ports should be opened
|
||||
|
||||
### SSH Security
|
||||
Secure Shell (SSH) configuration is crucial for safe remote server access.
|
||||
|
||||
**Best Practices:**
|
||||
- ✅ SSH service should be enabled
|
||||
- ✅ Key-based authentication should be enabled
|
||||
- ❌ Password authentication should be disabled
|
||||
- ❌ PAM should be disabled when using key-based authentication
|
||||
- ✅ Use non-standard SSH port (optional)
|
||||
|
||||
### Fail2Ban Protection
|
||||
Fail2Ban helps prevent brute force attacks by temporarily banning IPs that show malicious behavior.
|
||||
|
||||
**Recommended Setup:**
|
||||
- ✅ Fail2Ban should be installed
|
||||
- ✅ Service should be enabled and running
|
||||
- ✅ SSH protection should be enabled
|
||||
- ✅ Use aggressive mode for enhanced security
|
||||
|
||||
## Security Status Check
|
||||
|
||||
Dokploy automatically validates these security configurations and provides recommendations:
|
||||
|
||||
<ImageZoom
|
||||
src="/assets/images/server-security.png"
|
||||
alt="Security"
|
||||
width={1000}
|
||||
height={600}
|
||||
/>
|
||||
|
||||
|
||||
## Warning
|
||||
|
||||
These security measures are essential baseline recommendations. Depending on your specific use case, additional security measures might be necessary.
|
||||
22
apps/docs/content/docs/core/multi-server/validate.mdx
Normal file
22
apps/docs/content/docs/core/multi-server/validate.mdx
Normal file
@@ -0,0 +1,22 @@
|
||||
---
|
||||
title: Validate
|
||||
description: "Validate your remote server deployment"
|
||||
---
|
||||
|
||||
Dokploy requires the following 7 components to be properly configured for the multi-server feature:
|
||||
|
||||
1. **Docker Installed**: Docker must be installed on the remote server.
|
||||
2. **RClone Installed**: RClone must be installed on the remote server.
|
||||
3. **Nixpacks Installed**: Nixpacks must be installed on the remote server.
|
||||
4. **Buildpacks Installed**: Buildpacks must be installed on the remote server.
|
||||
5. **Docker Swarm Initialized**: Docker Swarm must be initialized on the remote server.
|
||||
6. **Dokploy Network Created**: A Docker network for Dokploy must be created on the remote server.
|
||||
7. **Main Directory Created**: A directory must be created on the remote server to store applications.
|
||||
|
||||
Once all requirements are met, you will see a green checkmark next to each item in the validation section.
|
||||
|
||||
<ImageZoom
|
||||
src="/assets/images/server-validate.png"
|
||||
alt="Multi-Server Setup"
|
||||
width={1000}
|
||||
height={600} />
|
||||
BIN
apps/docs/public/assets/images/server-deploy.png
Normal file
BIN
apps/docs/public/assets/images/server-deploy.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 77 KiB |
BIN
apps/docs/public/assets/images/server-drawer.png
Normal file
BIN
apps/docs/public/assets/images/server-drawer.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 191 KiB |
BIN
apps/docs/public/assets/images/server-security.png
Normal file
BIN
apps/docs/public/assets/images/server-security.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 152 KiB |
BIN
apps/docs/public/assets/images/server-validate.png
Normal file
BIN
apps/docs/public/assets/images/server-validate.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 122 KiB |
Reference in New Issue
Block a user