Labs: Difference between revisions

From BigID Developer Portal
No edit summary
 
(8 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Box/start}}
{{Box/start}}
In this article, you'll learn:
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}}
{{Box/end}}


== SSH Access ==


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. Additionally, several custom commands are available to interact with the machine beyond standard terminal functions.
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 ==
 
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 ===
=== Managing User Access ===
Line 22: Line 28:
=== Transferring Files ===
=== Transferring Files ===


You can upload and download files to and from your lab instance using the following commands:
* '''Download a file''': Use the `download` script, specifying the filename to retrieve the file immediately:
 
'''Download a file''': Use the `download` script, specifying the filename to retrieve the file immediately.


<syntaxhighlight lang="bash">download file.txt</syntaxhighlight>
<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:
* '''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>
<syntaxhighlight lang="bash">upload</syntaxhighlight>

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:

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:

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