On this page

How-to

Read the log and report a problem

Starboard's log lists what it did and every problem it met, newest first. When something goes wrong, the Report a problem steps gather the details a bug report needs, with personal details removed.

Find your answer
Flow chart: Something went wrong in Starboard. The same chart is written out in words after it.NoYesFind out what happenedSend it to someone tocheckKeep the logs smallerRemove every log nowSomething went wrongin StarboardDoes Starboardopen?What do you wantto do?Read the log1Report a problem2Limit how much iskept3Delete all logs4Starboard does notopenAnother article
The chart in words

Start: Something went wrong in Starboard

1 Read the log

  1. Go to System, then Logs.
  2. In Log, choose what to show: - Everything: every entry. - Problems: errors and warnings only. - Detailed: the extra entries detailed logging adds.
  3. To find something, enter a word in Search the log, such as the name of an app.

Each entry shows its Time, its Level (Error, Warning, Info or Detail), the Area of Starboard it came from and What happened. Select an entry's message to show more, when it has more. Select Show older entries to go further back.

2 Report a problem

  1. Go to System, then Logs, and find Report a problem.
  2. In Detailed logging, choose For 24 hours. This records every page request and every call to your apps.
  3. Do the thing that went wrong again.
  4. Select Copy the details. Starboard shows "Copied. Paste it into the issue".
  5. Select Open a new issue on GitHub. Paste the details into the issue, and say what you expected to happen.
  6. When you have finished, set Detailed logging back to Off.

To check what will be copied before you share it, select Show what will be copied.

3 Limit how much is kept

Starboard keeps its logs for 30 days and lets them take no more than 50 MB, unless you change it. Whichever limit comes first removes the oldest days.

  1. Go to Settings, then General, then Logs and feedback.
  2. Activate More settings, at the right of the page's heading.
  3. In Logs, choose in Keep logs for: 7, 14, 30, 60, 90 or 180 days, or a year.
  4. Choose in No more than: 10, 25, 50, 100, 250 or 500 MB.

Starboard shows "Saved" beside each one. Older days go at once, and from then on when a new day starts or the logs reach the size. What the limits cover says what the logs take now and since when.

The limits cover Starboard's own log, which also holds its jobs, updates and plug-ins' lines, the API's audit log, and the last Starboard update's log. Plug-ins keep no log files in Starboard.

The apps' own logs says how much Docker keeps for each app, such as "3 files of 10 MB". Docker's settings on the server set that, and Starboard cannot change them. Apps and plug-ins Starboard installs get 3 files of 10 MB each in their own set-up, so they stay small even without that setting.

4 Delete all logs

  1. Go to Settings, then General, then Logs and feedback, and activate More settings. Or go to System, then Logs.
  2. Select Delete all logs. It is in its own section at the end of the page, or at the top of System, Logs.
  3. Starboard asks Delete all logs? and says how much goes. Enter your Starboard password.
  4. Select Delete all logs to go ahead, or Cancel to keep them.

Starboard says "All logs deleted" and how much was freed. Today's file and the API's audit log are emptied, not removed, so Starboard keeps logging. Their first new line says the logs were deleted, from which browser or API key, and when. This cannot be undone. The apps' own logs, which Docker keeps, are not deleted.

Things to note

  • Starboard removes personal details before anything is written to its log: passwords, API keys and tokens, IP addresses, host and computer names, email addresses, the user name in folder paths and the dashboard's name. Read the text before you post it all the same.
  • Download saves the whole log as a text file, for example to attach it to an issue.
  • To suggest something or report a problem with one page, use Feedback in the side menu instead. Read Send feedback about a page.
  • Detailed logging is also in Settings, General, Logs and feedback, in the Logs section.
  • A Starboard installed before version 0.20 keeps the days it was set to (60 by default then). Choose again in Keep logs for to keep fewer.
  • If Starboard installed Reelix, System, Logs also has Reelix's log and Reelix's scheduled tasks. Starboard asks for Reelix's password first.
  • If you cannot open Starboard at all, read the server's copy of the log. On the server, in the Starboard folder, run this command:
docker compose logs starboard

Then read Starboard does not open.

If it does not work

  • "Could not copy. Use Download instead": your browser did not allow copying. Select Download, then attach the file or copy the text from it.
  • "That password is not right": enter the password you sign in to Starboard with, then select Delete all logs again.
  • The logs take more than No more than says: today's file is never removed, so a busy day with detailed logging can go over the limit until the next day starts. Set Detailed logging back to Off.
  • "Set STARBOARD_REPO on the server to link straight to the issue page": Starboard does not know where to report problems. Go to the Starboard project on GitHub and open a new issue there.

Find out more

This page on GitHub, where the help is written.