Documentation / Working together
What is a hub?
With a hub you work on the same tree with more people or on more computers. The hub runs on a server of your own or of your society; Stambeam never sees your data.
What you can do with it
- The same tree on your laptop and your PC, always up to date.
- Share your tree or a part of it with family or your society, to view or to work along.
- Search and add with the phone app, also at the cemetery or in the archive.
- Share a branch, so others can look before you merge.
What you need
A computer that is always on: a server, a NAS or a Raspberry Pi 4 or 5, with Docker. Installing it is somewhat technical. If someone in the family or the society can do that, ask them for help.
To reach the hub from outside, you need an https address or a VPN to your own network.
How you can get the hub will follow later. Interested? Email [email protected].
Your data
- The hub runs at your place. Stambeam has no server and does not see your tree.
- The hub makes no internet connection of its own: no usage data and no automatic updates.
- Living people are shielded by default for the people you invite.
- A backup outside the device and an encrypted disk are up to you. The hub makes a copy every day, but it sits on the same disk.
Updating the hub
The hub does not update itself. A new version is a new Docker image; you restart the hub with it, keeping the same storage (volume).
If the app is newer than the hub, Stambeam says The hub needs an update. Syncing waits; your own work simply stays on your computer. If the hub is newer, Stambeam asks you to update the app.
- 1Make a backup first
Copy the hub’s storage to a place outside the device. - 2Start the new version
Put the new version number in your compose.yaml and restart with docker compose up -d. Do not remove the storage (volume). - 3Check the hub
The address /v1/health of the hub shows the new version. On the first start the hub converts every tree to the new format, after a copy. - 4Then update the apps
Everyone chooses Help, Check for updates in Stambeam.
Stuck? Email [email protected].