https://github.com/keivan-sf/microrizz

A simple proxy protocol meant to be used on cheaper services
https://github.com/keivan-sf/microrizz

Last synced: about 1 month ago
JSON representation

A simple proxy protocol meant to be used on cheaper services

• Host: GitHub
• URL: https://github.com/keivan-sf/microrizz
• Owner: Keivan-sf
• Created: 2024-02-04T13:51:54.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-08-19T08:13:56.000Z (5 months ago)
• Last Synced: 2024-10-14T08:35:41.842Z (3 months ago)
• Language: TypeScript
• Homepage:
• Size: 139 KB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Micro rizz

A proxy protocol meant to be implemented on cheaper, application specific, hosts

## How to use

### Server

You need a NodeJs server to run this proxy.

- Navigate to `node-server` directory and install dependencies with `pnpm i`

- Then start the server with `PORT` environment variable (default is 3000) using `pnpm start`.

### Client

You need NodeJs on your client machine

Navigate to `client` directory and expose a local proxy server like below:

```

pnpm start:dev -- run wss://your_remote_host:your_remote_port --username admin --password adminpw --socks-port 4080

```

- Notice you need to change `wss` to `ws` if your remote server doesn't have SSL

- Replace `your_remote_host` and `your_remote_port` with your actual server details

- Socks port is denoting the local socks5 port that would be exposed to your machine after this command

- Your proxy should be available at `socks5://127.0.0.1:4080`

### Todo

- Support more languages as server

- Fix server username password authentication

- Support custom server username password specification