Panel SSH - TCP Socket

Simple TCP connection for server command execution

Installation

Download .zip or .tar.gz file, you can see all release on this link

Example download with curl on Linux:

VERSION=v1.1.0
KERNEL=amd64
curl -LJ https://github.com/panelssh/tcp-socket/releases/download/${VERSION}/panelssh-tcp-socket-${VERSION}-linux-${KERNEL}.tar.gz | tar -xz -C /usr/bin

Usage

Environment Variables:

Key	Default	Description
HOST	0.0.0.0	Bind Host/IP Address
PORT	3000	Listening Port
SECRET_KEY	test	Secret key validation
ALLOWED_ADDRESS	% (any)	List IP Address (v4), separate by comma.

Example Command:

PORT=5555 SECRET_KEY=1234 panelssh-tcp-socket

Flag / Argument Options:

Flags / arguments will be replace environment variable

Flags/Args	Default	Description
-host	env HOST	Bind Host/IP Address
-port	env PORT	Listening Port
-secret-key	env SECRET_KEY	Secret key validation
-allowed-address	env ALLOWED_ADDRESS	List IP Address (v4), separate by comma.

Example Command:

panelssh-tcp-socket -allowed-address="192.168.0.2,192.168.0.3,192.168.0.4"

Autostart

You could manually run, but using a startup script is preferred.

Debian and other init.d based systems

curl -o /etc/init.d/tcp-socket https://raw.githubusercontent.com/panelssh/tcp-socket/main/scripts/tcp-socket.initd \
  && chmod +x /etc/init.d/tcp-socket

Edit the following lines according to your setup:

DAEMON_PATH="/usr/bin"
DAEMON="panelssh-tcp-socket"
RUNAS="root"
HOST="0.0.0.0"
PORT="3000"
SECRET_KEY="test"
ALLOWED_ADDRESS="%"

Start the service by running as root

service tcp-socket start

Add it to autostart by running as root

update-rc.d tcp-socket defaults

Arch Linux and other systemd based systems

curl -o /etc/systemd/system/tcp-socket.service https://raw.githubusercontent.com/panelssh/tcp-socket/main/scripts/tcp-socket.service \
  && chmod +x /etc/systemd/system/tcp-socket.service

Edit the following lines according to your setup:

User=root
ExecStart=/usr/bin/panelssh-tcp-socket -host="0.0.0.0" -port="3000" -secret-key="test" -allowed-address="%"

Start the service by running as root

systemctl start tcp-socket

Add it to autostart by running as root

systemctl enable tcp-socket

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.