Skip to main content
Syft Space can be installed using three different methods depending on your needs and technical expertise.
System requirements: 4GB RAM minimum, 8GB recommended
The desktop app provides one-click setup with system tray integration and auto-updates.
Download and install:
  1. Download the .dmg file from GitHub Releases
  2. Open the downloaded file and drag Syft Space to your Applications folder
  3. Launch Syft Space from Applications
  4. On first launch, you may need to approve the app in System Settings → Privacy & Security
Features:
  • System tray integration
  • Automatic updates
  • Launch at startup (optional)
  • One-click start/stop
Learn more about desktop app features in the Desktop App section.

​
Docker (production ready)

Docker deployment is recommended for production environments and servers. Quick start: 
docker run -d \
    --name syft-space \
    --restart unless-stopped \
    -p 8080:8080 \
    -v /var/run/docker.sock:/var/run/docker.sock \
    -v /dev/null:/root/.docker/config.json \
    -v syft-space-data:/data \
    ghcr.io/openmined/syft-space:latest
What this does:
  • Runs Syft Space on port 8080
  • Automatically restarts the container if it stops
  • Mounts Docker socket for database provisioning
  • Persists data in a Docker volume
The Docker socket mount (/var/run/docker.sock) is required for automatic provisioning of vector databases. Only use this on trusted systems.
See the Docker deployment guide for advanced configuration options.

​
From source (development)

Install from source for development or customization. Prerequisites:
  • Python 3.12+
  • Node.js 20+
  • Docker (for database provisioning)
  • Git
Installation: 
# Clone the repository
git clone https://github.com/OpenMined/syft-space.git
cd syft-space

# Run the setup script
./run.sh
The run.sh script will:
  1. Set up Python virtual environment
  2. Install backend dependencies
  3. Install frontend dependencies
  4. Start both backend and frontend servers
Access the application:
See the Source deployment guide for detailed development setup.

​
First-time setup

After installation, complete the initial setup:
1

Access the application

Open http://localhost:8080 in your browser
2

Create your account

Click Register and create your account with email and password
3

Configure network settings

Add your developer token (contact OpenMined to obtain one)
4

Start building

You’re ready to create your first dataset and endpoint!
Developer tokens are only required for local deployments when publishing endpoints. Cloud deployments use the public IP instead.

​
Next steps

Quickstart

Create your first endpoint in 5 minutes

Core concepts

Learn how Syft Space works

Build docs developers (and LLMs) love

Get started for freeTalk to us