UserVM Handbook: Difference between revisions

← Older edit

UserVM Handbook (view source)

Revision as of 15:20, 11 June 2024

10 bytes added , 11 June

misnomer

VisualWikitext

Elijah

Bureaucrats, Check users, Interface administrators, Push subscription managers, Suppressors, Administrators

427

edits

Revision as of 14:43, 17 April 2024 (view source) Elijah (talk \| contribs) No edit summary ← Older edit		Latest revision as of 15:20, 11 June 2024 (view source) Elijah (talk \| contribs) (misnomer)
(One intermediate revision by the same user not shown)
Now, we can clone the CollabVM Server source code: {{code\| (collabvm) $ git clone https://github.com/computernewb/collabvm-1.2.ts.git /srv/collabvm/collabvm-1.2.ts --depth 1 (collabvm) $ cd /srv/collabvm/collabvm-1.2.ts }} <tr><td>host</td><td>Host IP for the server to bind to. 99% of the time this will be 127.0.0.1 on proxied instances and 0.0.0.0 on non-proxied (see below)</td></tr> <tr><td>port</td><td>Port for your server to bind to. This must be different for each VM you host, and cannot be the same as any other server running on your system (see the output of <code>ss -tuln</code> to see what ports are used)</td></tr> <tr><td>proxying</td><td>If your server will be behind a reverse proxy, usually Nginx. This isn't a requirement, however, we recommend you do so for things like ~~SSL~~TLS support, and minimizing the number of ports open on your server. This requires additional configuration of your web server. If you edit this, make sure to go back and update <code>host</code> accordingly</td></tr> <tr><td>proxyAllowedIps</td><td>IPs allowed to reverse proxy your server. Can be ignored if you're not using proxying mode. 99% of the time, this will just be 127.0.0.1</td></tr> <tr><td>qemuArgs</td><td>Command line to launch QEMU with. You'll have this from setting up your VM earlier. If you're not sure, check out the QEMU guides linked above</td></tr> </table> === Setting up reverse proxying (Optional) === '''This is REQUIRED for UserVM as, for technical reasons, only ~~SSL~~TLS-equipped WebSockets can be accepted''' We strongly recommend you proxy your UserVM behind Nginx, to provide additional security and allow things like ~~SSL~~TLS. It also makes your VM look a lot cleaner, allowing people to access it on your main HTTP(s) port and on a subdirectory, like <code>https://example.com/collab-vm/</code> rather than <code>http://example.com:6004</code>. Here's a brief description of how to set that up on the Nginx side. This assumes you already have your site set up with Nginx, and if not there are numerous guides for that around the internet. First, you'll want to save [https://computernewb.com/~elijah/wsproxy_params wsproxy_params] to your Nginx directory, which enables WebSocket proxying. Here's a one-liner to do that: