Burrow config is the first section under Settings. It holds what this Burrow is called, how it takes software updates, and whether it resolves IP addresses to locations.
Display name#
The name this Burrow is shown under, up to 80 characters. Type it and select Save.
Leave it empty and the Burrow uses its own address name instead, which is what the placeholder shows. The name also travels with machine invitations, so it is what identifies this Burrow when somebody bootstraps a machine against it.
Auto-install updates#
With this on, your Burrow installs new releases itself and restarts into them. Each release is checked before anything is written to disk:
The release must be signed by RatelKey's release key.
The downloaded file must match the checksum published with it.
The version must be newer than the one running, so a withdrawn or older build cannot install itself.
Anything that fails is skipped and tried again on the next round, and the Burrow keeps serving on the version it has. If a new version starts and fails, your Burrow rolls back to the one that was working.
With it off, a Software updates row appears with Check for updates. When one is waiting you get an Update to the new version button, and installing it is your click.
Address and version#
Two read-only rows. Address is where this Burrow is reachable, and Version is the build it is running. Both are worth quoting when you get in touch with support.
IP data#
Your audit trail records the address every request came from. Turn on Resolve IP addresses and it shows the country and city alongside, which is what makes an unfamiliar address worth a second look.
The data comes from MaxMind's GeoLite2 databases, which are free and need an account of your own.
Create a free account at maxmind.com and generate a licence key.
Turn on Resolve IP addresses. The credential fields appear.
Enter your MaxMind account ID and licence key, then select Save.
Save stores the credentials, turns the feature on, and starts the first download in one action. Nothing is written until you select it, so flipping the switch and changing your mind costs nothing.
Once the databases are installed, the section lists each one with its size and when it landed, along with:
Control | What it does |
|---|---|
Update now | Downloads the current databases straight away rather than waiting for the next scheduled refresh. |
Remove credentials | Clears the account ID and licence key and collapses the section. This is also how you replace a key. |
A failed download leaves its reason under the database list, and Last checked tells you when your Burrow last looked. MaxMind's licence asks that the data be credited wherever it is used, which is the line your Burrow shows at the foot of the section.