README.md

# CollabVM1.ts
This is a drop-in replacement for the dying CollabVM 1.2.11. Currently in beta

## Compatibility

The CollabVM server is officially supported on modern Linux distributions, using latest NodeJS LTS and Rust

We do not support running directly on Microsoft Windows. If you want to run CollabVM on Windows, we recommend using the Windows Subsystem for Linux. We will close any issues related to running the server directly on windows.

## Dependencies

The CollabVM server requires the following to be installed on your server:

1. Node.js (obviously)
2. QEMU (Unless you just want to use a VNC Connection as your VM)
3. A Rust toolchain (e.g: [rustup](https://rustup.rs))
4. NASM assembler

### Installing dependencies on Arch

1. Install dependencies: `sudo pacman --needed --noconfirm -Sy nodejs nasm rust`
2. Enable corepack: `sudo corepack enable`

### Installing dependencies on Debian

TODO

## Running

**TODO**: These instructions are not finished for the refactor branch.

1. Copy config.example.toml to config.toml, and fill out fields
2. Install dependencies: `yarn`
3. Build it: `yarn build`
4. Run it: `yarn serve`
Add readme 2023-02-07 12:36:41 -05:00			`# CollabVM1.ts`
It's proven to be stable in production so we can move to beta 2023-02-09 16:01:26 -05:00			`This is a drop-in replacement for the dying CollabVM 1.2.11. Currently in beta`
Add readme 2023-02-07 12:36:41 -05:00
add dependencies to README, remove not-so-frequently-asked questions 2024-06-22 21:38:26 -04:00			`## Compatibility`

make compatibility more clear 2025-04-09 16:26:37 -04:00			`The CollabVM server is officially supported on modern Linux distributions, using latest NodeJS LTS and Rust`
add dependencies to README, remove not-so-frequently-asked questions 2024-06-22 21:38:26 -04:00
make compatibility more clear 2025-04-09 16:26:37 -04:00			`We do not support running directly on Microsoft Windows. If you want to run CollabVM on Windows, we recommend using the Windows Subsystem for Linux. We will close any issues related to running the server directly on windows.`
add dependencies to README, remove not-so-frequently-asked questions 2024-06-22 21:38:26 -04:00
			`## Dependencies`

			`The CollabVM server requires the following to be installed on your server:`

			`1. Node.js (obviously)`
			`2. QEMU (Unless you just want to use a VNC Connection as your VM)`
chore(README): cargo is usually a default part of a complete Rust toolchain so just specify "A Rust toolchain" 2024-06-22 21:46:37 -04:00			`3. A Rust toolchain (e.g: [rustup](https://rustup.rs))`
add dependencies to README, remove not-so-frequently-asked questions 2024-06-22 21:38:26 -04:00			`4. NASM assembler`

			`### Installing dependencies on Arch`

add --needed and -y flag to pacman command 2024-06-22 21:44:22 -04:00			1. Install dependencies: `sudo pacman --needed --noconfirm -Sy nodejs nasm rust`
add dependencies to README, remove not-so-frequently-asked questions 2024-06-22 21:38:26 -04:00			2. Enable corepack: `sudo corepack enable`

			`### Installing dependencies on Debian`

			`TODO`

Add readme 2023-02-07 12:36:41 -05:00			`## Running`
Giant refactoring (or at least the start) In short: - cvmts is now bundled/built via parcel and inside of a npm/yarn workspace with multiple nodejs projects - cvmts now uses the crusttest QEMU management and RFB library (or a fork, if you so prefer). - cvmts does NOT use node-canvas anymore, instead we opt for the same route crusttest took and just encode jpegs ourselves from the RFB provoded framebuffer via jpeg-turbo. this means funnily enough sharp is back for more for thumbnails, but actually seems to WORK this time - IPData is now managed in a very similar way to the original cvm 1.2 implementation where a central manager and reference count exist. tbh it wouldn't be that hard to implement multinode either, but for now, I'm not going to take much time on doing that. this refactor is still incomplete. please do not treat it as generally available while it's not on the default branch. if you want to use it (and report bugs or send fixes) feel free to, but while it may "just work" in certain situations it may be very broken in others. (yes, I know windows support is partially totaled by this; it's something that can and will be fixed) 2024-04-23 09:57:02 -04:00
			`TODO: These instructions are not finished for the refactor branch.`

Add readme 2023-02-07 12:36:41 -05:00			`1. Copy config.example.toml to config.toml, and fill out fields`
cvm-rs: merge guac and jpeg libs together into one doesn't really need to be two seperate libraries. also preperation for other funnies the build script has been replaced with a much saner justfile which uses much saner "yarn workspace" invocations instead of blindly cding all over the place 2024-06-22 21:14:05 -04:00			2. Install dependencies: `yarn`
			3. Build it: `yarn build`
			4. Run it: `yarn serve`