Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #67

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,41 @@ occurs, this program doesn't depend on any cryptographic libraries. It's
a simple, single-threaded, standalone C program. It uses `poll()` to
trap multiple clients at a time.

## Quick Usage

Change the default ssh port before doing this and restart the real ssh service to run on another port!

```
sudo nano /etc/ssh/sshd_config
# Change Port 22 to something else within valid range
sudo systemctl restart sshd.service

# for debian / ubuntu distros
sudo apt install git -y

# for arch distros
sudo pacman -S git

git clone https://github.com/skeeto/endlessh.git
cd endlessh
```
### Docker

```
sudo docker build .
sudo docker run -d --restart=always -p 22:2222 endlessh
```

### without Docker

```
sudo make install
sudo crontab -e
# insert:
@reboot sudo endlessh -p 22
# safe the file && sudo reboot
```

## Usage

Usage information is printed with `-h`.
Expand Down