ENTITY Documentation Portal
Operator manual · current release

Install ENTITY v3.4.2

Legacy URL note: this page keeps its historical filename for link compatibility. The supported release is v3.4.2; v3.4.1 and earlier are superseded for current deployment.

Reference environment

Use Python 3.11+ for the reference implementation. Install into an isolated virtual environment. Do not put operational identity keys, recovery material, production databases or private backups inside the Git repository.

git clone https://github.com/blackmore-technology-group/ENTITY.git
cd ENTITY
git checkout v3.4.2
python -m venv .venv
# Windows: .\.venv\Scripts\Activate.ps1
# Linux/macOS: source .venv/bin/activate
python -m pip install --upgrade pip
python -m pip install -r requirements.txt
python -m compileall -q src sdk protocol
python -m unittest discover -s tests -v

Verify release identity

Before production use, confirm the checkout resolves to tag v3.4.2 and compare the protected release commit 6dfa3d6cc738d9369cf092d2782676bf4f2a46e4. The release tree is f90bf74e29899f82d0a4ee321604346241bba4de.

State placement

Keep mutable runtime state outside the source tree. Separate at minimum: source checkout, ENTITY state, BTDU state, backups/exports, evidence archives and any hardware-key-protector configuration. Set filesystem permissions so ordinary application users cannot read private key material.

BTDU prerequisites

The BTDU operator CLI requires the ENTITY state directory, BTDU state directory and a qualified ADAM runtime root. The CLI verifies ENTITY authorization before mutating BTDU state.

python tools/entity_btdu_cli.py --entity-state E:\ENTITY_STATE --btdu-state E:\BTDU_STATE --adam-root D:\ADAM_ROOT --git-bin git status

Post-install checks