Quick Start
This guide helps you get SpaceDF running quickly on your own infrastructure using Docker Compose and default settings.
Quick Start Limitations
- ❌ Google login is not enabled
- ❌ AWS integrations (S3, SES) are not configured
- ❌ Email sending is disabled
- ❌ Image uploads and asset images are not displayed (cloud storage is not configured)
If you need advanced configuration, security tuning, or production setup, see Advanced Setup instead.
Before You Begin
- Docker and Docker Compose installed
- Basic Linux command-line knowledge
- An environment with at least the minimum system requirements
Make sure you have:
If you are unsure about any of the requirements above, see Prerequisites for details.
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 .envConfigure Environment Variables
To generate and apply all secrets at once you can run:
chmod +x generate-keys.sh
./generate-keys.shThe 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.shThis script pulls the required Docker images and starts all SpaceDF services in the background.
Verify Services
Confirm that all containers are running:
docker compose psWhen 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.
Default account (Quick Start only)
Quick Start creates default accounts for initial access
These accounts are for local testing only.
Frontend Web Apps
Dashboard
- Username:
admin@example.com - Password:
changeme@Default123
Admin Portal
- Username:
admin@example.com - Password:
changeme@Default123
Backend Services
Auth service
- Host:
localhost:5434 - Username:
postgres - Password:
postgres - Database:
auth_service
Bootstrap service
- Host:
localhost:5433 - Username:
postgres - Password:
postgres - Database:
bootstrap_service
Dashboard service
- Host:
localhost:5435 - Username:
postgres - Password:
postgres - Database:
dashboard_service
Device service
- Host:
localhost:5436 - Username:
postgres - Password:
postgres - Database:
device_service
Telemetry service
- Host:
localhost:5437 - Username:
postgres - Password:
postgres - Database:
spacedf_telemetry
To configure authentication, user management, and production security, continue with Advanced Setup.
🎉 You’re all set! SpaceDF is now running on your server. Enjoy building with it.