https://github.com/whatsapp-proxy/whatsapp-proxy-backend

WhatsApp Proxy backend server
https://github.com/whatsapp-proxy/whatsapp-proxy-backend

backend expressjs list proxy whatsapp

Last synced: 2 months ago
JSON representation

WhatsApp Proxy backend server

• Host: GitHub
• URL: https://github.com/whatsapp-proxy/whatsapp-proxy-backend
• Owner: WhatsApp-Proxy
• Created: 2023-01-10T12:20:10.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-04-29T19:51:57.000Z (9 months ago)
• Last Synced: 2024-04-29T20:59:53.044Z (9 months ago)
• Topics: backend, expressjs, list, proxy, whatsapp
• Language: TypeScript
• Homepage:
• Size: 257 KB
• Stars: 2
• Watchers: 1
• Forks: 1
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# WhatsApp Proxy Backend

WhatsApp Proxy Backend | Keeps track of all the proxy servers

## Routes

- GET: `/server` - Returns a 200 OK response, list with all registered servers

- GET: `/server/:id` - Returns a 200 OK response, more info about a server

- POST: `/server/register`- Data:

```json

{

	 "ipAddress": "IP",

  "proxyPort": port,

  "discoveryPort": DiscoveryServerPort,

  "serverName": "Name",

  "country": "Country Code",

  "key": "Your discovery key (from .env or custom key)"

}

```

- POST: `/key/register` - Data:

```json

{

	"masterKey": "MASTER KEY from .env",

	"key": "NEW KEY",

	"maxUsages": Max Usages,

	"serverNamePrefix": "PREFIX, nullable",

	"isActive": true

}

```

## How to run

- Copy `.env.example` to `.env`

- Fill in the required values

- Configure the port in the `docker-compose.yml` file if needed. (If you want to run the server on port 90 for example use the following value: `90:8080`)

- Run `docker-compose up -d` to start the server

## Migrations

- Run `yarn migrate` to run migrations