shellhub

module
v0.3.0-rc.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 15, 2020 License: Apache-2.0

README

ShellHub ShellHub I love Free Software

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. It enables teams to easily access any Linux device behind firewall and NAT.

Screenshot

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

Start the whole environment:

$ docker-compose -f docker-compose.yml -f docker-compose.dev.yml up

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

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

Authors

ShellHub was created by O.S. Systems.

Directories

Path Synopsis
agent module
api module
cli module
connector module
gateway module
pkg
revdial
Package revdial implements a Dialer and Listener which work together to turn an accepted connection (for instance, a Hijacked HTTP request) into a Dialer which can then create net.Conns connecting back to the original dialer, which then gets a net.Listener accepting those conns.
Package revdial implements a Dialer and Listener which work together to turn an accepted connection (for instance, a Hijacked HTTP request) into a Dialer which can then create net.Conns connecting back to the original dialer, which then gets a net.Listener accepting those conns.
api/openapi Module
ssh module
tests module

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL