Scheduler

The scheduler runs an action on one queue at a time you choose. Typical uses are to pause a queue during the working day, to resume it overnight, or to cap its speed in the evening.

The scheduler is part of FatRat itself. It runs whenever FatRat runs, including fatrat --nogui on a server. It does nothing while FatRat is not running, and an action whose time passes in that period is not run later. If the computer was suspended, FatRat catches up on the minutes it missed, but only the last 5 minutes.

Actions

Each scheduled action has a name, a queue, an action and a time. The action is one of:

Resume all: Starts every transfer in the queue that is paused or has failed. Transfers that are waiting or completed are left alone.
Stop all: Pauses every active transfer in the queue.
Set speed limit: Sets the queue's download and upload limits, in KiB/s on the desktop (the web and terminal interfaces call the unit kB/s or KB/s; it is 1024 bytes in all three). 0 means no limit. This replaces the limits you set on the queue. It does not change per-transfer limits or the global limits. See Transfers and Queues.

The scheduler acts on a queue, not on single transfers. To act on several queues at a given time, add one action for each.

When an action runs

Choose one of two kinds of schedule:

Repeated: a time of day and the days of the week it applies to, Monday to Sunday. A new action starts with every day selected. All three front ends require at least one day.
One time: a single date and time.

Times are to the minute, and they are in the time zone of the computer that runs FatRat. FatRat checks every 10 seconds and runs each minute once. A one-time action runs once and then counts as done. It stays in the list and never runs again, unless you edit its date and time, which arms it again. You can also delete it. The REST API shows this as the done field of the action.

When you delete a queue, FatRat deletes its scheduled actions too. Each action that runs is written to the global log, under "Scheduler". That log is the Log tab in the desktop window, and also in the web interface and the terminal client.

Setting up actions

Desktop

Choose Settings → Settings... and open the Scheduler page. It lists the actions by name. Use Add, Edit and Delete (Delete asks you to confirm).

The Scheduled action dialog has these fields:

Name: required.
When: Repeated action shows a list of weekdays with check boxes and a time. One time action shows a date and time field.
Queue.
Action: Resume all, Stop all or Set speed limit. The last one shows Download and Upload fields in KiB/s. They must be whole numbers.

The dialog asks for a name, and for at least one weekday on a repeated action, before it accepts the action.

Changes take effect when you click OK or Apply in the Settings dialog. Cancel discards them.

Web interface

Click Settings (or press O) and open the Scheduler page. It shows a table of the actions with their queue, action and schedule, and Edit and Delete buttons. Add action... opens the dialog. Add a queue first if there is none. The dialog has these fields:

Name, Queue and Action. For Set speed limit, the dialog also asks for a download and upload limit in kB/s. 0 means no limit.
Repeated or One time. A repeated action asks for a Time of day and the days Mon to Sun. A one-time action asks for a Date and time.

The times are in the server's time zone, not your browser's. Changes here are saved as soon as you click Save, or confirm a Delete, and Cancel on the Settings dialog does not undo them.

Terminal

Press O or F2 to open the settings, then choose the Scheduler page. Press A to add an action, Enter to edit the selected one and D to delete it. Times use 24-hour HH:mm, and a one-time date is yyyy-MM-dd HH:mm. Speed limits are in KB/s, and 0 means none. As in the web interface, changes are saved at once.

Where the actions are stored

The actions are saved in FatRat's configuration file, in the scheduler/actions section (~/.config/Dolezel/fatrat.conf on Linux). Because all three front ends talk to the same FatRat, they show the same list. An action added in one appears in the others.