Skip to content
Snippets Groups Projects

Doc update with new USB device

Merged Doc update with new USB device
gabriel.dasilvam/nexus:master into master
Merged gabriel.dasilvam requested to merge gabriel.dasilvam/nexus:master into master
Compare
and
1 file
+ 34
− 33
Compare changes
  • Side-by-side
  • Inline
docs/client.md
+ 34
− 33
@@ -20,15 +20,15 @@ Two clients are available:
Both clients feature the same commands and they are available for multiples operating systems and processor architectures:
| Operating System | Architecture | Clients directory location |
|--- |--- |--- |
| Linux | x86-64/AMD64 | binaries/amd64/linux |
| Linux | Intel 32-bits | binaries/386/linux |
| Windows | x86-64/AMD64 | binaries/amd64/windows |
| Windows | Intel 32-bits | binaries/386/windows |
| OSX | x86-64/AMD64 | binaries/amd64/darwin |
| Linux | ARM64 | binaries/arm64/linux |
| Windows | ARM64 | binaries/arm64/windows |
| OSX | ARM64 | binaries/arm64/darwin |
| ---------------- | ------------- | -------------------------- |
| Linux | x86-64/AMD64 | binaries/amd64/linux |
| Linux | Intel 32-bits | binaries/386/linux |
| Windows | x86-64/AMD64 | binaries/amd64/windows |
| Windows | Intel 32-bits | binaries/386/windows |
| OSX | x86-64/AMD64 | binaries/amd64/darwin |
| Linux | ARM64 | binaries/arm64/linux |
| Windows | ARM64 | binaries/arm64/windows |
| OSX | ARM64 | binaries/arm64/darwin |
## Installing nexus-clients' dependency
@@ -74,21 +74,21 @@ On Mac, `remote-viewer` is part of the `virt-viewer` package from MacPorts that
The table below describes the basic public templates that are currently available. The numbers between parenthesis indicate the year and month of creation (also available in the detailed output of `tpllist -l <template ID>`).
| Template name | Description |
|--- |--- |
| Xubuntu 22.04 (2024.01) + dev env/unpriv user | Xubuntu 22.04 system (Ubuntu with XFCE desktop environment) |
| | + C dev tools (gcc, make, etc.), VScode IDE compiler |
| | + QEMU system hypervisor |
| | `nexus` user (`/home/nexus`) with sudo privileges (pwd `nexus`) |
| | `student` user (`/home/student`) without any privilege (no pwd) |
| Xubuntu 22.04 (2024.01) + dev env/unpriv user/pi-hole | Xubuntu 22.04 system (Ubuntu with XFCE desktop environment) |
| | + C dev tools (gcc, make, etc.), VScode IDE compiler |
| | + QEMU system hypervisor |
| Template name | Description |
| ----------------------------------------------------- | ------------------------------------------------------------------- |
| Xubuntu 22.04 (2024.01) + dev env/unpriv user | Xubuntu 22.04 system (Ubuntu with XFCE desktop environment) |
| | + C dev tools (gcc, make, etc.), VScode IDE compiler |
| | + QEMU system hypervisor |
| | `nexus` user (`/home/nexus`) with sudo privileges (pwd `nexus`) |
| | `student` user (`/home/student`) without any privilege (no pwd) |
| Xubuntu 22.04 (2024.01) + dev env/unpriv user/pi-hole | Xubuntu 22.04 system (Ubuntu with XFCE desktop environment) |
| | + C dev tools (gcc, make, etc.), VScode IDE compiler |
| | + QEMU system hypervisor |
| | + Pi-hole domain firewall (see [Domain firewall](#domain-firewall)) |
| | `nexus` user (`/home/nexus`) with sudo privileges (pwd `nexus`) |
| | `student` user (`/home/student`) without any privilege (no pwd) |
| Manjaro 21 xfce (2022.08) | Vanilla Manjaro 21 system with XFCE desktop environment |
| | `nexus` user (`/home/nexus`) with sudo privileges (pwd `nexus`) |
| | `nexus` user (`/home/nexus`) with sudo privileges (pwd `nexus`) |
| | `student` user (`/home/student`) without any privilege (no pwd) |
| Manjaro 21 xfce (2022.08) | Vanilla Manjaro 21 system with XFCE desktop environment |
| | `nexus` user (`/home/nexus`) with sudo privileges (pwd `nexus`) |
<!--
| Xubuntu 22.04 (2022.08) + dev env | Xubuntu 22.04 system (Ubuntu with XFCE desktop environment) |
@@ -255,21 +255,22 @@ Bus 003 Device 006: ID 046d:08e3 Logitech, Inc. C505 HD Webcam
### Vendor ID and product ID of USB devices of interest
| Device description | VID:PID |
|--- |--- |
| -------------------------------------------- | --------- |
| Altera USB-Blaster | 09fb:6001 |
| Atmel at91sam SAMBA bootloader | 03eb:6124 |
| Prolific Technology USB/serial | 067b:2303 |
| MyLab2 serial port | 0403:6015 |
| Digilent Analog Discovery 2 | 0403:6014 |
| NXP Semiconductors NXP CMSIS-DAP | 1fc9:001d |
| MyLab2 serial port | 0403:6015 |
| NXP Semiconductors LPC11U3x CMSIS-DAP v1.0.4 | 1fc9:0132 |
| Saleae Logic Pro 16 | 21a9:1006 |
| NXP Semiconductors NXP CMSIS-DAP | 1fc9:001d |
| Peak USB CAN | 0c72:000c |
| Prolific Technology USB/serial | 067b:2303 |
| Saleae Logic Pro 16 | 21a9:1006 |
| SanDisk Cruzer Blade USB key | 0781:5567 |
| Segger J-Link | 1366:0101 |
| USBest Technology USB key | 1307:0165 |
| Xilinx KV260 and KR260 JTAG and UART | 0403:6011 |
| Xilinx Nexys Video JTAG | 0403:6010 |
| Xilinx Nexys Video UART | 0403:6001 |
| USBest Technology USB key | 1307:0165 |
| SanDisk Cruzer Blade USB key | 0781:5567 |
## Tutorial: creating a live exam with nexush
@@ -686,15 +687,15 @@ Both clients can be configured to communicate with any nexus server. ISC has two
Here are the ip addresses, ports and certificates to use ISC's production and development nexus servers:
| Server | IP | Port | Certificate |
|--- |--- |--- |--- |
| ----------- | ------------- | ---- | -------------------------- |
| production | 10.136.26.127 | 1077 | ca-cert.isc-nexus-prod.pem |
| development | 10.136.26.125 | 1077 | ca-cert.isc-nexus-dev.pem |
Nexus clients use two environment variables to specify which nexus server to use and on which port, and which public certificate to use:
| Variable | Description |
|--- |--- |
| NEXUS_SERVER | server to use, using the syntax: `ip:port` |
| ------------ | ------------------------------------------------ |
| NEXUS_SERVER | server to use, using the syntax: `ip:port` |
| NEXUS_CERT | location (path) to the public certificate to use |
On Linux and Mac OSX, a simple and effective way is to store these variables in a `.env` file that is sourced before running the clients.