-
Notifications
You must be signed in to change notification settings - Fork 7
Admin Panel
The Administrator Panel will let you configure nearly everything in Collab VM. From here, you can delete, create, and add virtual machines, as well as remotely manage them and change many settings in the server configuration.
This page will document all the features found in the Admin Panel.
To access the Admin Panel, you can go to http://127.0.0.1:(collab-vm-server port)/admin/ (replace 127.0.0.1 with your IP address if needed). Note, depending on what port you start collab-vm-server on, you may need to edit the admin.min.js.
You will need the admin password to login. By default, this password is collabvm. It is recommended to change this immediately, since it is highly insecure (any password we put on here by default would be insecure, no matter the complexity).
Default value: 4 (per) 3
This is Collab VM Server's built in anti-spam feature. By default it allows 4 messages per 3 seconds, before muting for 30 seconds.
If you want to disable the anti-spam completely, set both values to 0.
Default value: 30 (second(s))
If a user spams above the set value for chat message rate messages, this will determine how long they are muted. For example, if you set this to 60, and a user spammed the set value for chat message rate messages, they would be unable to send any messages for 60 seconds (1 minute).
If you want to disable this, set the value to 0.
Default value: 5
To prevent users from racking up turns at a rapid rate ("turn-bombing"), the Collab VM Server has a built in feature which can deny users after they have a certain amount of connections open. For example, if you set this value to 1, users will only be able to have 1 connection per IP at a time, and if you set this to 3, users will only be able to have 3 connections per IP at a time.
If you want users to be able to have infinite connections, set the value to 0.
Default value: collabvm
This setting will change the administrator panel password. Click the checkbox, type in a password, and click Change Password. For example if you typed in "collabvm1234" as the password, and clicked Changed Password, the old password (collabvm) would no longer work, but collabvm1234 would work.
You CAN disable passwords, but it is extremely unrecommended to do so because it leaves your server and Collab VM very vulnerable.
This will start a VM. If the VM has already been started, this option will be disabled.
This will stop a VM. If the VM has already been stopped, this option will be disabled.
This will restart (not reset) a virtual machine. If the VM has been stopped, this option will be disabled.
This has several features, including;
If this is clicked, the VM will be reset to a clean state, provided that Hard Drive Snapshots are enabled.
If this is clicked, the VM will be shut down and restarted.
If this is clicked, the VM will be forcefully reset (system_reset).
This will allow you to change the settings of the current virtual machine.
This will allow you to create a new virtual machine.
Default value: 0
If this option is enabled, the virtual machine will automatically start when the Collab VM Server starts.
Default value: (none)
This option will determine the URL your VM will use. For example, if you made the URL Name collabvm1234, then users could access your VM directly by going to http://computernewb.com/collab-vm/view/collabvm1234
This cannot be blank by default.
Default value: (none)
This option will determine the display name that users will see on the VM list homepage. For example, if you made the Display Name "MS-DOS 6.22", when users go to http://computernewb.com/collab-vm/, they will see a VM titled "MS-DOS 6.22".
Names are optional, but you probably should have them anyway.
Default value: (address) 127.0.0.1 (port) 5900
This option will determine what the VNC Address will be used. It is highly unrecommended to change the VNC Address, but the VNC Port may need to be changed if you are already running a VNC Server on Port 5900 or you are hosting multiple virtual machines.
Default value: qemu
This option will determine which hypervisor (virtualization/emulation software) is to be used by the server. At this time, only QEMU is a supported hypervisor, but VMWare and Virtualbox will become available options.
Default value: (none)
This option will determine the QEMU Startup Command. Note, it is not necessary to add -no-shutdown, -vnc, etc. These parameters are automatically added by Collab VM Server.
Default value: off
Snapshot Mode will determine which mode of Snapshots you can use:
If the snapshot mode is turned off, any change made to the hard disk image will be permanent and saved. For instance, if a user created a file called "collabvm.txt" on the desktop, and you later turned on hard drive snapshots, that file would still be there. Vote resets, Restore After Shutdown, and timed interval resets will be disabled automatically in this mode. This is an unrecommended option.
If this option is selected, any changes made by to the hard disk image will not be saved, using the -snapshot parameter. For instance, if a user created a file called "collabvm.txt" on the desktop, and the virtual machine was later reset either by users or an admin, that file would no longer be there. Vote resets, Restore After Shutdown, and timed interval resets will work in this mode. This is the recommended option.
This feature is not included with the default admin panel; to enable it, you must recompile the Admin Panel Web App with it uncommented. The reason this is not included by default is due to high instability. If this feature is selected, instead of reloading the snapshot, it will execute the command "loadvm (snapshot name)" instead. For instance if your hard disk was named win7.img, it would execute the command loadvm win7. Vote resets, Restore After Shutdown, and timed interval resets will work in this mode. This is an unrecommended option.
Default value: 0
If this feature is enabled, whenever a user shuts down the virtual machine, it will be restored to a clean snapshot as if an admin reset it or a vote reset succeeded. Note: If the Snapshot Mode is set to "Off", this feature will be automatically disabled.
Default value: 0
This feature is not included with the default admin panel; To enable it, you must recompile the Admin Panel Web App with it uncommented. If this feature is enabled, the VM will automatically reset after the specified amount of time (measured in hours and minutes) that the administrator sets. You can disable this by either unchecking this feature or setting the "Restore Every" values to 0 hours and 0 minutes.
Default value: 0 (hours) 0 (minutes)
This feature is not included with the default admin panel; To enable it, you must recompile the Admin Panel Web App with it uncommented. This feature can be used to enable timed interval resets, similar to a feature that can be found and utilized in socket.io-computer. This will set a timer which will always reset the specified VM at a specific interval. For instance, if you set the interval to 0 hours 15 minutes, the VM will automatically reset after 15 minutes. Note: If the Snapshot Mode is set to "Off", this feature will be automatically disabled.
If this feature is enabled, users will be able to take a turn for whatever the specified value is. If this feature is disabled, users cannot take a turn at all. You can also disable turns by setting the Turn Time to 0 seconds.
Default value: 18 (seconds)
This will determine how long a user can control the virtual machine for. For instance, if you wanted users to be able to take turns for 14 seconds, you would set the value to 14. This feature does not apply to all VMs, for instance, VM #1 can be set to have turns at 14 seconds, while VM #2 can be set to have turns at 18 seconds, and VM #3 can be set to have turns disabled completely, etc.
Default value: 0
If this feature is enabled, users will be able to initiate a vote reset if the VM is damaged, broken, or otherwise rendered unusable. If this feature is disabled, users will not be able to reset the virtual machine, unless the "Restore After Shutdown" option has been enabled. If the vote results in a tie, the VM will reset. Note: If the Snapshot Mode is set to "Off", this feature will be automatically disabled.
Default value: 60
This value will determine how long users will have to vote Yes or No on the vote reset. For example, if you set this value to 120 seconds, users will have 120 seconds to cast their votes to reset the VM. You can make vote resets automatically win by setting the Vote Time to 0.
Default value: 120
This value will determine how long users will have to wait before voting to reset the virtual machine again. For example, if you set the value to 240, users would have to wait 240 seconds before another vote reset could be initiated. If you want to disable the cooldown completely, set this value to 0.
Default value: 0
NOTE: This requires the collab-vm-agent.dll extension to work.
The Collab VM Agent is an extension of the collab-vm-server, allowing users to upload executable and other files to the specified virtual machine. This can be primarily seen on the Virus Farm portion of the website (http://computernewb.com/farm/). This can be used to create a "Virus Farm" node. This is somewhat complicated to set up, as it requires not only a DLL file, but also an executable running in the startup. Note: The Collab VM Agent Loader only supports Windows at this time.
Default value: local
This will determine which socket type the agent uses. (Note: At this time, only Local is functional.)
Use Local Socket Type
Use TCP Socket Type
Default value: 0
This is an optional feature. If your VM has Virtio drivers installed, the Collab VM Agent can utilize them. Although the Collab VM Agent can work using normal serial ports, but uploads will be very slow. Virtio Serial Ports are much faster and can be installed very easily.
Default value: (none)
If TCP Socket Type is used, this field can be used to fill in the address that will be used.
Default value: (none)
If TCP Socket Type is used, this field can be used to fill in the port that will be used.
Default value: 0
If this feature is enabled, the VM will be reset if the collab-vm-agent cannot communicate with the server within a specified amount of time (5 seconds by default). If this feature is disabled, if the loader is killed, the only way to get it back is to reset or restart the VM.
**Default value: (none)
This feature is not included with the default admin panel; To enable it, you must recompile the Admin Panel Web App with it uncommented. This feature has not been fully added yet, so it will do nothing as of now, but when it is added, this will allow you to control how long the heartbeat will wait before terminating the loader and resetting the VM.
Default value: 0
If this feature is enabled, a button called "Upload File" will appear once the Loader has successfully communicated with the server. When clicked, a button allowing users to upload the file of their choice will be displayed. When a user uploads a file successfully, a message will be displayed in the chat "(x) uploaded (x.exe), ((x) bytes)". If this is disabled, even if the Loader has been loaded successfully, the upload will be rejected and the button will be hidden. You can also disable file uploading by setting the Max File Size to 0 bytes, or setting the Max Filename Length to 0.
Default value: 120 (seconds)
This feature, much like the vote reset cooldown, will make it so that users will have to wait a specified amount of time before being able to upload again. For example, if you set this value to 240, users would have to wait 240 seconds before being able to upload again. If you want users to be able to upload files with no cooldown time, set this value to 0.
Default value: 20971520 (bytes)
This feature will determine the maximum file size users may upload. For instance, if you set this value to 50971520, users would be able to upload files up to 50 MB in length.
Default value: 100 (characters)
This feature will determine the maximum filename length that users can upload. For instance, if you set this value to 150, users could upload a file name that had 150 characters in it. Note: Windows has a limit of 255 characters per filename, so it is unrecommended to set this value above 255.
Note: This option isn't visible when you are making a new VM.
The QEMU Monitor will allow you to send remote commands to the VM selected. All QEMU Monitor commands are supported, including commands like info block, info version, etc.