Labs: Difference between revisions

Latest revision as of 20:26, 13 December 2024

In this article, you'll learn:

How to use the BigID Labs Web SSH Client
How to connect to a BigID Lab via command line

BigID Labs include an SSH terminal, providing direct system access. By default, only the user who launched the system can access both the BigID UI and the SSH terminal. However, users with email addresses ending in @bigid.com can access any lab system.

Web SSH Client[edit]

The Web SSH Client allows users to access their lab instance conveniently through their browser. To use it, simply add .ssh after the instance number in your URL (e.g., 123-456.ssh). This provides a secure, browser-based terminal interface for interacting with the lab system.

The following custom scripts are available exclusively within the Web SSH Client. These commands enhance your interaction with the instance and provide additional functionality:

Managing User Access[edit]

BigID Labs provide two scripts for adding or removing user access. Note that the original system owner cannot be removed using these scripts. Users must have a valid BigID account to gain access.

To grant access to a specific email address, use the `grant` script. This will enable both SSH and BigID UI access for the user:

grant [email protected]

To revoke access for a specific email address, use the `remove` script. Keep in mind that this does not immediately terminate the user's active sessions. It may take up to an hour for all sessions to close:

remove [email protected]

Transferring Files[edit]

Download a file: Use the `download` script, specifying the filename to retrieve the file immediately:

download file.txt

Upload a file: Use the `upload` script to open an upload dialog. Choose the file to upload, which will be placed in the current directory:

upload

Updating Support Scripts[edit]

Support scripts for BigID Labs are updated only when the system is created. To manually update these scripts, run the `update` command. This ensures you have the latest tools and features:

update

@@ Line 1: / Line 1: @@
 {{Box/start}}
 In this article, you'll learn:
-* How to Use the BigID Labs SSH Terminal
+* How to use the BigID Labs Web SSH Client
+* How to connect to a BigID Lab via command line
 {{Box/end}}
-== SSH ==
-All BigID labs contain an SSH component. This allows you to access the terminal of the system. By default only the user who has spun up the system has access to the BigID UI and the SSH terminal. Users with emails ending in bigid.com can access any lab system. There are a few commands that allow you to interact with the machine beyond regular terminal commands.
+BigID Labs include an SSH terminal, providing direct system access. By default, only the user who launched the system can access both the BigID UI and the SSH terminal. However, users with email addresses ending in '''@bigid.com''' can access any lab system.
-=== Adding and Removing Access ===
+== Web SSH Client ==
-BigID labs come with two scripts to add and remove users from the system. The original owner of the machine cannot be removed with these scripts. These users will still need to have a BigID account to access the system.
+The Web SSH Client allows users to access their lab instance conveniently through their browser. To use it, simply add ''.ssh'' after the instance number in your URL (e.g., ''123-456.ssh''). This provides a secure, browser-based terminal interface for interacting with the lab system.
-The grant script allows you to grant an email address access to the system. This will grant both SSH and BigID UI access.
+The following custom scripts are available exclusively within the Web SSH Client. These commands enhance your interaction with the instance and provide additional functionality:
-<syntaxhighlight lang="BASH">grant [email protected]</syntaxhighlight>
+=== Managing User Access ===
-The remove script allows you to remove an email address that was previously granted access. Note that this will not kick the user out of active sessions. It may take up to an hour for all active sessions of the user to close.
+BigID Labs provide two scripts for adding or removing user access. Note that the original system owner cannot be removed using these scripts. Users must have a valid BigID account to gain access.
-<syntaxhighlight lang="BASH">remove test@bigid.com</syntaxhighlight>
+To grant access to a specific email address, use the `grant` script. This will enable both SSH and BigID UI access for the user:
-=== Uploading and Downloading Files ===
+<syntaxhighlight lang="bash">grant [email protected]</syntaxhighlight>
-Users can also upload and download files to their lab instances. The download script takes in a filename and will immediately download a file.
+To revoke access for a specific email address, use the `remove` script. Keep in mind that this does not immediately terminate the user's active sessions. It may take up to an hour for all sessions to close:
-<syntaxhighlight lang="shell">download file.txt</syntaxhighlight>
+<syntaxhighlight lang="bash">remove test@bigid.com</syntaxhighlight>
-The upload script will spawn an upload dialog for the user to choose a filename and file to upload. Note that this will upload the file to directory where the command was called.
+=== Transferring Files ===
-<syntaxhighlight lang="shell">upload</syntaxhighlight>
+* '''Download a file''': Use the `download` script, specifying the filename to retrieve the file immediately:
+<syntaxhighlight lang="bash">download file.txt</syntaxhighlight>
+* '''Upload a file''': Use the `upload` script to open an upload dialog. Choose the file to upload, which will be placed in the current directory:
+<syntaxhighlight lang="bash">upload</syntaxhighlight>
+=== Updating Support Scripts ===
+Support scripts for BigID Labs are updated only when the system is created. To manually update these scripts, run the `update` command. This ensures you have the latest tools and features:
+<syntaxhighlight lang="bash">update</syntaxhighlight>