Skip to content
Documentation

Self-Hosted Overview

Overview

The UnoLock Federated Node is the self-hosted version of UnoLock. You run your own node on a Linux server you control, create Safes on it, and federate with other independently operated nodes. A Safe is a personal encrypted vault. You can run a node just for yourself, or invite others to create their own Safes with registration codes.

The node is free, open-source software under the GNU AGPL version 3 (AGPL-3.0-only). There is no trial, purchase or paid activation.

Federation lets people keep their own home service while they exchange private messages and work in shared Spaces across nodes. Nodes find each other through a distributed lookup network instead of a central directory, and traffic between nodes travels over Tor onion services. Your browser connects to your home node over HTTPS.

Who it's for

You need to be able to sign in to a server, run terminal commands, and change DNS and firewall settings with your hosting provider. You do not need to build UnoLock or understand its cryptography.

The Federated Node suits:

  • Self-hosters who already run a server or VM.
  • Families and teams who want one node for everyone, with invites.
  • Organisations that want their data on infrastructure they control.
  • Anyone who wants a home service of their own and still wants to share across nodes.

What's included

The node ships as one container. It includes:

  • The Safe service.
  • The browser app.
  • The admin app.
  • Tor, for communication with other nodes.
  • Automatic HTTPS certificate management.

You do not need to install Node.js, npm, Tor or a web server on the host.

Hosted vs Self-Hosted at a glance

UnoLock Hosted UnoLock Self-Hosted
Who runs it UnoLock runs it as a managed service You run it on your own server
Price US$30 a year Free under AGPL-3.0, with no trial or paid activation
What you install Nothing; it runs in your browser The Federated Node container on a Linux server
Registration and storage Managed by UnoLock You decide on registration and storage
Operations Handled for you Hosting, security, updates, availability, backups and recovery are yours

Independently hosted nodes are operated and maintained by their own operators, not by TechSologic Inc. An official UnoLock software release does not make an independent node a TechSologic-operated or endorsed service. TechSologic does not provide technical support for the federated node; the documentation is available for self-service. See Operator responsibilities.

Secure the host first

The UnoLock container does not harden the host or configure its firewall for you. Keep the OS and container runtime patched, restrict SSH and Docker access to trusted administrators, use SSH keys and least-privilege accounts, and allow only the required inbound ports. See Host security.

Where to go next

Get started:

Run your node:

Federation:

Protect your data:

The full source and operator reference are in the public repository: TechSologic/unolock-federated-node.

FAQs

Is the Federated Node really free?

Yes. The node and its bundled web client are free and open-source software under the GNU AGPL version 3. No trial, purchase or paid activation is required. You may use, modify and redistribute them under the AGPL terms, including its corresponding-source requirements.

Do I need to install Tor or a web server myself?

No. The container includes the runtime, browser apps, service worker, Tor and an HTTPS proxy that obtains and renews certificates automatically.

Can the node administrator read my Safe?

The browser app encrypts Safe contents before sending them to the node. The node stores encrypted data and transports encrypted messages. Node administration and Safe access use separate credentials. The app delivered from the node and your active browser and device remain trusted. See Security model.

What happens if TechSologic stops operating?

Operators can build and run the AGPL node independently and configure their own bootstrap peers. Continued operation depends on participating operators and reachable peers, rather than TechSologic remaining in business. This does not automatically recover data from a service that has shut down.

Can I share with people on other nodes?

Yes. People on different nodes can exchange private messages and share encrypted files and notes in shared Spaces. See Federation and Shared Spaces across nodes.