Getting Started with Websh

Prerequisites

To use Websh to connect to a remote server, the following conditions must be met:

• The target remote server must be registered in Alpacon.
  • You can register servers via the Server page, and you must execute the generated installation script on the remote server to install the Alpamon agent.
• The server’s Status on the Server page must be Connected.

Creating a Session and Connecting to a Server

1. Click the New session button at the top right of the Websh page.
2. In the server selection modal, find the target server and click either Websh or Websh as root.
3. A new session will be created, and a new browser tab will open with the terminal.
4. Once the shell prompt appears, you can begin executing commands on the remote server.

Ending a Session

To terminate an active session, use one of the following options:

• Click the End session button on the session card in the Websh main page
• Click the Close button in the top-right corner of the terminal tab

Reconnecting to a Session

If a session is unexpectedly disconnected, you can reconnect and resume your previous work.

Common scenarios where a session may be disconnected:

• Browser is closed
• Terminal tab is accidentally closed
• Page is refreshed (F5)

How to Reconnect

1. On the Websh page, click the Reconnect button on the session card.
2. A new tab will open and reconnect to the existing session.
3. Once the shell prompt appears, you can resume using the terminal as before.

Session Sharing

Websh allows you to securely share a session with other users.
The session owner (sharer) can either manually share the session or send invitation emails to collaborators.
The invited user will access the session according to the defined permission level.

There are two sharing methods:

▸ Method 1: Share via URL and Password

▸ Sharer

1. Click the Share icon (arrow) on the session card or in the top-right corner of the terminal screen.
2. In the Share session modal, configure the following:
   • Toggle Read-only mode if you want the invitee to view the session without executing commands.
3. Click the Generate share info manually button.
4. Copy the generated Share URL and Password, and send them to the invitee.

⚠️ The share info is displayed only once and is not stored.
The session share is valid for 30 minutes, after which you must generate a new one.

▸ Invitee

1. Open the received Share URL in a browser.
2. Enter the provided Password to authenticate.
3. After successful login, a terminal will launch with real-time access to the session.
4. If Read-only mode is enabled, the invitee will be able to view but not execute commands.

▸ Method 2: Share via Email Invitation

▸ Sharer

1. Click the Share icon on the session card or terminal screen.
2. In the modal, select the Email invitation method.
3. Enter the email address(es) of the users you want to invite (multiple emails allowed).
4. Click the Invite button to send the session invite via email.

The invitation email includes both the Share URL and Password.
The recipient can use this information to access the session.

▸ Invitee

1. Open the Share URL from the received email in a browser.
2. Enter the Password provided in the email to access the session.
3. Depending on the sharer's permission settings, the invitee will join with either full or read-only access.