cthrace/collabvm-1.2.ts
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #21 from computernewb/crusttest-refactoring

Browse Source 
merge refactor branch
This commit is contained in:
Elijah R
2024-07-30 14:18:11 -04:00
committed by GitHub
parent 2e17a11426 432e75d42a
commit df76345cdc
61 changed files with 7618 additions and 2024 deletions
Download Patch File Download Diff File Expand all files Collapse all files

45
README.md
View File

@@ -1,18 +1,35 @@
# CollabVM1.ts
This is a drop-in replacement for the dying CollabVM 1.2.11. Currently in beta
## Running
1. Copy config.example.toml to config.toml, and fill out fields
2. Install dependencies: `npm i`
3. Build it: `npm run build`
4. Run it: `npm run serve`
## Compatibility
## FAQ
### When I try to access the admin panel, the server crashes!
The server does not support the admin panel. Instead, there is a configuration file you can edit named config.toml.
### Why only QEMU? Why not VMWare, VirtualBox, etc.?
This server was written very quickly to replace CollabVM Server 1.2.11, and so only QEMU support exists. There are plans to support VMWare when CollabVM Server 3 releases.
### What platforms can this be run on?
If it can run a relatively new version of Node and QEMU, then you can run this. This means modern Linux distributions, modern macOS versions and Windows 10 and above.
### When the VM shuts off, instead of restarting, it freezes.
This has been fixed already, you are running a copy of the code before February 11th, 2023.
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. 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`