s00500 / shellhub

:computer: ShellHub enables teams to easily access any Linux device behind firewall and NAT.

Centralized SSH for the edge and cloud computing.

ShellHub Hosted • 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.

A hosted version of ShellHub is available at https://shellhub.io/.

Getting started

To start using ShellHub, it is suggested that you follow the Getting started guide in the ShellHub documentation.

Contributing

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.

Getting Help

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

License

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

Development Environment Setup

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

$ ./bin/keygen

Set the environment to development:

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

Start the whole environment:

$ ./bin/docker-compose up

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:

$ TENANT_ID=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx ./bin/add-user <username> <password> <email>

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.

Authors

ShellHub was created by O.S. Systems.

Contributors ✨

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 💻

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