Home / Getting started
To be able to run Cyric you need:
A Cyric Server
A preconfigured switch (compatible with the Cyric server)
At least one Cyric Client USB
A UTP network cable
A personal computer (PC) that has at least one USB and/or USB-C port available
NOTE: You are also able to extend the Cyric environment with additional switches and USB pluggable hubs. You can find additional documentation here.
Start by downloading the Cyric USB Creator by clicking the button on the right.
The Cyric USB Creator is a utility that is able to create a bootable Cyric USB. This step is a necessity for using all functionalities that Cyric provides, which is explained in full detail later on.
To start creating a USB, following these steps:
Execute the downloaded utility.
Accept any prompts that might appear on your screen.
Insert a USB (of at least 8 GB).We recommend you to use a USB that has a warranty of 5 years. Brands like Kingston and SanDisk often offer these kind of warranties.
Select the inserted USB drive by clicking the radio button to the left of the drive.
Click Create USB to start creating your Cyric USB.
Your USB will be created. This process can take up to approximately 15 minutes. It is noteworthy that any image that is already present on the computer will be reused. When a newer image is available, that newer image will be downloaded and used.
IMPORTANT
Currently, the Cyric USB Creator only supports the Windows platform.
Any USB drive used with the Cyric USB creator will lose all of it's data!
Cyric is a application that is signed by Microsoft, therefore it is not required to disable the Secure Boot on your device.
To start Cyric, we need to open up the boot menu. Each brand has their own way of entering the boot menu. In the table below, you will see most common ways of opening the boot menu which varies per manufacturer:
ASUS
Hewlett-Packard (HP)
Lenovo
SONY
Toshiba
PEAQ
F8
Esc (followed by F9) or F9
F12
Assist-button or F10
F12
F2
MSI
Acer
Apple
Dell
Medion
Microsoft
Esc
F12
Option-button + N
F12
F2
Volume Up + Power-button
TIP: When you are not able to find the correct key to get into the boot menu, you can also try to switch the order of the boot devices. You can do this by entering the BIOS by pressing F2 or DEL. Here you should be able to make changes to the boot order.
Some devices (like Acer for example) include functionality to turn off the Boot Menu from within the BIOS.
When you managed to open up the boot menu, select your USB drive and press Enter.
You will be presented with a boot menu where each option has it's own use-case scenario. Usually, we are selecting the first option called: Start Cyric. This is the default option. There are some devices which aren't able to boot properly to the user interface of Cyric. This could be caused by hardware incompatibility and the Linux subsystem.
Start Cyric
The default boot option.
Troubleshooting (Only use when instructed)
It is advised not to use any of these troubleshooting options unless we explicitly tell you to.
Cyric - EFI with debug
Will enable visible on-screen logging, to troubleshoot errors and/or exceptions.
Cyric - nomodeset
Using this option will tell the Linux kernel to not load any video drivers.
Cyric - nomodeset and force VESA
Does exactly what "nomodeset" does and forces the usage of the VESA driver. This will drive most VESA-compatible video cards,
but only makes use of the basic standard VESA core that is common to these cards. The driver supports depths 8, 15 16 and 24.
Cyric - ACPI Windows compatible
This option mimizes the usage of ACPI (Advanced Configuration and Power Interface) to a level that it's still compatible with Windows.
Cyric - ACPI Disabled
This option completely disables the ACPI (Advanced Configuration and Power Interface).
Cyric Debug - UEFI
This option is meant for the developers and should not be used!
Cyric Debug - Emergency Shell
This option is meant for the developers and should not be used!
Before the user can interact with the user interface, Cyric needs to initialize and will get itself ready to be used.
When paying attention, you will see a serie of one or more of the following screens:
Waiting on a network connection with the Cyric server.
Retrieving server specific settings which needs to be applied to the client. These are things like the language or Cyric client version to use for example.
Check for any updates (or rollbacks).
Check if a device has already been created.
Cyric Client UI - Create device (version 4.2.1)
When Cyric has completely initialized, the user is presented a interface where a device can be created. Here you are able to specify the owner of the device, change the serial number, search for a specific model and/or select a model from the model list.
To select a model, follow these steps:
Enter the EAN number (preferably) or SKU number of a device in the model search input box.
The EAN number has 13 characters. In case it has 12, try adding a 0 (zero) in the front. (For example: "129945698701" will become "0129945698701")
Cyric will search for all possible matches, wait until the search is completed.
The list will be populated with all results.
Select a model from the list.
Whenever a device has already been created in the past, the user is able to select that same device or even create a new one. The device is recognized by a so called "fingerprint". This fingerprint is a collection of selected hardware components.
It is very important to use a existing device rather than creating a new one. You can do this by clicking the button right next to it: This is it!.
NOTE: When a device was already created and exists only once in our database, the steps above will not be shown; instead, you will be redirected to Cyric's Dashboard.
TIP: Using the same device has great benefits. Every action on the device will be stored as an event and will be attached to it's asset. When a event has been attached, you are able to view the results on the Melissan web portal by using the Quick Search bar.
Cyric Client UI - Dashboard (version 4.2.1)
Hooray! We arrived at Cyric's dashboard. The user is now able to perform specific actions that he/she would like to do with the device.
Go back to go in depth on the available modules that Cyric has to offer!