CollabVM Server 3.0: Difference between revisions

From Computernewb Wiki
Jump to navigation Jump to search
m (rm)
No edit summary
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Ambox
| text = This article documents a '''future''' version of the CollabVM Server software.<br>It is not yet released, and you should use the [[CollabVM_Server_1.x_(TypeScript)|current, supported version]] instead.<br>
}}
{{Infobox product
{{Infobox product
| name = '''CollabVM Server 3.0'''
| name = '''CollabVM Server 3.0'''
| logo = [[File:Collabvmlogo.png|center]]
| logo = [[File:Collabvmlogo.png|center]]
| developer = [[Modeco80]], [[Dartz]]
| developer = [[Elijah|Elijah R]], [[Modeco80]]
| license = GNU Public License 3.0
| license = TBD
| archs = amd64, ARM
| archs = amd64, ARM64
| platforms = [[Microsoft Windows|Windows]], [[Linux]]
| platforms = [[Linux]], [[Microsoft Windows|Windows]]
| release = Unreleased
| release = Unreleased
| developed = 2024 - 2025 (present)
| predecessor = [[CollabVM Server 1.x (TypeScript)]]
}}
}}


'''CollabVM 3.0''', or '''collab-vm-server 3.0''', or '''[https://github.com/computernewb/collab3 Collab3]''', is an upcoming release of the CollabVM server that will replace [[CollabVM Server 1.x|1.2.11]] and [[CollabVM Server 2.0|2.0]]. On January 8th, 2022, a pre-release of 3.0 was uploaded to GitHub.
'''CollabVM 3.0''' is an upcoming release of the CollabVM server that will replace [[CollabVM_Server_1.x_(TypeScript)|CollabVM-TS]].

The server is being written in C# using .NET Core 8.0 (LTS). It uses ASP.NET Core as the webserver for the API and WebSocket protocol. It also uses a database (currently only MySQL-compatible) to store VM configuration, bans, and user data.

The webapp is written in TypeScript and is bundled with Parcel.


CollabVM 3 is currently in closed development and the source code is not publicly available.
The initial release, 3.0.0, is planned to be a remake of CollabVM Server 1.2.11 with (mostly) the same features, with new features built on this codebase and added into later versions.


== Requirements (planned) ==
== Requirements ==
* An operating system that supports .NET Core 8.0
* Linux Kernel 2.6 (4.19 or higher will be required for support.)
** Linux: glibc >= 2.23 or musl >= 1.2.2. These are the bare minimum requirements given by Microsoft and we recommend using a much newer distro.
* Windows Vista or higher (Windows 8.1/Server 2012 (R2?) or higher will be required for support.)
** Microsoft Windows 10 version 1607 or later
* >1 GB of RAM (for hosting VMs)
* >1 GB of disk space (for hosting VMs)
* >= 2 GB of RAM
* >= 16 GB of free disk space (for hosting VMs)
* MariaDB Server, or another MySQL-compatible database
* TurboJPEG
* libopus


== Features ==
== Features ==


* New protocol (This means Guacamole removed from 3.0)
* New protocol based on a REST API and protocol buffers (This means Guacamole remnants fully removed from 3.0)
* Account authentication via OpenID Connect
* Websocket-- replaced
* Unified ban database that allows you to ban by account or IP, and specify a duration and user-viewable reason
* (Possibly?) CloudFlare support
* VM Audio using Opus and WebCodecs
* Use CMake for build system
* Ultra-fast display rendering using WebCodecs, with a fallback to using Web Workers available.
* An internal HTTP server that doesn't suck
* Low-bandwidth, low-latency VM display streaming via h264
* Support for plugins
* Turns no longer expire if nobody else is waiting to take a turn
* Returned and improved admin panel with support for updating VM configuration live


[[Category:Documentation]]
[[Category:Documentation]]

Latest revision as of 07:31, 6 January 2025

CollabVM Server 3.0
Developer(s) Elijah R, Modeco80
License TBD
Platforms Linux, Windows
Architectures amd64, ARM64
Release date Unreleased
Predecessor CollabVM Server 1.x (TypeScript)
Development period 2024 - 2025 (present)

CollabVM 3.0 is an upcoming release of the CollabVM server that will replace CollabVM-TS.

The server is being written in C# using .NET Core 8.0 (LTS). It uses ASP.NET Core as the webserver for the API and WebSocket protocol. It also uses a database (currently only MySQL-compatible) to store VM configuration, bans, and user data.

The webapp is written in TypeScript and is bundled with Parcel.

CollabVM 3 is currently in closed development and the source code is not publicly available.

Requirements

  • An operating system that supports .NET Core 8.0
    • Linux: glibc >= 2.23 or musl >= 1.2.2. These are the bare minimum requirements given by Microsoft and we recommend using a much newer distro.
    • Microsoft Windows 10 version 1607 or later
  • >= 2 GB of RAM
  • >= 16 GB of free disk space (for hosting VMs)
  • MariaDB Server, or another MySQL-compatible database
  • TurboJPEG
  • libopus

Features

  • New protocol based on a REST API and protocol buffers (This means Guacamole remnants fully removed from 3.0)
  • Account authentication via OpenID Connect
  • Unified ban database that allows you to ban by account or IP, and specify a duration and user-viewable reason
  • VM Audio using Opus and WebCodecs
  • Ultra-fast display rendering using WebCodecs, with a fallback to using Web Workers available.
  • Low-bandwidth, low-latency VM display streaming via h264
  • Turns no longer expire if nobody else is waiting to take a turn
  • Returned and improved admin panel with support for updating VM configuration live