37 lines
1.1 KiB
Markdown
37 lines
1.1 KiB
Markdown

|
|
# CollabVM1.ts
|
|
This is a drop-in replacement for the dying CollabVM 1.2.11. Currently in beta
|
|
|
|
## Compatibility
|
|
|
|
The CollabVM server will run on any Operating System that can run Node.JS and Rust. This means modern linux distributions and Windows versions.
|
|
|
|
We do not recommend or support running CollabVM Server on Windows due to very poor support for QEMU on that platform.
|
|
|
|
## 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. Rust and Cargo
|
|
4. NASM assembler
|
|
|
|
### Installing dependencies on Arch
|
|
|
|
1. Install dependencies: `sudo pacman --noconfirm -S nodejs npm 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`
|