README
¶
A basic WebSocket server built for smaller projects and rapid prototyping. Run one command and have a Websocket server running in seconds. No need to spend time implementing your own server logic.
Installation
go install github.com/awoldt/gosocket@latest
Quick Start
Start the WebSocket server:
gosocket start
Configuration
All settings are passed as flags on the start command:
| Flag | Description | Default |
|---|---|---|
--port |
Port the server listens on | 8080 |
--allowed_origins |
Origins allowed to connect. Repeat the flag for multiple values. Omit to allow all. | (none) |
--read_buffer_size |
WebSocket read buffer size in bytes | 1024 |
--write_buffer_size |
WebSocket write buffer size in bytes | 1024 |
--auth_token |
Token required for client connections. Omit to disable auth. | (none) |
--logs |
Enables server-side logging | false |
Examples:
# Custom port with logging enabled
gosocket start --port 9000 --logs
# Restrict origins
gosocket start --port 8080 --allowed_origins localhost:3000 --allowed_origins localhost:5173
# Require authentication
gosocket start --port 8080 --auth_token my-secret-token
Connecting to Rooms
Clients connect to rooms via the URL path. The path becomes the room name:
// Connect to the "chat" room
ws://localhost:8080/chat
// Connect to the "notifications" room
ws://localhost:8080/notifications
// Connect with authentication token
ws://localhost:8080/chat?token=your-secret-token
Documentation
¶
There is no documentation for this package.
Source Files
Click to show internal directories.
Click to hide internal directories.