amoinier / sockety

:link: A websocket client/server to access your personal network from outdoor :earth_africa:

Sockety (WIP)

If you want to do HTTP request in your personal network from outside without open port, you can use Sockety ! It provide a websocket connection between 2 apps (written in Typescript). One app in your personnal network (client), one app where you want (server).

Features

Because of usage of websocket, response body is limited to 1400 characters.

• Multiple client split by client ID.
• Return HTTP response from client if it respond under 1 sec.
• Ping client every 30 sec.

Usage

When your server and client is ready and client is connected to server, you just need to do a POST request on server: <SERVER_IP>:<SERVER_PORT>/sockety?client_id=<WEBSOCKET_CLIENTID>.

The body define request informations for the request sending by client:

client_id (string): If you want to set client_id in body, you can with this parameters.

url (string): Every url you want.

method (string): 'get' | 'GET' | 'delete' | 'DELETE' | 'head' | 'HEAD' | 'options' | 'OPTIONS' | 'post' | 'POST' | 'put' | 'PUT' | 'patch' | 'PATCH'.

headers (JSON): All HTTP headers you want.

body (JSON): Everything you want.

{
	"url": "https://example.com",
	"method": "GET",
	"headers": {
		"authorization": "Bearer XXXX",
		...
	},
	"body": {
		"login": "amoinier",
		...
	}
}

Server

It create a websocket server to send HTTP request at the client.

Build/Install

Go in server/ folder

cd server/

Development

Install npm packages

npm install

Run in development mode

npm run dev

Production

Install npm packages (production only)

npm install

Build app

npm run build

Run in production mode

npm start

Docker

Build docker image

docker build -t sockety_server .

Start docker image (need 2 env variables: HTTP_PORT, WEBSOCKET_PORT)

HTTP_PORT: HTTP Serveur port.

WEBSOCKET_PORT: Weboscket Serveur port.

docker run -p3000:3000 -p8000:8000 -e HTTP_PORT=3000 -e WEBSOCKET_PORT=8000 sockety_server

Client

It connect to the server in websocket and send request with server datas received.

Build/Install

Go in client/ folder

cd client/

Development

Install npm packages

npm install

Run in development mode

npm run dev

Production

Install npm packages (production only)

npm install

Build app

npm run build

Run in production mode

npm start

Docker

Build docker image

docker build -t sockety_client .

Start docker image (need 3 env variables: SERVER_IP, SERVER_PORT, WEBSOCKET_CLIENTID)

SERVER_IP: Serveur IP/address.

SERVER_PORT: Websocket port define in server startup.

WEBSOCKET_CLIENTID (optional): Define a client ID to "secure" your request. It's optional, without WEBSOCKET_CLIENTID, client create one and display it in logs.

docker run -e SERVER_IP=localhost -e SERVER_PORT=8000 -e WEBSOCKET_CLIENTID=qwertyuiop sockety_client