Skip to main content

How to: Launch your SyftBox datasite

Launching your own DataSite is simple and only requires installing the SyftBox package and running the client. Once complete, you'll be part of the SyftBox network and ready to collaborate!

Quick install (one-liner)​

The fastest way to get started is with our one-liner install script:

curl -LsSf https://syftbox.openmined.org/install.sh | sh -s -- run

This command downloads the installation script and immediately launches SyftBox in a single step.

Manual installation​

If you prefer more control over the installation process, you can follow these steps:

1. Install uv (Python package manager)​

First, install the uv package manager:

curl -LsSf https://astral.sh/uv/install.sh | sh

2. Create a virtual environment​

Create a virtual environment to isolate the SyftBox installation:

uv venv .venv

3. Install SyftBox​

Install the latest version of the SyftBox package:

uv pip install -U syftbox

4. Launch the SyftBox client​

Start the SyftBox client:

uv run syftbox client

What happens next?​

Once you've launched the SyftBox client:

  1. You'll be prompted to authenticate with your email address
  2. Your datasite will connect to the network
  3. You'll be able to sync files with other datasites - including proposing your own data or discovering others'
  4. You can submit your own Apps to others in the network and accept Apps

Congratulations! You're now part of the SyftBox network and ready to collaborate asynchronously with others.