Skip to content

Sync with main - 3d77057 - 2026-05-12T13:52:58+00:00 #39

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
juno-ci wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Sync with main - 3d77057 - 2026-05-12T13:52:58+00:00 #39

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3d77057
164-add-auto-shutdown-detail-to-docs (#165)
juno-ci[bot] May 12, 2026
3947e5b
pr commit
May 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/assets/autoshutdown.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/shutdown-api.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/shutdown_env.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
24 changes: 12 additions & 12 deletions docs/deploy-usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,18 @@

Environment variables are used to configure the Helios container. The following environment variables are available:

| Name | Value | Required |
|-------------------|--------------------------------------------------------------------------------------------------------------------------------------|----------|
| USER | Name of the user | X |
| UID | POSIX compliant uid for the user | X |
| GID | POSIX compliant gid for the user | |
| PASSWORD | Password set for the user | |
| IDLE_TIME | Trigger the idle hook after x time | |
| DISABLE_VGL | Disable VirtualGL Wrapper around the entire desktop session. You will need to manually run applications that require it via `vglrun` | |
| DESKTOP_FILES | Paths separated by `:`. For example, `/some/path/1/*.desktop:/some/*/2/*.desktop` | |
| PREFIX | Prefix for URL for use behind a reverse proxy | |
| SELKIES_FRAMERATE | Set framerate as a range (e.g., `15-60`) or a fixed value (e.g., `30`) | |
| SUDO | Grant `SUDO` to the user on the container | |
| Name | Value | Required |
|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|
| USER | Name of the user | X |
| UID | POSIX compliant uid for the user | X |
| GID | POSIX compliant gid for the user | |
| PASSWORD | Password set for the user | |
| IDLE_TIME | Trigger the idle hook after x minutes (only required when the [auto shutdown plugin](https://github.com/juno-fx/Terra-Official-Plugins/tree/main/plugins/helios-auto-shutdown) is installed) | |
| DISABLE_VGL | Disable VirtualGL Wrapper around the entire desktop session. You will need to manually run applications that require it via `vglrun` | |
| DESKTOP_FILES | Paths separated by `:`. For example, `/some/path/1/*.desktop:/some/*/2/*.desktop` | |
| PREFIX | Prefix for URL for use behind a reverse proxy | |
| SELKIES_FRAMERATE | Set framerate as a range (e.g., `15-60`) or a fixed value (e.g., `30`) | |
| SUDO | Grant `SUDO` to the user on the container | |


When using the Orion Platform, you can configure them in the [Templates](https://juno-fx.github.io/Orion-Documentation/genesis/workstations/)
Expand Down
27 changes: 27 additions & 0 deletions docs/plugins-autoshutdown.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Auto shutdown plugin

Juno supplies an official [Terra](https://juno-fx.github.io/Orion-Documentation/latest/terra/intro/) plugin for automatically shutting down idle workstations after a configurable amount of time.

## Install the plugin

The [plugin](https://github.com/juno-fx/Terra-Official-Plugins/tree/main/plugins/helios-auto-shutdown) can be installed from the official Terra repository. The plugin itself requires no configuration other than which project to enable it in.

![shutdown plugin image](./assets/autoshutdown.png)

## Setup the workload

In order for the workstations to shutdown we need to configure two settings on the Helios workload.

### IDLE_TIME environment variable

On the Helios workload configuration screen you are given the option to add `env variables`. Add one with the name `IDLE_TIME` configured to the amount of **minutes** you would like to wait before an idle workstation is shutdown. For example set this to `60` to shutdown after an hour.

![environment setup](./assets/shutdown_env.png)

### Enable API access within the workstation

In order for the workstation to be gracefully shutdown we need to allow the workstation to access the shutdown API endpoint. This is handled automatically and securely, all you need to do is set the setting `enableAPI` to `True` in the workload configuration window.

![enableAPI setting](./assets/shutdown-api.png)

Thats it! Your idle workstations will now automatically shutdown as per your configured time.
2 changes: 2 additions & 0 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,8 @@ nav:
- deploy-k8s.md
- Persistence:
- deploy-session.md
- Plugins:
- plugins-autoshutdown.md
- Building Workstations:
- getting-started.md
- Customization:
Expand Down