Command reference¶
All commands run as the service user (sudo -iu dayz). dzo <command>
--help shows every option, and the man pages have the full reference. The most used
commands are on the cheat sheet (two A4 pages).
Setup and Steam¶
|
first-time setup as the service user: directories, container images, site repo, weekly image refresh timer (see Installation) |
|
rebuild the container images and prune the old ones |
|
interactive Steam login (password and Steam Guard) |
|
account, last login, session state |
|
wipe steamcmd’s working directory |
Site repository¶
|
update the site checkout (clone it the first time), load it and resolve every instance |
|
uncommitted changes in the checkout ( |
Products and updates¶
|
first download of a server build |
|
download a new server build (manual only) |
|
check mods (and apply per policy); report new server builds |
Instances¶
|
print the resolved configuration (see How an instance is resolved) |
|
first render: subvolume, pristine mission, first live mission (fails if the instance exists) |
|
(re)generate the units and timers |
|
copy an instance’s data into a new instance of the site repository |
|
stop, remove units and data |
|
switch to another installed server build (see Mods, updates and server upgrades) |
|
the mod list and its order (add and remove: |
|
run the hook scripts of one hook point (the units use it, see Missions, integrations and overlays) |
|
ask the server to shut down over RCon and wait (the unit’s |
|
allow starts again after a failed render or crash loop |
|
start |
|
stop and stay stopped; with a countdown option, announce, lock and kick the players first (Stopping with a countdown) |
|
graceful restart |
|
state, players, health, restarts, last render (what the exporter reports) |
|
serve |
|
server console (the unit’s journal) |
|
move old profile logs into the archive, apply its retention (see Running servers) |
|
list the archived profile logs |
|
after an unclean exit: tails of the newest logs to the journal and Discord (the unit runs it) |
|
a debug container with the instance’s mounts and no network ( |
|
a command in the running container |
|
one RCon command with the instance’s port and password |
|
interactive console with the server’s messages |
|
a new RCon password (read at the next start) |
|
wipe the world (confirmation, destructive snapshot first) |
Mods¶
|
install a mod and add it to an instance (a local mod is always a servermod) |
|
debugging only: a signed local mod that clients load too (Debugging a client mod you build yourself) |
|
the mods of an instance and their installed generation |
|
remove a mod from an instance’s list |
|
download the mods listed in |
|
force a fresh download |
|
show a mod’s declared dependencies (diagnostics, does not affect the load order) |
|
fetch, normalise and validate a mod’s integration files |
Missions and config¶
|
build the mission and apply it in place, or show what would change |
|
first live mission; fetch a new pristine version and show the plan |
|
source, age of the pristine copy, what the next render would change |
|
restore managed files from file history |
|
recreate the live mission (confirmation and snapshot) |
|
serverDZ.cfg changes |
Backups¶
|
snapshots |
|
protect a snapshot from pruning |
|
full or partial restore |
Monitoring and notifications¶
|
Icinga plugin |
|
Icinga plugin, game server only |
|
send a test notification |
Web interface and API¶
|
run the JSON API and the endpoint the dzo-admin mods call (see JSON API) |
|
run the web interface (see Web interface) |
|
create an API token; the secret is printed once. |
|
list or delete tokens |
|
the people who may use the web interface, with their grants (Steam ID, username, name, |
|
give a role ( |
|
take the roles on the listed instances away, or every grant without |
|
set the password of a person who has a role and a username, reading the password from the terminal (twice, no echo) or one line from a pipe. For when Steam sign-in does not work: the first login with it sets up a second factor. All sessions of the person end |
|
block a person from logging in (their sessions end, grants stay) / allow it again / delete the person with grants, credentials and sessions |
|
remove password, TOTP, passkeys, recovery codes and sessions (the username stays); the person signs in through Steam and sets up a second factor again |
dzo user runs on the host of dzo serve and writes its database (<paths.db>/dzo.sqlite) directly,
which is safe while dzo serve runs, like dzo token with the token file. So it works when nobody can
log in. Every change is written to the audit log with the source cli and the actor cli:$USER.
Map tiles¶
|
build the satellite tiles of a map from its data PBO (see Admin map and the dzo-admin mod) |
|
maps with tiles, and whether the source file changed since |
Players and vehicles¶
These talk to a running dzo serve through the API. Give them a token with
--token-file <file> or $DZO_TOKEN; --api <url> picks the
installation (default: the local serve.listen). They need the
dzo-admin mod on the instance.
|
online players |
|
what happens in the game, journalctl style: kills, deaths, joins, building and raids, chat, admin actions.
Prints the newest |
|
message one player or everyone. |
|
kick a player; the reason (at most 64 bytes) is shown to them |
|
heal a player; repair everything they carry and wear |
|
kill a player (needs |
|
teleport a player |
|
spawn an item for a player |
|
spawn an item on the ground at a position; a quantity above the stack size makes more stacks |
|
persistent vehicles |
|
spawn a vehicle with its parts and fuel on the ground at a position |
|
repair a vehicle; |
|
stand a vehicle upright on its wheels |
|
put a vehicle on the ground at a position, upright and at rest; players inside move with it, at most
|
|
delete a vehicle ( |
|
raise a territory flag and fill its timer; the id is the id of its marker on the |
Bans and evidence¶
These talk to a running dzo serve through the API, like the player commands (--token-file or
$DZO_TOKEN, --api). See Bans and evidence.
|
ban a player; the answer says per instance whether the ban is in force or pending |
|
bans, newest first |
|
a ban with its targets, evidence and history |
|
change only the given fields |
|
unban: end a ban now (it stays in the history) |
|
file evidence against a player |
|
the evidence filed against a player |
Migration and development¶
|
example site config from dayzdockerserver branches (see Coming from dayzdockerserver) |
|
boot a real server on a render result (development machines only) |
|
boot the unmodded server and record the baseline of this server build |
|
write the man pages of every command (the Debian build runs it) |