https://github.com/portellam/vfio-script
Install and uninstall a VFIO setup on a Linux machine. Choose between a dynamic, GRUB, or static setup.
https://github.com/portellam/vfio-script
automated bash bash-script debian grub libvirt-hooks pci-passthrough script ubuntu vfio vfio-passthrough vfio-pci vfio-setup virtualization
Last synced: about 1 year ago
JSON representation
Install and uninstall a VFIO setup on a Linux machine. Choose between a dynamic, GRUB, or static setup.
- Host: GitHub
- URL: https://github.com/portellam/vfio-script
- Owner: portellam
- License: gpl-3.0
- Created: 2024-10-30T14:44:24.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-03-29T03:22:57.000Z (about 1 year ago)
- Last Synced: 2025-03-29T04:23:41.289Z (about 1 year ago)
- Topics: automated, bash, bash-script, debian, grub, libvirt-hooks, pci-passthrough, script, ubuntu, vfio, vfio-passthrough, vfio-pci, vfio-setup, virtualization
- Homepage:
- Size: 12.7 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# VFIO Script
### Pre-Development
Install and uninstall a VFIO setup on a Linux machine. Choose between a dynamic, GRUB, or static setup.
#### View this repository on [Codeberg][01] or [GitHub][02].
[01]: https://codeberg.org/portellam/vfio-script
[02]: https://github.com/portellam/vfio-script
##
## Table of Contents
- [1. Related Projects](#1-related-projects)
- [2. Documentation](#2-documentation)
- [3. Download](#3-download)
- [4. Contact](#4-contact)
- [5. References](#5-references)
- [6. Planned Features](#6-planned-features)
## Contents
### 1. Related Projects
To view other relevant projects, visit [Codeberg][11]
or [GitHub][12].
[11]: https://codeberg.org/portellam/vfio-collection
[12]: https://github.com/portellam/vfio-collection
### 2. Documentation
- What is VFIO?[[2]](#2)
- VFIO Discussion and Support[[3]](#3)
- Hardware-Passthrough Guide[[1]](#1)
- Virtual Machine XML Format Guide[[4]](#4)
### 3. Download
- Download the Latest Release: [Codeberg][31] or [GitHub][32].
- Download the `.zip` file:
1. Viewing from the top of the repository's (current) webpage, click the
drop-down icon:
- `···` on Codeberg.
- `<> Code ` on GitHub.
2. Click `Download ZIP` and save.
3. Open the `.zip` file, then extract its contents.
- Clone the repository:
1. Open a Command Line Interface (CLI) or Terminal.
- Open a console emulator (for Debian systems: Konsole).
- **Linux only:** Open an existing console: press `CTRL` + `ALT` + `F2`,
`F3`, `F4`, `F5`, or `F6`.
- **To return to the desktop,** press `CTRL` + `ALT` + `F7`.
- `F1` is reserved for debug output of the Linux kernel.
- `F7` is reserved for video output of the desktop environment.
- `F8` and above are unused.
2. Change your directory to your home folder or anywhere safe:
- `cd ~`
3. Clone the repository:
- `git clone https://www.codeberg.org/portellam/vfio-script`
- `git clone https://www.github.com/portellam/vfio-script`
[31]: https://codeberg.org/portellam/vfio-script/releases/latest
[32]: https://github.com/portellam/vfio-script/releases/latest
### 4. Contact
Did you encounter a bug? Do you need help? Please visit the
**Issues page** ([Codeberg][41], [GitHub][42]).
[41]: https://codeberg.org/portellam/vfio-script/issues
[42]: https://github.com/portellam/vfio-script/issues
### 5. References
#### 1.
**PCI passthrough via OVMF**. ArchWiki. Accessed June 14, 2024.
https://wiki.archlinux.org/title/PCI_passthrough_via_OVMF.
#### 2.
**VFIO - ‘Virtual Function I/O’ - The Linux Kernel Documentation**.
The linux kernel. Accessed June 14, 2024.
https://www.kernel.org/doc/html/latest/driver-api/vfio.html.
#### 3.
**VFIO Discussion and Support**. Reddit. Accessed June 14, 2024.
https://www.reddit.com/r/VFIO/.
#### 4.
**XML Design Format** GitHub - libvirt/libvirt. Accessed June 18, 2024.
https://github.com/libvirt/libvirt/blob/master/docs/formatdomain.rst.
### 5. Planned Features
- Isolate and migrate VFIO setup from [Deploy VFIO](https://github.com/portellam/deploy-VFIO) and place here.
- Implement a dynamic/hooks based VFIO setup.
##
#### Click [here](#vfio-script) to return to the top of this document.