DOCSEARCHbyAlgolia
Submit Docs

ShellHub Documentation

website·Indexed 33 days ago

https://docs.shellhub.io/

A platform to centralize and secure remote shell access to devices, servers, and containers. Documentation covers self-hosting (Community and Enterprise editions), system requirements, environment variable configuration, OpenAPI reference, SAML SSO, and native SSH/SCP/SFTP support.

Tokens
17.4K
Snippets
78
Records
171
Agent score
64%

What's inside ShellHub

  1. Overview of ShellHub remote management

    ShellHub is a central gateway designed for remotely accessing and managing Linux servers and devices. It enables users to connect to their infrastructure from any location with internet access via two primary methods: a standard SSH client or a web-based user interface.

  2. Overview of ShellHub HTTP Tunnels

    ShellHub HTTP tunnels provide secure, direct access to HTTP services running on devices with the ShellHub Agent. This eliminates the need for SSH local port forwarding or VPNs, allowing users to access web-based interfaces, remote APIs, or configuration panels directly from a browser. Connections are encrypted by ShellHub Cloud and ShellHub Enterprise, even if the underlying service on the device does not provide encryption.

    Requirements:

    • Availability: Only available in ShellHub Cloud and ShellHub Enterprise.
    • Agent Version: Requires ShellHub Agent version 0.18.3 or newer.

  3. Overview of ShellHub remote shell access

    ShellHub is a platform designed to centralize and secure remote shell access to devices, servers, and containers. It simplifies remote access across diverse networks, eliminating the need for complex VPN setups or direct public access. Key benefits include:

    • Centralized Authentication: Uses public key cryptography instead of password-based authentication to prevent brute-force attacks.
    • Access Management: Administrators can centrally manage public keys to grant or revoke access permissions.
    • Network Control: Supports the creation of detailed firewall rules to specify allowed or blocked IP addresses and users.

  4. Understand SAML authentication in ShellHub

    SAML (Security Assertion Markup Language) allows ShellHub to act as a Service Provider (SP) that leverages an external Identity Provider (IdP) for user authentication, enabling Single Sign-On (SSO).

    Key constraints and behaviors:

    • Enterprise Only: SAML authentication is available exclusively for enterprise customers.
    • Single IdP Limit: ShellHub supports integration with only one IdP at a time. If you switch to a different IdP, all SAML-authenticated users will automatically transition to the new provider.
    • Local Authentication: Administrators can choose to disable local authentication once SAML is enabled to force all users to authenticate via the IdP.

  5. Manage device access with ShellHub Firewall rules

    Firewall rules in ShellHub are security policies used to control connections to devices based on parameters and conditions. These rules can be applied globally, to specific devices using regular expressions, or via tags. Only members with administrative privileges can create and manage these rules. Rules can be toggled between enabled and disabled states without being deleted.

    Availability: This feature is only available in ShellHub Cloud and ShellHub Enterprise.

  6. Understand Multi-Factor Authentication (MFA) in ShellHub

    Multi-Factor Authentication (MFA) provides an additional security layer by requiring a time-based one-time password (TOTP) in addition to the account password during login.

    Availability: MFA is exclusively available on Cloud and Enterprise editions of ShellHub.

    Supported Providers: ShellHub supports any TOTP-compliant application, including Google Authenticator and 1Password.

  7. Monitor access with Audit logging and Session recording

    ShellHub tracks all SSH connections via audit logging, creating a stored session record for every connection. Additionally, all interactive SSH sessions are recorded and can be replayed using the built-in session player in the ShellHub Web UI for training, documentation, and security monitoring.

  8. Organize devices using Device tagging

    Users can assign tags to devices in ShellHub to categorize, organize, and filter them, improving operational efficiency in managing large sets of devices.

  9. Transfer files using SCP and SFTP

    ShellHub supports SCP and SFTP protocols, enabling secure file transfers to and from managed devices using industry-standard tools without the need for third-party applications.

  10. Choose between ShellHub Cloud and Self-Hosted deployment

    Depending on your infrastructure requirements, you can deploy ShellHub in two ways:

    1. ShellHub Cloud: The fastest way to start. It is a fully managed service that removes the need to provision servers or manage infrastructure.
    2. Self-Hosted (Community Edition): Allows you to run the ShellHub server on your own infrastructure for full control.

  12. Choose the appropriate ShellHub edition

    ShellHub is available in three editions based on hosting preferences and feature requirements:

    • Community Edition: An open-source, self-hosted version available on GitHub. It provides core features and is ideal for individual developers and small teams.
    • Enterprise Edition: A version for businesses that includes all Community features plus premium capabilities such as advanced security, advanced authentication, and advanced monitoring/auditing. It can be self-hosted or deployed on a fully managed dedicated server.
    • Cloud Edition: A SaaS offering based on the Enterprise Edition. It provides a fully managed experience with a pay-as-you-go pricing model, suitable for users who do not want to manage their own infrastructure.