Skip to content
Snippets Groups Projects
Commit c3980da7 authored by Florent Gluck's avatar Florent Gluck
Browse files

Updated README.md

parent 622452e0
No related branches found
No related tags found
No related merge requests found
......@@ -11,20 +11,17 @@ nexus-client is the client component of the Nexus project, a VDI (Virtual Deskto
The full project, **nexus_vdi**, is made of 2 software components:
1. **nexus-server**: the server program (backend) that runs on the server
- exposes a REST API to manage VMs and users
- Exposes a REST API to manage VMs and users
1. **nexus-client**: the end-user program or "user interface" to manage VMs and users
- uses REST messages to communicate with the server
- can be run anywhere (locally or remotely) as long as it can communicate with the server
- used by users to authentify themselves and then to start/stop/view their VMs
- 3 clients are provided:
- `nexus-client`: a CLI client to be used from a terminal - useful too automate operations
- `nexus-client-gui`: a GUI client featuring a native desktop interface - user-friendly version for most end-users
- `nexus-client-exam`: a GUI client used during live exams
## Viewer
All clients allow a user to view (*attach*) a VM's desktop.
They use `remote-viewer` to do so. Please note that `remote-viewer` is part of the [virt-viewer project](https://gitlab.com/virt-viewer/virt-viewer.git)
- It uses REST messages to communicate with the server
- It can be run anywhere (locally or remotely) as long as it can communicate with the server
- Users must use the client to authentify themselves and manage/use their VMs
- Currently, 2 clients are provided:
- `nexus-client`: a CLI client to be used from a terminal; it features bulk operations to automate operations such as creating/starting/stop/destroying many VMs at once (useful for live exams for instance)
- `nexus-client-exam`: a GUI client to be used during live exams
- A future client (`nexus-client-gui) featuring a GUI is in the work, but it's not ready yet
- All clients feature an "attach" function which lets users interact with their VM's desktop
- this feature requires `remote-viewer` which is part of the [virt-viewer project](https://gitlab.com/virt-viewer/virt-viewer.git)
## nexus-client
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment