How-to
Run a server job
Server jobs are tasks that run on the server itself, such as a check of every app and service. Starboard lists them on System, Overview, shows how each one went, and lets you start one with Run now.
Before you begin
- A job runner is set up on the server, by hand. Starboard does not run jobs itself: it only asks, and the runner does the work.
- Starboard knows the runner's folder, set with
STARBOARD_JOBS_DIR. To use Run now, Starboard must be allowed to write in that folder'srequestsfolder. Both are explained in Back up the whole server, which uses the same folder.
Steps
- Go to System, then Overview.
- Find Server jobs. Each job shows its name, a short summary and when it last finished.
- Read the job's state: - Finished: it ran and finished. - Failed: it ran and something went wrong. - Running: it is running now. - Waiting to start: Starboard has asked, and the runner has not started it yet. - Not run yet: it has no result yet.
- To run a job now, select Run now beside it. The state changes to Waiting to start, then Running.
- Wait. The page checks again every 5 seconds while a job runs, and shows the result when it finishes.
- If the job wrote a report, select What it found to read it.
Things to note
- Run now cannot be selected while the job is waiting or running.
- Starboard lists every job the runner reports, apart from the backups. Backups have their own page: System, then Backup and restore.
- Server jobs appears only when the runner has reported at least one job.
If it does not work
- No Server jobs on the Overview page: the runner is not set up, or has not reported a job yet. Check
STARBOARD_JOBS_DIRin.env. - No Run now button: Starboard cannot write in the
requestsfolder. Give it permission to write there, then restart Starboard. - Not started and a message: Starboard could not ask for the job. Read the message, then try again.
- Failed: select What it found to read what went wrong.
Find out more
This page on GitHub, where the help is written.