HomeConsoleGitHub

Shell

Overview

Shell provides a fully-featured, in-browser terminal integrated with the pre-installed and authorized Apolo CLI. For more information about the Shell app, as well as detailed instruction of how to use it in Apolo Console, visit the main Shell application page.

Managing application via Apolo CLI

Shell can be installed on Apolo either via the CLI or the Web Console. Below are the detailed instructions for installing using Apolo CLI.

Install via Apolo CLI

Step 1 — Use the CLI command to get the application configuration file template:

apolo app-template get shell > shell.yaml

Step 2 — Fill in the application parameters. Here is an example config file with some of those parameters:

# Example of shell.yaml
template_name: shell
template_version: v25.5.1
display_name: myshell
input:
  networking:
    http_auth: true
  preset:
    name: cpu-micro

Configuration inputs explained:

  1. preset.name: Specifies the resource preset for the underlying web server, e.g., cpu-micro.

  2. networking.http_auth: Enables HTTP authentication. Only authorized users will be able to access the application's web server.

Step 3 — Install the application into your Apolo project:

Monitor the application status transitions via CLI:

If you want to see logs of the application, use:

Step 4 — To uninstall the application via CLI, use:

References

PreviousOpenWebUINextPostgreSQL

Last updated

Was this helpful?