36 lines
1.1 KiB
Markdown
36 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 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`
|