Dokploy Setup: A Beginner's Guide To Exploration

Hey guys! Ready to dive into Dokploy? This guide will walk you through setting up your development environment, exploring the platform, and creating your first project. By the end, you'll be well on your way to understanding Dokploy's capabilities. Let's get started!

Pre-requisites

Before we begin, make sure you have the following installed:

• [ ] Node.js 20.16.0: Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine. We need this version to ensure compatibility with Dokploy.
• [ ] pnpm >= 9.5.0: pnpm is a fast, disk space efficient package manager for Node.js. It's similar to npm or yarn, but it's more efficient. Make sure you have at least version 9.5.0.
• [ ] Docker Desktop: Docker is a platform for developing, shipping, and running applications in containers. Docker Desktop is the easiest way to run Docker on your local machine.

Objective

The main goal here is to get you comfortable with Dokploy. We want you to explore its features and understand the developer environment. This initial exploration is crucial for smoother contributions later on. By the end of this guide, you should have a good grasp of what Dokploy is all about.

Steps to Complete

1. Explore Dokploy Documentation

Alright, first things first, let's get acquainted with Dokploy through its official documentation and intro videos. Understanding the platform is key. Think of this as your orientation before the real work begins. This documentation contains valuable information that will make your journey easier. So, grab a coffee, sit back, and let's dive in!

Start by heading over to the Dokploy website at https://dokploy.com/. Take a look around, check out the features, and get a general feel for the platform. Next, watch the intro videos available at https://docs.dokploy.com/docs/core/videos. These videos provide a great overview of Dokploy and its capabilities. Finally, dive into the official documentation at https://docs.dokploy.com/docs/core. Here, you'll find detailed information about every aspect of Dokploy.

Note: You don't need to follow along or execute anything in the videos; just watching them will help you better understand Dokploy. The goal here is to absorb as much information as possible, setting the stage for hands-on work.

2. Setup Development Environment

Time to set up your local development environment. This involves cloning the Dokploy repository, installing dependencies, and configuring environment variables. Follow these steps carefully to ensure a smooth setup. Let's get your hands dirty with some code!

Open your terminal and run the following commands:

git clone https://github.com/dokploy/dokploy.git
cd dokploy
pnpm install
cp apps/dokploy/.env.example apps/dokploy/.env

• git clone https://github.com/dokploy/dokploy.git: This command clones the Dokploy repository from GitHub to your local machine. Make sure you have Git installed.
• cd dokploy: This command changes your current directory to the Dokploy repository you just cloned.
• pnpm install: This command installs all the necessary dependencies for Dokploy. This might take a few minutes, so be patient.
• cp apps/dokploy/.env.example apps/dokploy/.env: This command copies the example environment file to a new file named .env. This file will contain important configuration settings.

3. Install Docker Desktop

Docker Desktop is essential for running Dokploy locally. While you can install Docker directly in shell environments, Docker Desktop provides a user-friendly interface and simplifies the process, especially for development purposes. If you haven't already, download and install Docker Desktop from the official website.

Docker helps in containerizing applications, making them portable and consistent across different environments. This ensures that Dokploy runs the same way on your machine as it does on a server. Docker Desktop comes with all the necessary tools and configurations, making it the preferred choice for development.

4. Install and Run Dokploy

Now that you've set up your environment and installed Docker, it's time to install and run Dokploy. These commands will set up the necessary services and start the Dokploy development server. Get ready to see Dokploy in action!

Execute these commands in your terminal:

pnpm run dokploy:setup
pnpm run server:script
pnpm run dokploy:dev

• pnpm run dokploy:setup: This command sets up the Dokploy environment, including creating necessary databases and configuring services.
• pnpm run server:script: This command runs the server-side scripts required for Dokploy to function properly.
• pnpm run dokploy:dev: This command starts the Dokploy development server. This will allow you to access Dokploy in your browser.

Note: These steps are from the [Contributing Guide](link-to-contributing-guide). If you encounter errors, check for outdated information or steps. Always refer to the latest documentation for the most accurate instructions.

5. Access Dokploy UI and Create User

With Dokploy running, it's time to access the UI in your browser and create your user account. This is where you'll start interacting with Dokploy directly. Let's get you logged in and ready to explore!

• Navigate to http://127.0.0.1:3000 in your browser.
• Register with the following credentials:
  • Username: admin
  • Email: [your email address]
  • Password: admin123

Note: If you previously set up a PostgreSQL database on your Dokploy instance, you may need to delete it first. This ensures a clean slate for your new user account.

6. Explore the UI

Take some time to navigate through the website and familiarize yourself with all available features. Click around, explore different sections, and get a feel for the layout. Understanding the UI now will make contributing easier later. Treat this as your virtual tour of Dokploy!

7. Create Your First Project

Now, let's create your first project in Dokploy. This will give you a hands-on experience with project management within the platform. Follow these steps to create a new project:

In the Projects section, create a new project with:

• Name: [YOUR-NAME]-hello-world (e.g., John-Doe-hello-world)
• Description: Share your current understanding of Dokploy and one thing you are most curious to learn about.

Submission Requirements

To demonstrate that you've successfully completed the setup and exploration, please upload a screen recording showing the following:

• [ ] User creation process
• [ ] Project creation process
• [ ] Filling out project name and description
• [ ] Successfully creating the project

Tips

• Take time exploring the platform — understanding the UI now will make contributing easier later.
• Don't hesitate to ask questions if you get stuck. The community is here to help!
• Document any issues you encounter for future improvements. Your feedback is valuable.

Acceptance Criteria

To pass this initial setup, ensure you've met the following criteria:

• [ ] Successfully set up development environment
• [ ] Created user account in local Dokploy instance
• [ ] Created first project with proper naming convention
• [ ] Submitted screen recording showing all required steps
• [ ] Explored and understood basic Dokploy features

---

Download https://cap.so/ to record your screen (use Studio mode). Export as an mp4, and drag and drop into an issue comment below.

By completing these steps, you'll not only set up Dokploy on your local machine but also gain a foundational understanding of its features and functionalities. This knowledge will prove invaluable as you delve deeper into contributing to the project. So, go ahead, take the plunge, and start exploring the world of Dokploy! Happy coding, and remember, we're here to support you every step of the way. External link to Docker documentation can be found here