Commands

basalt-host is the command for Basalt Host with no screen. It is installed by the Linux server packages, and is inside the Docker image. Most commands need sudo, because the host’s settings belong to its own user.

In Docker, put docker exec basalt in front: docker exec basalt basalt-host status.

Command	What it does
`basalt-host status`	Whether the host is running, its name, address, identity and version, what it shares, its devices, the setup code while it waits for one, and anything left to do
`basalt-host start`	Starts the `basalt-host` service, and says when it is running
`basalt-host stop`	Stops the service until it is started again or the computer restarts
`basalt-host restart`	Restarts the service, and says when it is back
`basalt-host update`	Installs the newest version now, where this host can update itself
`basalt-host setup-code`	Shows the setup code, which lets the first device set up and manage the host
`basalt-host setup-code --reset`	Makes a new setup code even though the host is set up: for when the device that managed it is lost. The next device to use it manages the host too
`basalt-host share PATH [--name NAME]`	Chooses the drive or folder the host shares, while it is stopped. While it runs, choose it in Manage host instead
`basalt-host serve [--port PORT]`	Runs the host in the foreground. This is what the service and the container run
`basalt-host health`	Exits with 0 if the host answers on its port. Docker’s health check uses it
`basalt-host --help`	Lists the commands; `basalt-host COMMAND --help` explains one
`basalt-host --version`	Shows the version

Options

Option	What it does
`--config PATH`	Uses the host settings at `PATH`. Also set by `BASALT_HOST_CONFIG`. By default, the service’s (`/var/lib/basalt-host/host.json`) where there is one, otherwise your own user’s

The service

The packages install two systemd units. You rarely need them directly; the commands above say what they did in plain words.

Unit	What it is
`basalt-host.service`	The host itself. Starts with the computer, and restarts if it stops unexpectedly
`basalt-host-update.path`	Watches for the host asking to be updated, and runs `basalt-host-update.service`, which installs the newest official release

Its log:

journalctl -u basalt-host        # all of it
journalctl -u basalt-host -f     # follow it as it happens

Docker

Command	What it does
`docker exec basalt basalt-host status`	The host’s status and setup code
`docker logs -f basalt`	Follows the host’s log
`docker compose pull && docker compose up -d`	Updates to the newest image
`docker restart basalt`	Restarts the host