add dependencies to README, remove not-so-frequently-asked questions
This commit is contained in:
34
README.md
34
README.md
@@ -2,6 +2,30 @@
|
|||||||
# CollabVM1.ts
|
# CollabVM1.ts
|
||||||
This is a drop-in replacement for the dying CollabVM 1.2.11. Currently in beta
|
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
|
## Running
|
||||||
|
|
||||||
**TODO**: These instructions are not finished for the refactor branch.
|
**TODO**: These instructions are not finished for the refactor branch.
|
||||||
@@ -10,13 +34,3 @@ This is a drop-in replacement for the dying CollabVM 1.2.11. Currently in beta
|
|||||||
2. Install dependencies: `yarn`
|
2. Install dependencies: `yarn`
|
||||||
3. Build it: `yarn build`
|
3. Build it: `yarn build`
|
||||||
4. Run it: `yarn serve`
|
4. Run it: `yarn serve`
|
||||||
|
|
||||||
## 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.
|
|
||||||
|
|||||||
Reference in New Issue
Block a user