|
| 1 | +--- |
| 2 | +title: Installing with Dokploy |
| 3 | +description: A comprehensive guide for setting up Pyrodactyl using Dokploy |
| 4 | +--- |
| 5 | + |
| 6 | +This guide walks you through setting up Pyrodactyl using Dokploy, from initial deployment to a fully functional system. |
| 7 | + |
| 8 | +<Callout type="note"> |
| 9 | + For migrating existing installations, please see our [migration guide](migrations). |
| 10 | +</Callout> |
| 11 | + |
| 12 | +<Callout type="info"> |
| 13 | + Need help? Join our [Pyrodactyl Discord](https://discord.gg/FGWKZT5dxv) or open a discussion on [GitHub](https://github.com/pyrohost/pyrodactyl/discussions). |
| 14 | +</Callout> |
| 15 | + |
| 16 | +<Callout type="warning"> |
| 17 | + Dokploy installations require a properly configured Dokploy instance with access to a server or provider. |
| 18 | +</Callout> |
| 19 | + |
| 20 | +# Fresh Installation with Dokploy |
| 21 | + |
| 22 | +### Prerequisites |
| 23 | + |
| 24 | +- A running [Dokploy](https://dokploy.com/) instance |
| 25 | +- Access to a server/provider through Dokploy |
| 26 | +- Domain name (recommended) or server IP address |
| 27 | +- Basic understanding of Dokploys application deployment process |
| 28 | + |
| 29 | +## Panel Installation |
| 30 | + |
| 31 | +1. **Create a new project** in your Dokploy dashboard |
| 32 | + - Login to whatever host your using. |
| 33 | + - Select **Create Project** name it whatever you want |
| 34 | + - Click on that Project |
| 35 | + |
| 36 | +2. **Create Service**: |
| 37 | + - Click the **Create Service** button in the top right |
| 38 | + - Select Template |
| 39 | + - Search For ***Pyrodactyl*** |
| 40 | + - Select Create |
| 41 | + - Choose what server to install it to |
| 42 | + - Select Confirm |
| 43 | + |
| 44 | +3. **Configuring Pyrodactyl** |
| 45 | + - The only thing you as a user need to change is the domain. |
| 46 | + - 1. Select the domains tab under the pyrodactyl panel service |
| 47 | + - 2. Click the edit domain button |
| 48 | + - 3. Change host to whatever you want it to be(You must have the domain configured at this point) |
| 49 | + - 4. Click update |
| 50 | + |
| 51 | +4. **Deploy the application**: |
| 52 | + - Click "Deploy" to start the build process |
| 53 | + - Check the url you configured panel to be at, and it should be there. |
| 54 | + |
| 55 | +5. **Initial setup**: |
| 56 | + - Once deployed, access the container's terminal via Dokploy |
| 57 | + - Run the admin user creation command: |
| 58 | + ```bash |
| 59 | + php artisan p:user:make |
| 60 | + ``` |
| 61 | + - Follow prompts to create your first admin account |
| 62 | + |
| 63 | + |
| 64 | + |
| 65 | +## Post-Installation Configuration |
| 66 | + |
| 67 | +1. **Panel setup**: |
| 68 | + - Access your panel at the configured domain/IP |
| 69 | + - Login with your admin account |
| 70 | + - Navigate to Admin → Locations and create a new location |
| 71 | + - Navigate to Nodes and add your Wings instance |
| 72 | + |
| 73 | +2. **Email configuration** (Admin → Settings): |
| 74 | + - Configure SMTP settings for user notifications |
| 75 | + - Recommended providers: |
| 76 | + - Resend |
| 77 | + - Mailgun |
| 78 | + - AWS SES |
| 79 | + |
| 80 | +3. **SSL configuration** (recommended): |
| 81 | + - Use Dokploys's built-in Let's Encrypt integration |
| 82 | + - Or configure Cloudflare proxy for DDoS protection |
| 83 | + |
| 84 | +## Maintenance |
| 85 | + |
| 86 | +1. **Updating Pyrodactyl**: |
| 87 | + - In Dokploy, trigger a rebuild of your panel application |
| 88 | + |
| 89 | +## Troubleshooting |
| 90 | + |
| 91 | +Common issues and solutions: |
| 92 | + |
| 93 | + |
| 94 | +- **Build failures**: |
| 95 | + - Check resource limits in Dokploy |
| 96 | + - Review build logs for specific errors |
| 97 | + |
| 98 | +## Additional Resources |
| 99 | + |
| 100 | +- [Dokploy Documentation](https://docs.dokploy.com/docs/core) |
| 101 | +- [Pyrodactyl GitHub](https://github.com/pyrohost/pyrodactyl) |
| 102 | +- [Pterodactyl Wings Setup](https://pterodactyl.io/wings/1.0/installing.html) |
0 commit comments