Gloire

Gloire is an OS built with the Ironclad kernel and using GNU tools for the userland, along with some original applications like util-ironclad. This repository holds scripts and tools to build the OS from the ground up on a Linux-based system.

Gloire is named after the french ironclad, which was the first ocean-going vessel of its kind.

Gloire running the JWM window manager, a terminal emulator, xeyes, and a game Gloire generating an RSA key and running neofetch in its fallback shell.

Downloading

One can grab a pre-built Gloire image here.

Running

On virtual machines

One can run either the downloaded disk image (uncompressing it first) or a built image with an emulator like QEMU, for using QEMU with an x86_64 image, one can do:

qemu-system-x86_64 -enable-kvm -m 2G -M q35 -hda gloire.img -serial stdio

Where gloire.img is your image of choice.

To do the same with a riscv64 image, you can do:

qemu-system-riscv64 -M virt -cpu rv64 -device ramfb -device qemu-xhci            \
   -device usb-kbd -m 2G -drive if=pflash,unit=0,format=raw,file=<firmware path> \
   -device virtio-scsi-pci,id=scsi -device scsi-hd,drive=hd0                     \
   -drive id=hd0,format=raw,file=gloire.img -serial stdio

For riscv64, firmware can be obtained from the EDK2 project, and must be prepared as per QEMU with a

dd if=/dev/zero of=<firmware path> bs=1 count=0 seek=33554432

On physical hardware

Gloire should run fine on any x86 machine, be it UEFI or BIOS. For running it, one can burn your gloire image (uncompressing it first if downloaded) to a SATA or ATA drive. USB sticks for booting are not supported (for now, stay posted!).

Contributing

Gloire accepts contributions for new packages or any other kind of changes using the pull request system baked into Github. Please submit PRs here or read our documentation on how to do so and some things to keep in mind porting on the project's wiki.

Building

The project uses jinx as its build system, which is included in the tree. The instructions to build an x86_64 system are:

./jinx build-all           # Build all packages.
./build-support/makeiso.sh # Create the image.

To build the very experimental riscv64 port, one can instead use:

JINX_CONFIG_FILE=jinx-config-riscv64 ./jinx build-all           # Build all packages.
KINX_CONFIG_FILE=jinx-config-riscv64 ./build-support/makeiso.sh # Create the image.

Regardless of architecture, if instead of building all packages, building a minimal command-line only environment is desired, instead of build-all, one can do build base.

Any of those routes will generate a bootable disk image that can be burned to storage media or be booted by several emulators.

A list of the tools needed for compilation of the OS are:

• git for cloning packages.
• curl and bsdtar for setting up jinx.
• Common UNIX tools like bash, coreutils, grep, find, etc.
• sgdisk from the gptfdisk package for building the image.
• qemu for testing, if wanted.
• tar and lzip for extracting packages.
• rsync for building bootable images.

All of said things can be installed in debian-based systems with

sudo apt install lzip libarchive-tools git build-essentials rsync

Licensing

A list of the licenses used by the software ported to Gloire is:

• GPLv3 (Or-Later and Only)
• GPLv2 (Or-Later and Only)
• The Less License
• MIT License
• BSD 2-Clause

Thanks to

• Mintsuki for the limine bootloader and jinx.
• The managarm project for help with some of the recipes and mlibc.