Skip to content

Contents for creating a custom install stick for VotingWorks systems

Notifications You must be signed in to change notification settings

votingworks/vx-iso

Repository files navigation

Setting up USB drives for use with vx-iso and OS images.

USB Requirements

You should use a Debian 11 or 12 OS for the below steps.

There are two types of USB drives used for installing VotingWorks images.

  1. An install drive.
  2. An image (with optional keys) drive.

We recommend a fast, 64GB+ USB drive for the image drive.

Creating an install drive

  1. Ensure your USB drive is inserted and accessible to the VM or system you are using
  2. Run: ./scripts/create-install-drive.sh /path/to/install.iso
  3. Select your USB drive from the menu
  4. Once the .iso file is successfully copied to the USB, you will see a success message.

Creating an image (with optional secure boot keys) drive

  1. Ensure your fast, 64GB+ USB drive is inserted and accessible to the VM or system you are using. NOTE: This should NOT be the same USB used for the .iso file.

  2. If you are creating a drive with an image AND secure boot keys: ./scripts/copy-image.sh -i /path/to/img.lz4 -k /path/to/keys.tgz

    If you are creating a drive with only an image: ./scripts/copy-image.sh -i /path/to/img.lz4

  3. Select your USB drive from the menu

  4. Wait for the img to be copied. If you provided keys, they will also be extracted onto the drive.

Creating a vx-iso installer image

TODO: This requires a significant update due to implementing secure boot support.