Use the admin website¶
The admin website is where your team publishes content, watches otomo's health, and manages staff accounts. This guide gets you signed in for the first time and tours each page. It takes about 20 minutes, most of it one-time setup.
You'll need:
- a login on your VM (your SSH key added to it), and WSL on Windows. See Before you begin;
- an invite link from an administrator, or the root password if you're setting otomo up.
Why it needs a tunnel¶
The admin website can publish content to every player, so it's deliberately not on the
internet. It only listens on the server's own address, 127.0.0.1:8090. To reach it,
your computer makes an SSH tunnel: an encrypted pipe from port 8090 on your computer to
port 8090 on the server. Command-line basics explains
tunnels in detail.
Step 1: Open the tunnel¶
- Open WSL (Start menu → Ubuntu).
-
Run:
-
The first time, SSH asks
Are you sure you want to continue connecting (yes/no)?. Typeyesand press Enter.
The command then seems to do nothing, with no new prompt. That's correct: the tunnel is open while this command runs. Leave the window open for as long as you use the admin website.
Type 127.0.0.1 in the command, not localhost
On the server, localhost means the IPv6 address ::1, where the admin website
doesn't listen. The tunnel would open, but every page would fail with
channel 3: open failed: connect failed: Connection refused in this window.
Step 2: Open the website¶
In your browser, go to:
Use exactly localhost here, not 127.0.0.1. The sign-in cookie is set for localhost,
and with the other address the browser won't send it back, so you'd be signed out on every
page.
You should see the Sign in page.
Step 3: Your account¶
- Keep the tunnel open and open the invite link in the same browser. It starts with
http://localhost:8090/. - On Set up your account, choose a password.
- If your account needs two-factor sign-in (it always does for the
adminrole), the next page shows a QR code. Scan it with an authenticator app on your phone (Google Authenticator, Microsoft Authenticator, 1Password and others all work), then type the 6-digit code the app shows. - You're signed in.
Invite links work once and expire. If yours doesn't work, ask for a new one.
Otomo starts with one emergency account, root@otomo.internal. Its password is on
the server:
Sign in with it, then immediately create a personal account for each person (Step 5) and use those. Keep root for emergencies.
Step 4: A tour of the pages¶
The menu on the left groups the pages. Which ones you see depends on your role (below).
Live ops
| Page | What it's for |
|---|---|
| Namespaces | The settings documents: create, edit drafts, create versions. Lists of records are edited as tables (Edit tables of game data). |
| Packs | Upload .pck content packs. |
| Releases | What each channel serves; compose, roll back and promote releases. |
| Maintenance | Close the game to players, with a message and an optional window, or warn them that one is coming. |
| Update gate | The oldest client build each channel still accepts, what an old one is told, and where it is sent to update. |
| Client update | The minimum build per platform and the message a blocked player sees, published as part of a release. |
Content
| Page | What it's for |
|---|---|
| Announcements | Write what players are told, one row per language, with an optional start and end, and preview it at a time you choose. It edits the announcements namespace's draft, so it is released like any other config. See Namespace presets. |
| Curated recordings | Rules that choose which recordings (such as replays) are featured in a list. |
Players and Economy
| Page | What it's for |
|---|---|
| Players | Find a player, read their account, party and recent activity, wallet and ledger. live_ops can disband a party or grant a reward, with a written reason. |
| Reconciliation | Accounts whose cached balance disagrees with the ledger. Read only. |
Services and Audit
| Page | What it's for |
|---|---|
| Overview | Health at a glance: which services are up, players online, free game servers, and any firing alerts (things that need attention now, such as "no free game servers"). |
| Logs | Search every service's log messages. Paste a request_id from an error to find exactly what happened to that request. |
| Audit | Who changed what, and when: every publish, rollback, account change and staff action. |
Admin
| Page | What it's for |
|---|---|
| Users | Invite staff, change roles, send password-reset links. |
Every signed-in person also has an Account page for their password, their signed-in devices and their two-factor settings.
The words on the Content pages (namespace, version, pack, release, channel) are explained in Content and patching.
Step 5: Staff roles and invites¶
Every staff account has one role. Each role can do everything the one above it can:
| Role | Can |
|---|---|
| viewer | Look at everything, change nothing. |
| live_ops | Also edit namespace drafts, create versions, upload packs, publish releases to dev and staging, change maintenance and the update gate, disband a party and grant a reward. |
| admin | Also create namespaces and edit their schemas, publish to live (what players get), roll back or promote any channel, and manage staff accounts (only the root account can create or change another admin). |
To invite someone (admins only):
- Users → Invite user.
- Fill in their Email, Name and Role, then press Send invite.
- Copy the invite link shown and send it to them privately (a direct message, not a public channel: whoever opens it first gets the account). Otomo doesn't send email itself, and the link is shown only once, so copy it before closing the dialog.
The person opens the link with their own tunnel open, as in Step 3.
Closing up¶
When you're done, sign out (top right), then stop the tunnel: in the WSL window, press Ctrl+C.
Next¶
Publish your first content update walks through the Content pages end to end.