On this page

How-to

Find the setup code

The setup code is a one-time code that proves the person choosing Starboard's password is the person who installed it. The installer shows it at the end. You can show it again on the server until you have chosen a password.

Before you begin

Steps if you used the installer

  1. Find Setup code in the Open Starboard box the installer showed at the end. Read What it prints at the end.
  2. If you closed the terminal, open a new one and go to the Starboard folder:
cd ~/starboard
  1. Show the code. This prints the setup code on its own:
cat data/setup-token

It is also in Starboard's log, on the line that starts "No password yet. Open the dashboard and enter this setup code:". To show the log:

docker compose logs starboard

Steps if you used the ready-made image

  1. Open a terminal on the server.
  2. Show Starboard's log:
docker logs starboard
  1. Find the line "No password yet. Open the dashboard and enter this setup code:". The code is at the end of it.

Things to note

  • The code stays the same when Starboard restarts or updates, until you choose a password. After that it is deleted and no longer works.
  • Copy the code exactly, with the same capital and small letters. It can include dashes and underscores.
  • If you installed with ./install.sh --native, show the log with journalctl --user -u starboard instead.

If it does not work

  • "No such file or directory": either you are not in the Starboard folder, or a password has already been chosen, so there is no code any more. Run cd ~/starboard and try again.
  • A password has already been chosen and you do not know it: read Reset a forgotten password. Resetting makes a new setup code.
  • Starboard says "The setup code is not right": check you copied the whole code and nothing else, with no space at either end. Show it again with the steps here and copy it once more.

Find out more

This page on GitHub, where the help is written.