Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

First launch

Start the program

Windows. Double-click server.exe. A black console window opens: keep it open while you use the panel. Windows may warn you about an unknown program. If it does, click More info → Run anyway.

Linux. Open a terminal in the program’s folder and run:

chmod +x server
./server

Choose a master password

On the first launch the server asks you to create a master password and repeat it:

Enter Master Password:
Confirm Master Password:

You’ll see asterisks instead of the characters you type. That’s expected.

The master password encrypts your account data, so the server asks for it every time it starts.

Write your master password down somewhere safe. It isn’t stored anywhere and can’t be recovered. Without it the server can’t read your saved data, and you’d have to add your accounts again.

Enter your license key

Next the server asks for the key from your account:

Enter your license key:

Paste the key and press Enter. You only do this once: after that the server activates on its own.

Open the panel

When the console shows a line with api listening, the server is ready. On the same computer, open this in your browser:

http://localhost:8080

There’s no separate sign-in: the panel opens straight away. That’s why you should read the next section.

Protect the panel

The panel doesn’t ask for a password. Anyone who can open its address can control your accounts. Never expose port 8080 to the internet.

By default the server accepts connections on all of the computer’s network addresses. If you only need the panel on this computer, close off outside access:

  1. Stop the server (see below).

  2. Open config.toml in the data folder.

  3. Change the api_bind value:

    [network]
    api_bind = "127.0.0.1:8080"
    
  4. Start the server again.

If the server is on a VPS, do the same and reach the panel through an SSH tunnel. Run this on your own computer with your details filled in:

ssh -L 8080:127.0.0.1:8080 user@your-vps-address

While that connection is open, the panel is available to you at http://localhost:8080.

How to stop the server

Press Ctrl+C in the console window and wait for it to finish. You’ll need the master password again on the next start.

What’s now on disk

A data folder appears next to the program:

WhatWhy
server.db and server.db-* filesThe database: your accounts and their secrets, encrypted
config.tomlServer settings
logs/Activity logs, one file per day

Keep this folder when you update or move the server.

Running unattended

You need this section if the server should start on its own, for example on a VPS. --headless turns off every console prompt, so the password and key have to be supplied up front.

OptionWhat it does
--headlessDon’t ask anything in the console
--license-key KEYPass the license key. Only needed for the first activation
SERVER_MASTER_PASSEnvironment variable holding the master password
--key-file PATHOr a file containing the master password
--data-dir PATHThe data folder. Defaults to data in the current folder

An example systemd service for Linux, in /etc/systemd/system/yaam.service:

[Unit]
Description=YA:AM server
After=network-online.target
Wants=network-online.target

[Service]
ExecStart=/opt/yaam/server --headless --data-dir /opt/yaam/data
EnvironmentFile=/opt/yaam/secret.env
Restart=on-failure

[Install]
WantedBy=multi-user.target

Put the password in /opt/yaam/secret.env and lock the file down with chmod 600:

SERVER_MASTER_PASS=your-master-password

Before the service’s first start, activate the license once by hand with the same options plus --license-key. Then enable the service:

sudo systemctl enable --now yaam

Next: panel overview.