Skip to content

Commit c849966

Browse files
committed
update documentation
1 parent 09aac11 commit c849966

1 file changed

Lines changed: 14 additions & 9 deletions

File tree

README.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -75,16 +75,20 @@ A lightweight WebSocket gateway for delivering real-time messages to players, wi
7575

7676
## Configuration (Flags)
7777

78-
* `-addr`HTTP server address (default `:8080`)
79-
* `-db` – Database driver (`sqlite` or `mysql`)
80-
* `-dsn` – Database DSN
78+
* `-addr`Server address (default `:8080`)
79+
* `-db` – Database driver (default `sqlite`)
80+
* `-dsn` – Database DSN (default `file:ws_tokens.db?cache=shared`)
8181
* `-origins` – Comma-separated allowed WS origins
82-
* `-max-conns` – Max WS connections per player
83-
* `-max-queued` – Max offline queued messages per player
84-
* `-offline-ttl` – Offline message TTL
85-
* `-rate-limit` – Messages per rate period per server token
86-
* `-rate-period` – Rate limit window
87-
* `-revalidate-period` – Token revalidation interval
82+
* `-log-file` – Path to log file
83+
* `-log-level` – Log level (default `info`)
84+
* `-pid-file` – Path to PID file
85+
* `-max-conns` – Max WS connections per player (default `5`)
86+
* `-max-queued` – Max offline queued messages per player (default `100`)
87+
* `-offline-ttl` – Offline message TTL (default `10s`)
88+
* `-rate-limit` – Messages per rate period per server token (default `10`)
89+
* `-rate-period` – Rate limit window (default `1s`)
90+
* `-revalidate-period` – Token revalidation interval (default `1m`)
91+
* `-daemon` – Run process as a daemon
8892

8993
## Database
9094

@@ -118,6 +122,7 @@ go build
118122
-db sqlite \
119123
-dsn file:ws_tokens.db?cache=shared
120124

125+
# or
121126
./ws-gateway \
122127
-db mysql \
123128
-dsn "root@/echoCTF"

0 commit comments

Comments
 (0)