ShellHub Cloud • Documentation • Contributing • Getting Help

ShellHub is a modern SSH server for remotely accessing Linux devices via command line (using any SSH client) or web-based user interface, designed as an alternative to sshd. Think ShellHub as centralized SSH for the the edge and cloud computing.

• Native SSH support: Access any device behind the ShellHub centralized SSH server using standard tools such as OpenSSH Client , PuTTY and so on.
• SCP/SFTP support: Copy files from/to device using industry standard tools without 3rd party applications.
• Public-key authentication: Allow multiple users to log in as the same system user without having to share a single password between them, revoke a single users's access without revoking access by other users and make it easier for a single user to log in to many accounts without needing to manage many different passwords.
• Firewall rules: ShellHub provides flexible firewall for filtering SSH connections. It gives a fine-grained control over which SSH connections reach the devices.
• Audit logging: Every time a SSH connection is made to ShellHub a session is created and stored on the server for audit purposes.
• Session recording: All interactive SSH sessions are recorded, which includes all of the user activity that occurs during the session. Once recorded, it can be replayed via a built-in session player in the ShellHub Web UI.

To self-host ShellHub on your own servers and managing your own infrastructure (installation, maintenance, upgrades, backup and so on) follow our Self-Hosting Guide.

If you prefer to use the cloud hosted service where we manage everything for your ease and convenience, create a free account in ShellHub Cloud.

ShellHub is an open source project and we love to receive contributions from our community. If you would like to contribute, please read our contributing guide.

You are welcome to submit any questions, participate in discussions and request help with any issue in our Gitter Channel.

ShellHub is licensed under the Apache License, Version 2.0. See LICENSE for the full license text.

First of all, you'll need to generate required keys for the services:

$ make keygen

Set the environment to development:

$ echo "SHELLHUB_ENV=development" >> .env.override

Start the whole environment:

$ make start

Avoid to use docker-compose directly (unless you know what you're doing); instead use bin/docker-compose wrapper.

Wait for all services to be ready then create initial user by running:

$ ./bin/add-user <username> <password> <email>

Create a namespace for grouping devices and set user as owner:

$ TENANT_ID=00000000-0000-4000-0000-000000000000 ./bin/add-namespace <namespace> <owner>

Don't change the value of TENANT_ID, this value is hardcoded during agent initialization in development mode.

When you open ShellHub UI for the first time, be sure to accept pending device.

See the devscripts which can be useful for development.

ShellHub was created by O.S. Systems.

Thanks goes to these wonderful people (emoji key):

Luis Gustavo S. Barreto 💻	Otavio Salvador 💻	Leonardo da Rosa Silveira João 💻	Eduardo Kluwe Veiga 💻	Vagner Nornberg 💻	Fabio Berton 📦	Rafael Gomes 🚇
Mike 💻	inductor(Kohei) 🚇	Y.Horie 💻	Robinson D. S. Santos 💻	Lukas Bachschwell 📖 💻	Shawn 💻	brammp 💻
Sam McKelvie 💻	Henry Barreto 💻	Antony Rafael 💻	Gessé Carneiro 💻	Benoît Stahl 💻

This project follows the all-contributors specification. Contributions of any kind welcome!