Indexed by TopGit from live GitHub metadata: peers/peerjs-server has 4.7k stars, written primarily in TypeScript. Server for PeerJS
Snapshot summary built from the project's own GitHub metadata — there's no written TopGit review yet. The page will update automatically when a full review is published.
WHY NO REVIEW YET
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then — see the READ ME tab for the original README in full.
You can provide config object to PeerServer function or specify options for peerjs CLI.
CLI option
JS option
Description
Required
Default
--port, -p
port
Port to listen (number)
Yes
--key, -k
key
Connection key (string). Client must provide it to call API methods
No
"peerjs"
--path
path
Path (string). The server responds for requests to the root URL + path. E.g. Set the path to /myapp and run server on 9000 port via peerjs --port 9000 --path /myapp Then open http://127.0.0.1:9000/myapp - you should see a JSON reponse.
No
"/"
--proxied
proxied
Set true if PeerServer stays behind a reverse proxy (boolean)
No
false
--expire_timeout, -t
expire_timeout
The amount of time after which a message sent will expire, the sender will then receive a EXPIRE message (milliseconds).
No
5000
--alive_timeout
alive_timeout
Timeout for broken connection (milliseconds). If the server doesn't receive any data from client (includes pong messages), the client's connection will be destroyed.
No
60000
--concurrent_limit, -c
concurrent_limit
Maximum number of clients' connections to WebSocket server (number)
No
5000
--sslkey
sslkey
Path to SSL key (string)
No
--sslcert
sslcert
Path to SSL certificate (string)
No
--allow_discovery
allow_discovery
Allow to use GET /peers http API method to get an array of ids of all connected clients (boolean)
No
--cors
corsOptions
The CORS origins that can access this server
generateClientId
A function which generate random client IDs when calling /id API method (() => string)
Make sure to set the proxied option, otherwise IP based limiting will fail.
The option is passed verbatim to the
expressjs trust proxy setting
if it is truthy.
This will start a peerjs server on port 9000 exposed on port 9000 with key peerjs on path /myapp.
Open your browser with http://localhost:9000/myapp It should returns JSON with name, description and website fields. http://localhost:9000/myapp/peerjs/id - should returns a random string (random client id)
Running in Google App Engine
Google App Engine will create an HTTPS certificate for you automatically,
making this by far the easiest way to deploy PeerJS in the Google Cloud
Platform.
Create an app.yaml file to configure the GAE application.
runtime: nodejs
# Flex environment required for WebSocket support, which is required for PeerJS.
env: flex
# Limit resources to one instance, one CPU, very little memory or disk.
manual_scaling:
instances: 1
resources:
cpu: 1
memory_gb: 0.5
disk_size_gb: 0.5
Create server.js (which node will run by default for the start script):
The most recent commit recorded on peers/peerjs-server was 8 months ago, based on the GitHub push timestamp. The repository has 1.1k forks — one of the better signals of community interest.
How many stars does peers/peerjs-server have?
peers/peerjs-server has 4.7k GitHub stars — refresh the page for the live number, or check github.com/peers/peerjs-server. TopGit mirrors GitHub's count but does not claim minute-by-minute accuracy.
What language is peers/peerjs-server written in?
peers/peerjs-server is written primarily in TypeScript. GitHub's language field is based on the largest share of bytes in the default branch.
What license does peers/peerjs-server use?
peers/peerjs-server is released under the MIT license. Always verify the LICENSE file directly on GitHub for the authoritative terms — license strings can be edited out of sync with a project's actual stance.
What topics is peers/peerjs-server associated with?
GitHub's repository topics for peers/peerjs-server: "nodejs", "peerjs", "server", "signaling", "typescript", "webrtc". TopGit's editorial category is Backend.
Where can I see peers/peerjs-server in action?
The project maintains a homepage at https://peerjs.com. The README tab on this page also usually contains screenshots and a quickstart.
Where do I read more about peers/peerjs-server?
This TopGit page is a snapshot — the READ ME tab shows the project's own README content (links stripped, images preserved). The GitHub repository at github.com/peers/peerjs-server is the definitive source.
Read full README in the tab above.
Want a second opinion on peerjs-server?
Ask an AI that can read this page — one click and you get its take on peerjs-server.