backend for xcvr appview
update README.md
+27
-1
+27
-1
README.md
+27
-1
README.md
···
1
-
# xcvr-backend
1
+
# xcvr-backend
2
+
a backend service that allows the dynamic creation of lrc servers. see it live at [xcvr.chat](http://xcvr.chat/)
3
+
4
+
this is just the backend, for a frontend, consider using [xcvr](https://github.com/rachel-mp4/xcvr/)
5
+
6
+
## how to run
7
+
```{bash}
8
+
$ cd server
9
+
$ go run ./cmd
10
+
```
11
+
12
+
## how to deploy
13
+
1. install nginx
14
+
2. copy xcvr.conf to /etc/nginx/conf.d/ (change the server_name directive to your domain name)
15
+
3. copy static files to /var/www/xcvr/ (if using xcvr for your frontend, then copy the contents of the dist directory generated by `npm run build` to the /var/www/xcvr/)
16
+
4. start nginx
17
+
5. run xcvr-backend
18
+
19
+
## endpoints
20
+
GET http://localhost:8080/xrpc/getChannels - gets a list of all active channels
21
+
22
+
POST http://localhost:8080/xrpc/initChannel - accepts json containing metadata about a channel and creates it
23
+
24
+
## servers
25
+
servers are served on ephemeral ports at ws://localhost:PORT/ws
26
+
27
+
in production, their ports are exposed as ws://xcvr.chat/PORT/ws, which gets proxied to ws://127.0.0.1:PORT/ws