Try It on Localhost
Overview
You can run a local node on the same computer as your browser, without public DNS. This route uses Docker Compose and the repository's docker-compose.dev.yml file, and serves the node at http://localhost:43100.
Local mode uses development key protection and loopback HTTP, and publishes only on host loopback. It is for trying the node on your own computer. For a public installation, use the permanent-hostname route in Install your node with a separate data volume.
Before you start
- Install Docker Engine and the Docker Compose plugin.
-
Clone the repository:
git clone https://github.com/TechSologic/unolock-federated-node.git cd unolock-federated-node -
Use a current Chromium-family desktop browser with a working passkey or security key.
Start the local node
-
From the cloned repository, confirm Docker and Compose are working:
sudo docker info sudo docker compose version -
Build and start the local node:
sudo docker compose -p unolock-local -f packaging/docker/docker-compose.dev.yml up --build -d -
Read the logs to find the one-time admin setup code:
sudo docker compose -p unolock-local -f packaging/docker/docker-compose.dev.yml logs --no-color
Set up the node and create a Safe
- Open http://localhost:43100/admin.
- Choose Register admin, enter the one-time admin setup code from the logs, and register your passkey and PIN.
- Choose Unlock Node.
- In Client, use Rebuild And Sign Client (or Sign Client) and wait for activation.
- In Safes, create a Safe registration code.
- Open http://localhost:43100/, choose Create Vault, and create your Safe with that code.
- In Notes, create and save a note.
- Sign out, reopen the Safe, and check that the note is still readable.
Keep using localhost
Keep using localhost with port 43100. Switching to 127.0.0.1 changes the passkey hostname.
A local-only deployment warning is expected in Setup.
Stop the local node
To stop the local node while retaining its data:
sudo docker compose -p unolock-local -f packaging/docker/docker-compose.dev.yml down
Do not reuse the local node's state for a public installation.
FAQs
Why does Setup show a local-only deployment warning?
This mode uses development key protection and loopback HTTP, and publishes only on host loopback. The warning is expected for a local node.
Can I open the local node at 127.0.0.1 instead?
No. Keep using localhost with port 43100. Switching to 127.0.0.1 changes the passkey hostname, so your passkeys will not match.
Where do I find the admin setup code?
In the container logs. Run sudo docker compose -p unolock-local -f packaging/docker/docker-compose.dev.yml logs --no-color. Logs contain the private setup code, so do not post them publicly.
Does stopping the local node delete my data?
No. The down command shown above stops the local node while retaining its data.
Can I turn my local node into a public node?
No. For a public installation, follow Install your node with a permanent hostname and a separate data volume.