diff --git a/apps/docs/content/docs/core/extra/comparison.mdx b/apps/docs/content/docs/core/extra/comparison.mdx index 0036ccbf8..028ea6d08 100644 --- a/apps/docs/content/docs/core/extra/comparison.mdx +++ b/apps/docs/content/docs/core/extra/comparison.mdx @@ -1,22 +1,23 @@ --- -title: 'Comparison' -description: 'A comparison of Dokploy, CapRover, Dokku, and Coolify' +title: "Comparison" +description: "A comparison of Dokploy, CapRover, Dokku, and Coolify" --- Comparison of the following deployment tools: -| Feature | Dokploy | CapRover | Dokku | Coolify | -|-----------------------------------|---------------------------------------|--------------------------------------|--------------------------------------|--------------------------------------| -| **User Interface** | ✅ | ✅ | ❌ | ✅ | -| **Docker compose support** | ✅ | ❌ | ❌ | ✅ | -| **API/CLI** | ✅ | ✅ | ✅ | ✅ | -| **Multi node support** | ✅ | ✅ | ❌ | ✅ | -| **Traefik Integration** | ✅ | ✅ | Available via Plugins | ✅ | -| **User Permission Management** | ✅ | ❌ | ❌ | ✅ | -| **Advanced User Permission Management** | ✅ | ❌ | ❌ | ❌ | -| **Terminal Access Built In** | ✅ | ❌ | ❌ | ✅ | -| **Database Support** | ✅ | ✅ | ❌ | ✅ | -| **Monitoring** | ✅ | ✅ | ❌ | ❌ | -| **Backups** | ✅ | Available via Plugins | Available via Plugins | ✅ | -| **Open Source** | ✅ | ✅ | ✅ | ✅ | -| **Cloud/Paid Version** | ❌ | ✅ | ❌ | ✅ | +| Feature | Dokploy | CapRover | Dokku | Coolify | +| --------------------------------------- | ------- | --------------------- | --------------------- | ------- | +| **User Interface** | ✅ | ✅ | ❌ | ✅ | +| **Docker compose support** | ✅ | ❌ | ❌ | ✅ | +| **API/CLI** | ✅ | ✅ | ✅ | ✅ | +| **Multi node support** | ✅ | ✅ | ❌ | ✅ | +| **Traefik Integration** | ✅ | ✅ | Available via Plugins | ✅ | +| **User Permission Management** | ✅ | ❌ | ❌ | ✅ | +| **Advanced User Permission Management** | ✅ | ❌ | ❌ | ❌ | +| **Terminal Access Built In** | ✅ | ❌ | ❌ | ✅ | +| **Database Support** | ✅ | ✅ | ❌ | ✅ | +| **Monitoring** | ✅ | ✅ | ❌ | ❌ | +| **Backups** | ✅ | Available via Plugins | Available via Plugins | ✅ | +| **Open Source** | ✅ | ✅ | ✅ | ✅ | +| **Multi Server Support** | ✅ | ❌ | ❌ | ✅ | +| **Cloud/Paid Version** | ❌ | ✅ | ✅ | ✅ | diff --git a/apps/docs/content/docs/core/meta.json b/apps/docs/content/docs/core/meta.json index a6a8a3c9e..b2c3020fc 100644 --- a/apps/docs/content/docs/core/meta.json +++ b/apps/docs/content/docs/core/meta.json @@ -64,6 +64,9 @@ "docker/overview", "---Monitoring---", "monitoring/overview", + "---Multi Server---", + "multi-server/overview", + "multi-server/example", "---Cluster---", "cluster/overview", "---Deployments---", diff --git a/apps/docs/content/docs/core/multi-server/example.mdx b/apps/docs/content/docs/core/multi-server/example.mdx new file mode 100644 index 000000000..109722c42 --- /dev/null +++ b/apps/docs/content/docs/core/multi-server/example.mdx @@ -0,0 +1,117 @@ +--- +title: Example +description: "Example to setup a remote server and deploy application in a VPS." +--- + +import { Callout } from "fumadocs-ui/components/callout"; + +Multi server allows you to deploy your apps remotely to different servers without needing to build and run them where the Dokploy UI is installed. + +## Requirements + +1. To install Dokploy UI, follow the [installation guide](en/docs/core/get-started/installation). + +2. Create an SSH key by going to `/dashboard/settings/ssh-keys` and add a new key. Be sure to copy the public key. + + + +3. Decide which remote server to deploy your apps on. We recommend these reliable providers: + +- [Hostinger](https://www.hostinger.com/vps-hosting?ref=dokploy) Get 20% off with this [referral link](https://www.hostinger.com/vps-hosting?REFERRALCODE=1SIUMAURICI97). +- [DigitalOcean](https://www.digitalocean.com/pricing/droplets#basic-droplets) Get $200 credits for free with this [referral link](https://m.do.co/c/db24efd43f35). +- [Hetzner](https://www.hetzner.com/cloud/) Get €20 credits with this [referral link](https://hetzner.cloud/?ref=vou4fhxJ1W2D). +- [Linode](https://www.linode.com/es/pricing/#compute-shared). +- [Vultr](https://www.vultr.com/pricing/#cloud-compute). +- [Scaleway](https://www.scaleway.com/en/pricing/?tags=baremetal,available). +- [Google Cloud](https://cloud.google.com/). +- [AWS](https://aws.amazon.com/ec2/pricing/). + +4. When creating the server, it should ask for SSH keys. Ideally, use your computer's public key and the key you generated in the previous step. Here's how to add the public key in Hostinger: + + + +The steps are similar across other providers. + +5. Copy the server’s IP address and ensure you know the username (often `root`). Fill in all fields and click `Create`. + + + +6. To test connectivity, open the server dropdown and click `Enter Terminal`. If everything is correct, you should be able to interact with the remote server. + +7. Click `Setup Server` to proceed. There are two tabs: SSH Keys and Deployments. This guide explains the easy way, but you can follow the manual process via the Dokploy UI if you prefer. + + + +8. Click `Deployments`, then `Setup Server`. If everything is correct, you should see output similar to this: + + + + + You only need to run this setup once. If Dokploy updates later, check the + release notes to see if rerunning this command is required. + + +9. You're ready to deploy your apps! Let's test it out: + + + +10. To check which server an app belongs to, you’ll see the server name at the top. If no server is selected, it defaults to `Dokploy Server`. Click `Deploy` to start building your app on the remote server. You can check the `Logs` tab to see the build process. For this example, we’ll use a test repo: + Repo: `https://github.com/Dokploy/examples.git` + Branch: `main` + Build Path: `/astro` + + + +11. Once the build is done, go to `Domains` and create a free domain. Just click `Create` and you’re good to go! 🎊 + +{" "} + + diff --git a/apps/docs/content/docs/core/multi-server/overview.mdx b/apps/docs/content/docs/core/multi-server/overview.mdx new file mode 100644 index 000000000..051b314c0 --- /dev/null +++ b/apps/docs/content/docs/core/multi-server/overview.mdx @@ -0,0 +1,29 @@ +--- +title: Overview +description: "Deploy your apps to multiple servers remotely." +--- + +import { Callout } from "fumadocs-ui/components/callout"; + +Multi server allows you to deploy your apps remotely to different servers without needing to build and run them where the Dokploy UI is installed. + +To use the multi-server feature, you need to have Dokploy UI installed either locally or on a remote server. We recommend using a remote server for better connectivity, security, and isolation, for remote instances we install only a traefik instance. + +If you plan to only deploy apps to remote servers and use Dokploy UI for managing deployments, Dokploy will use around 250 MB of RAM and minimal CPU, so a low-resource server should be sufficient. + +All the features we have documented previously are supported by Dokploy Multi Server. The only feature not supported is remote server monitoring, due to performance reasons. However, all functionalities should work the same as when deploying on the same server where Dokploy UI is installed. + +## Features + +1. **Enter the terminal**: Allows you to access the terminal of the remote server. +2. **Setup Server**: Allows you to configure the remote server. + - **SSH Keys**: Steps to add SSH keys to the remote server. + - **Deployments**: Steps to configure the remote server for deploying applications. +3. **Edit Server**: Allows you to modify the remote server's details, such as SSH key, name, description, IP, etc. +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. + + + Remote server monitoring is not supported due to performance reasons. + diff --git a/apps/docs/content/docs/core/troubleshooting/overview.mdx b/apps/docs/content/docs/core/troubleshooting/overview.mdx index d44d3d668..66a9fe80f 100644 --- a/apps/docs/content/docs/core/troubleshooting/overview.mdx +++ b/apps/docs/content/docs/core/troubleshooting/overview.mdx @@ -3,4 +3,90 @@ title: Overview description: Solve the most common problems that occur when using Dokploy. --- -WIP \ No newline at end of file +## Applications Domain Not Working? + +You see the deployment succeeded, and logs are running, but the domain isn't working? Here's what to check: + +1. **Correct Port Mapping**: Ensure the domain is using the correct port for your application. For example, if you're using Next.js, the port should be `3000`, or for Laravel, it should be `8000`. If you change the app port, update the domain to reflect that. +2. **Avoid Using `Ports` in Advanced Settings**: Generally, there's no need to use the `Ports` feature unless you want to access your app via `IP:port`. Leaving this feature enabled may interfere with your domain. + +3. **Let's Encrypt Certificates**: It's crucial to point the domain to your server’s IP **before** adding it in Dokploy. If the domain is added first, the certificate won’t be generated, and you may need to recreate the domain or restart Traefik. + +4. **Listen on 0.0.0.0, Not 127.0.0.1**: If your app is bound to `127.0.0.1` (which is common in Vite apps), switch it to `0.0.0.0` to allow external access. + +## Logs and Monitoring Not Working After Changing Application Placement? + +This is expected behavior. If the application is running on a different node (worker), the UI won’t have access to logs or monitoring, as they're not on the same node. + +## Mounts Are Causing My Application Not to Run? + +Docker Swarm won't run your application if there are invalid mounts, even if the deployment shows as successful. Double-check your mounts to ensure they are valid. + +## Volumes in Docker Compose Not Working? + +For Docker Compose, all file mounts defined in the `volumes` section will be stored in the `files` folder. This is the default directory structure: + +## I added a volume to my docker compose, but is not finding the volume? + +For docker compose all the file mounts you've created in the volumes section will be stored to files folder, this is the default structure of the docker compose. + +``` +/application-name + /code + /files +``` + +So instead of using this invalid way to mount a volume: + +```yaml +volumes: + - "/folder:/path/in/container" ❌ +``` + +You should use this format: + +```yaml +volumes: + - "../files/my-database:/var/lib/mysql" ✅ + - "../files/my-configs:/etc/my-app/config" ✅ +``` + +## Logs Not Loading When Deploying to a Remote Server? + +There are a few potential reasons for this: + +1. **Slow Server:**: If the server is too slow, it may struggle to handle concurrent requests, leading to SSL handshake errors. +2. **Insufficient Disk Space:** If the server doesn't have enough disk space, the logs may not load. + +## Docker Compose Domain Not Working? + +When adding a domain in your Docker Compose file, it’s not necessary to expose the ports directly. Simply specify the port where your app is running. Exposing the ports can lead to conflicts with other applications or ports. + +Example of what not to do: + +```yaml +services: + app: + image: dokploy/dokploy:latest + ports: + - 3000:3000 +``` + +Recommended approach: + +```yaml +services: + app: + image: dokploy/dokploy:latest + ports: + - 3000 + - 80 +``` + +Then, when creating the domain in Dokploy, specify the service name and port, like this: + +```yaml +domain: my-app.com +serviceName: app +port: 3000 +``` diff --git a/apps/docs/public/assets/hostinger-add-sshkey.png b/apps/docs/public/assets/hostinger-add-sshkey.png new file mode 100644 index 000000000..dfbb9a77e Binary files /dev/null and b/apps/docs/public/assets/hostinger-add-sshkey.png differ diff --git a/apps/docs/public/assets/multi-server-add-app.png b/apps/docs/public/assets/multi-server-add-app.png new file mode 100644 index 000000000..d6f83882b Binary files /dev/null and b/apps/docs/public/assets/multi-server-add-app.png differ diff --git a/apps/docs/public/assets/multi-server-add-server.png b/apps/docs/public/assets/multi-server-add-server.png new file mode 100644 index 000000000..48e346013 Binary files /dev/null and b/apps/docs/public/assets/multi-server-add-server.png differ diff --git a/apps/docs/public/assets/multi-server-finish.png b/apps/docs/public/assets/multi-server-finish.png new file mode 100644 index 000000000..3f0430106 Binary files /dev/null and b/apps/docs/public/assets/multi-server-finish.png differ diff --git a/apps/docs/public/assets/multi-server-overview.png b/apps/docs/public/assets/multi-server-overview.png new file mode 100644 index 000000000..e1d9c5e61 Binary files /dev/null and b/apps/docs/public/assets/multi-server-overview.png differ diff --git a/apps/docs/public/assets/multi-server-setup-2.png b/apps/docs/public/assets/multi-server-setup-2.png new file mode 100644 index 000000000..2f7f907eb Binary files /dev/null and b/apps/docs/public/assets/multi-server-setup-2.png differ diff --git a/apps/docs/public/assets/multi-server-setup-3.png b/apps/docs/public/assets/multi-server-setup-3.png new file mode 100644 index 000000000..66f9cc1e9 Binary files /dev/null and b/apps/docs/public/assets/multi-server-setup-3.png differ diff --git a/apps/docs/public/assets/multi-server-setup-app.png b/apps/docs/public/assets/multi-server-setup-app.png new file mode 100644 index 000000000..88393cb34 Binary files /dev/null and b/apps/docs/public/assets/multi-server-setup-app.png differ diff --git a/apps/docs/public/assets/multi-server-setup.png b/apps/docs/public/assets/multi-server-setup.png new file mode 100644 index 000000000..c5bca6bf0 Binary files /dev/null and b/apps/docs/public/assets/multi-server-setup.png differ diff --git a/apps/docs/public/assets/ssh-keys.png b/apps/docs/public/assets/ssh-keys.png new file mode 100644 index 000000000..52ee5c5e0 Binary files /dev/null and b/apps/docs/public/assets/ssh-keys.png differ