Quick Start

This guide helps you get SpaceDF running quickly on your own infrastructure using Docker Compose and default settings.

Before You Begin

Make sure you have:

Docker and Docker Compose installed
Basic Linux command-line knowledge
An environment with at least the minimum system requirements

If you are unsure about any of the requirements above, see Prerequisites for details.

If you need advanced configuration, security tuning, or production setup, see Advanced Setup instead.

Get the Source Code


# Make your new spacedf project directory
mkdir spacedf-project
 
# Clone the SpaceDF repository:
cd spacedf-project
git clone https://github.com/Space-DF/spacedf-core.git
 
# Switch to your project directory
cd spacedf-core
 
# Copy the env vars
cp .env.example .env

Configure Environment Variables

To generate and apply all secrets at once you can run:


chmod +x generate-keys.sh
./generate-keys.sh

The default values are sufficient for Quick Start.

Pull Images and Start SpaceDF

From the directory that contains your ./entrypoint.sh file, run:


# Start all services in the background
chmod +x entrypoint.sh
./entrypoint.sh

This script pulls the required Docker images and starts all SpaceDF services in the background.

Verify Services

Confirm that all containers are running:


docker compose ps

When all services are healthy, SpaceDF is ready to use.

Default Ports

After startup, SpaceDF services are available on the following default ports:

Service	Port
Dashboard	localhost:3000
Admin Portal	localhost:3001
Backend API	localhost:8000
EMQX (API)	localhost:18083
MQTT (WebSocket)	localhost:8883

Make sure these ports are open on your server and not used by other services.

🎉 You’re all set! SpaceDF is now running on your server. Enjoy building with it.

Continue with Advanced Setup to customize your deployment.