dFlow-logo
getting-started

Getting Started with dFlow: Complete Onboarding & Setup Guide

Avatar
Charan
16 Apr, 2025
onboarding

If you're looking to simplify project deployments and service management, dFlow is your go-to tool. In this guide, we’ll walk you through how to deploy dFlow using Railway and complete its intuitive onboarding process to get started.

Step 1: Deploy dFlow with Railway

To begin working with dFlow, you’ll first need to deploy the application. We use Railway for a smooth and simple deployment experience.

When you deploy dFlow on Railway, it automatically spins up three essential services:

  • MongoDB – For storing your application and project data
  • Redis – For caching and background tasks
  • dFlow – The core app interface and backend

You can use the one-click deploy button from the official dFlow GitHub repo or configure it manually by linking your Railway account.

Step 2: Start the Onboarding Process

Once dFlow is live, visit your deployed URL. If it’s your first time, you’ll be taken through an onboarding flow designed to set up everything you need to start deploying projects.

1. Add SSH Key

dFlow connects with your servers via SSH.

  • If you already have an SSH key, you can paste it directly.
  • Don’t have one? No worries — click "Generate SSH Key" and dFlow will generate a fresh SSH key pair.
  • Save or copy the generated key; you'll use it when configuring your server.

2. Add Your Server

Next, you’ll need to add a server that dFlow can use to deploy applications.

  • Provide your server IP, username, and optionally a name.
  • dFlow uses your SSH credentials to connect and manage deployments.

3. Install Dokku

dFlow relies on Dokku, a mini-PaaS that runs on your server.

  • If Dokku is already installed, dFlow will detect it and move on.
  • If not, you'll get an option to install Dokku directly from the dashboard with a click.
  • This step sets up all the required tools for deploying your apps easily.

4. Install GitHub App

To enable repository access and deployment automation, you’ll need to install the GitHub App.

  • Select the repositories you want dFlow to access.
  • This enables you to deploy services directly from your GitHub repos.

5. Configure Your Domain

Finally, you’ll configure a custom domain for your deployment environment.

  • You can add a custom domain or use a default one provided by Dokku.
  • DNS setup instructions will be provided if needed.

You’re All Set!

Once the onboarding is complete, you’re ready to:

  • Create and deploy projects
  • Add services like databases, background workers, etc.
  • View deployment logs
  • Manage multiple servers and domains from a single dashboard

Final Thoughts

dFlow removes the complexity from full-stack deployments and server management. With its smooth onboarding and integration with tools like Dokku and GitHub, getting started is faster than ever.

Stay tuned for more guides, including how to deploy a Node.js or Next.js app using dFlow.

Getting Started with dFlow: Complete Onboarding & Setup Guide | dFlow