kvnallsn/fabrial

A virtual machine tty daemon

Fabrial

A virtual machine health and status daemon
Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Troubleshooting
6. Contributing
7. License

About The Project

Fabrial is a virtual machine communication daemon supporting oathgate virtual machines. It provides a pseudo-terminal (PTY) bound to a vhost-vsock socket.

(back to top)

Built With

(back to top)

Getting Started

Fabrial is built using only the C stdlib targeting Linux. The only requirement is a C compiler.

Prerequisites

• GCC

  sudo apt install build-essential

Building

1. Clone the repo

   git clone https://github.com/kvnallsn/fabrial.git

2. Build the executables

   make

   The fabrial executable will be located in the bin/ folder.

Installation

The binary must be installed inside a virtual machine. For convenience, an OpenRC init script is provided in the dist/openrc directory.

(back to top)

Usage

Running fabrial is simple, it does not take any arguments (yet). Running this program outside a virtual machine is unsupported.

1. Start a virtual machine with a vhost-vsock device. For example, include the following arguments when starting a qemu virtual machine:

   qemu-system-x86_64 \
   -other-qemu-args... \
   -device vhost-vsock-pci,guest-cid=4

2. Inside the virtual machine, start the daemon

   ./bin/fabrial

Roadmap

• Add arguments for port and spawned program
• Add ability to "port forward" to locally-bound TCP/UDP sockets

See the open issues for a full list of proposed features (and known issues).

(back to top)

Troubleshooting

If using the OpenRC init script, stdout/stderr will be logged to /var/log/fabrial.log and /var/log/fabrial.err respectively.

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)