Building a SeedSigner SD card image

Configure environment variables

Force Docker to build on a container meant to run on amd64 in order to get an identical result, even if your actual cpu is different:

export DOCKER_DEFAULT_PLATFORM=linux/amd64

Select your board type from the Board configs list below.

If you're unsure, most people should specify pi0.

export BOARD_TYPE=pi0

Set your target release version of the SeedSigner code (see: https://github.com/SeedSigner/seedsigner/releases):

# e.g. 0.8.0, 0.7.0, etc
export RELEASE_TAG=x.y.z

Checkout the branch associated to the target release version of the SeedSigner code (e.g. 0.8.5, 0.8.0, etc)

git checkout $RELEASE_TAG

Initialize and update submodules (buildroot) from the seedsigner-os repo

git submodule init
git submodule update

Start the build!

SS_ARGS="--$BOARD_TYPE --app-branch=$RELEASE_TAG" docker compose up --force-recreate --build

*Note: We recommend running these steps in WSL2 (Windows Subsystem for Linux) instead of PowerShell so that you can just follow the macOS / Linux steps above.*

Windows prerequisites (PowerShell)

These must be set before cloning the repo. If you already cloned, reclone after setting these.

1. Enable Developer Mode in Windows (Settings → System → For Developers → Developer Mode) so Git can create symlinks.

2. Configure Git to preserve LF line endings and symlinks:

git config --global core.autocrlf false
git config --global core.eol lf
git config --global core.symlinks true

Optional: verify the GCC hash file is a symlink after submodules are initialized:

Get-Item opt/buildroot/package/gcc/gcc-initial/gcc-initial.hash | Select-Object LinkType,Target

Configure environment variables

Force Docker to build on a container meant to run on amd64 in order to get an identical result, even if your actual cpu is different:

$env:DOCKER_DEFAULT_PLATFORM = 'linux/amd64'

Select your board type from the Board configs list below.

If you're unsure, most people should specify pi0.

$env:BOARD_TYPE = 'pi0'

Set your target release version of the SeedSigner code (see: https://github.com/SeedSigner/seedsigner/releases):

# e.g. "0.8.0", "0.7.0", etc
$env:RELEASE_TAG = "x.y.z"  

Checkout the branch associated to the target release version of the SeedSigner code (e.g. 0.8.5, 0.8.0, etc)

git checkout $env:RELEASE_TAG

Initialize and update submodules (buildroot) from the seedsigner-os repo

git submodule init
git submodule update

Start the build!

$env:SS_ARGS = "--$env:BOARD_TYPE --app-branch=$env:RELEASE_TAG"
docker compose up --force-recreate --build