Time limits and idle timeouts
Learn how to configure track time limits and idle timeouts
Every Instruqt track has two parameters that cause a user's session to expire: a track time limit and an idle timeout. The track time limit is required and restricts how long a user can interact with your track. The idle timeout is optional and determines how long a user can be away from the track (in a different window, etc.) before their session expires.
There are two ways to configure a track time limit:
- Within the Track details page (recommended method).
- Using the Instruqt CLI and configuring the
timelimit
parameter.
You can configure a track time limit using the Instruqt web UI or CLI:
Web UI
Instruqt CLI
- 1.Select the track you wish to modify the time limit of.
- 2.In the Settings section, click Edit.
- 3.In the Time limit field, enter the desired value in minutes.
- 4.Click Save.
- 1.If you have not already done so, pull the track you wish to modify the time limit of:instruqt track pull <track-slug>
- 2.Open the
track.yml
file and add atimelimit
parameter.timelimit: <value-in-seconds>As an example, the file might look like the following:slug: example-trackid: xnlauwy2zewftitle: Example Trackteaser: Get started with Ubuntu!owner: instruqt-demosdevelopers:checksum: "8581508520951790619"timelimit: 3600 - 3.From within the track directory, push the update to Instruqt:instruqt track push
You can allow users to increase their time limit themselves. When enabled, a prompt will appear when a track reaches its limit, allowing users to add more minutes. The maximum amount of extra time that users can add is customized for each track.
You can allow users to extend the time limit using the Instruqt web UI or CLI:
Web UI
Instruqt CLI
- 1.Select the track you wish to allow users to extend the time limit for.
- 2.In the Settings section, click Edit.
- 3.Click Additional settings.
- 4.Scroll down to Allow users to extend their session, toggle it on, and input the desired value in minutes.
- 5.Click Save.
- 1.If you have not already done so, pull the track you wish to modify the extend ttl of:instruqt track pull <track-slug>
- 2.Open the
track.yml
file and add anextend_ttl
parameter.extend_ttl: <value-in-seconds>As an example, the file might look like the following:slug: example-trackid: xnlauwy2zewftitle: Example Trackteaser: Get started with Ubuntu!owner: instruqt-demosdevelopers:checksum: "8581508520951790619"timelimit: 3600extend_ttl: 600idle_timeout: 300 - 3.From within the track directory, push the update to Instruqt:instruqt track push
There are two ways to configure a track's idle timeout:
- Within the Track details page.
- Using the Instruqt CLI and configuring the
idle_timeout
parameter.
You can configure a track's idle timeout using the Instruqt web UI or CLI:
Web UI
Instruqt CLI
- 1.Select the track you wish to modify the idle timeout of.
- 2.In the Settings section, click Edit.
- 3.Click Additional settings.
- 4.Scroll down to Time out idle users, toggle it on, and input the desired value in minutes.
- 5.Click Save.
- 1.If you have not already done so, pull the track you wish to modify the idle timeout of:instruqt track pull <track-slug>
- 2.Open the
track.yml
file and add aidle_timeout
parameter.idle_timeout: <value-in-seconds>As an example, the file might look like the following:slug: example-trackid: xnlauwy2zewftitle: Example Trackteaser: Get started with Ubuntu!owner: instruqt-demosdevelopers:checksum: "8581508520951790619"timelimit: 3600idle_timeout: 300 - 3.From within the track directory, push the update to Instruqt:instruqt track push
Last modified 2mo ago