Skip to content

Latest commit

 

History

History
132 lines (114 loc) · 4.04 KB

Installation.md

File metadata and controls

132 lines (114 loc) · 4.04 KB

Vortex Installation Guide

It is recommended that Vortex is isntalled in a dedicated Python virtual environment in order to ensure that all required dependecies are installed without affecting the rest of the system.

Installing Pre-requisites

In order to create a Python virtual environment, the virtualenv utility should be installed on the system.

Fedora

Use the following command to install virtualenv using official Fedora packages:

sudo dnf install python3-virtualenv

Ubuntu

Use the following commands to install virtualenv using official Ubuntu packages:

sudo apt-get update
sudo apt-get install python3-virtualenv

PIP

virtualenv can also be installed using PIP. To do this, use the following commands:

python -m pip install --user virtualenv

Cloning The Repository

To clone the Vortex emulator repository, use the following command:

git clone http://github.com/voidtrance/vortex <destination>/vortex

This clones the repository in the directory <destination>/vortex. From now on, VORTEX will be used to refer to that directory.

Creating The Virtual Environment

Create a new Python virtual environment using the following command:

cd VORTEX
make venv VENV=<destination>

where <destination> is the directory where you want your virtual environment to be setup. The command wil create the virtual environment and install all Vortex requirements in it.

From this point on VIRTDIR will be used to indicate the path to the virtual environment.

Building And Installing The Vortex Wheel

The Vortex emulator can be installed within the virtual environment by building it as a Python wheel package and installing that package in the virtual environment.

To build the Python wheel, use the following commands:

cd VORTEX
make wheel VENV=VIRTDIR

The above commands will build the package in VORTEX/dest/vortex-<VERSION>-<cpython>-<cpython>-linux_x86_64.whl where <VERSION> is the version of the Vortex emulator. <cpython> is the CPython version installed on your system.

Once the Python wheel has been build, install it with:

make install VENV=VIRTDIR

The next step before running the emulator is to activate the virtual environment. Note that the command below is for the Bash shell. The virtual environment will contain a matching script for other popular shells.

source VIRTDIR/bin/activate

Building And Installing The Kernel Module

The kernel module is distributed as source code in the src/kmod directory of the package. To build the module, go to that directory and run the following command:

make -C /lib/modules/$(uname -r)/build M=${PWD}

This will produce a file called vortex.ko.

If secure boot is enabled on your system, the module will need to be signed first before it is installed and loadable. On Fedora systems, the easiest way to do this is by using akmod. Here is the procedure (taken from https://blog.monosoul.dev/2022/05/17/automatically-sign-nvidia-kernel-module-in-fedora-36/).

  1. Install the required packages:
sudo dnf install kmodtool akmods mokutil openssl
  1. Generate a signing key (this may not be required):
sudo kmodgenca -a
  1. Initiate the key enrollment. This will require you to enter a password. The password will be needed later.
sudo mokutil --import /etc/pki/akmods/certs/public_key.der
  1. Reboot the system.
  2. On boot-up, the MOK manager will start and ask you to enroll the key that was added in step 3. Select "Enroll MOD", then "Continue", then "Yes" and enter the password from step 3, and finally, "OK" to reboot the system again.
  3. After the system has booted up, go to the directory where the vortex.ko kernel module is located and run the following command to sign the module. This command needs to be run as root:
/lib/modules/$(uname -r)/build/scripts/sign-file sha256 \
	/etc/pki/akmods/private/private_key.priv \
	/etc/pki/akmods/certs/public_key.der \
	vortex.ko
  1. Next, you can install the module. Again, this needs to be run as root.
make -C /lib/modules/$(uname -r)/build M=${PWD} module_install