Documentation
These pages are the repository’s own guide, rendered from the same Markdown files. Where a page links to a file that is not part of the guide, the link goes to the source on GitHub.
The documentation is English only.
Getting it running
- The Bothy guideBothy is a self-discovering console for one machine. This directory is the half of the documentation written for somebody who has not read the source: how to install it, which files you will actual…
- Installing BothyTwo supported paths. Both end at the same place: a checkout you can read, a .env full of secrets that were generated rather than typed, and about twenty containers running - two of which are one-sh…
- The bothy commandbothy is the half of Bothy you can have before you have a checkout. It installs one, and after that it is a dispatcher: a small shell script that finds your checkout and hands most of what you type…
- UpgradingAn upgrade is two commands, and they update two different things. Running only one of them is the most common way to end up confused about what version you are on.
- The files you will actually editBothy is a set of Docker Compose stacks, a Traefik file-provider directory, two policy files and one .env. This page maps "I want to change X" onto the file that decides it, and says what has to ha…
Using it
- Operating it from the consoleBothy is the web application on :80. Open http://<node-ip>/ and you land on the Overview; everything else is one of three top-level destinations.
- Adding a service to the stackThis is for something Bothy itself runs - a container in this repository's compose files. For something you run in ~/projects, see Declaring a project; the two are different mechanisms and mixing t…
- Bothy Fileshttp://<node-ip>/#/files. Every document on the box, read straight off the disk it lives on - rendered, searchable, linkable and editable. No second copy, no sync lag, nothing to keep out of git.
- Declaring a projectBothy discovers two things by itself: Traefik routers and Docker containers. That leaves two blind spots, and a declaration is how you fill them.
- ThemesBothy ships five themes and will load any number you add. A theme you add is one .css file in one directory - no rebuild, no npm, no restart, and it survives docker compose up --build, which replac…
Operating it
- MonitoringEvery container on this box is covered - logs and metrics - with no per-service setup. That is not a claim about how thorough the configuration is; it is a consequence of how two of the three colle…
- RolesBothy has four roles: viewer, editor, operator and shell. They are flat and deliberately non-composite - holding one never implies another - because shell grants an arbitrary terminal and must neve…
- SettingsSettings is a section with its own grouped menu, a search box and pages made of setting blocks - a title, one line saying what it is, and Expand/Collapse. It is laid out like GitLab's settings on p…
- When something is wrongStart with one command: