How-to
Reset a forgotten password
If you have forgotten Starboard's password, remove it on the server and choose a new one. Everyone is signed out, and your apps and settings stay as they are.
Before you begin
- You can enter commands on the server, at its keyboard or over SSH (secure shell). Read The terminal: entering commands and Connect to your server from another computer.
- You know how you installed Starboard: with the installer, or from the ready-made image. Follow the steps for your way.
Steps
If you used the installer
- On the server, go to the folder you installed Starboard in. If you installed it in your home folder, this command takes you there:
cd ~/starboard
- Run the reset script. It removes the password, signs everyone out and restarts Starboard:
./reset-password.sh
It ends with "The password is removed and everyone is signed out", then shows a new setup code. 3. Open Starboard in your browser. It shows Set up Starboard. 4. In Setup code, enter the code the script showed. 5. In Choose a password and Enter it again, enter your new password. It must have at least 10 characters. 6. Select Save password and continue.
If you used the ready-made image
- On the server, go to the folder that holds
compose.image.yaml. For example:
cd ~/starboard
- Leave a file that asks Starboard to remove the password when it next starts:
touch data/reset-password
- Restart Starboard:
docker restart starboard
- Show Starboard's log, which holds the new setup code:
docker logs starboard
Find the last line that says "Open the dashboard and enter this setup code", and copy the code at its end. 5. Open Starboard in your browser and follow steps 3 to 6 of If you used the installer.
Things to note
- Only the password and sign-ins change. Your apps, API keys, categories and settings stay as they are.
- The dashboard name is filled in for you on the Set up Starboard page. Change it there if you want to.
- If you still know the password, change your password instead.
If it does not work
- "Stopped: no data folder here": you are in the wrong folder. Go to the folder you installed Starboard in and run the script again.
- "Stopped: Starboard did not restart": Starboard did not start again within 30 seconds. Read its log with this command, from the same folder:
docker compose logs starboard
Then read Starboard does not open. - "The setup code is not right": copy the code again, from the newest line of the log. An older code from before the reset no longer works.
Find out more
This page on GitHub, where the help is written.