Giter Club home page Giter Club logo

arch-fai-legacy's Introduction

Arch-FAI

A Fully-Automated Installer for ArchLinux systems.

What does it do?

Arch-FAI builds an ArchLinux system with nearly no human interaction.

The target system will use logical volume management under per-container encryption.

After installation, user defined configuration occurs on first login (again, unattended after initial configuration).

What do you need to do to use it?

A series of files must be edited to make the FAI useful:

Command-line parameters can be found in the usage message:

Usage: arch-fai [ <Optional Arguments> ] [ <Overridable Arguments> ] <Required Arguments>
   -h                Display this help message and exit.

Optional Arguments:
   -s                Is the raw device a solid state drive? (default false)
   -r                Randomize raw device contents using /dev/random.
   -u                Randomize raw device contents using /dev/urandom.

Overridable Arguments:
   -b                System uses BIOS. (default EFI)
   -a <architecture> Hardware architecture. (default to result of `uname -m`)
   -L <device>       Logical volume group name. (default 'LvGroup')
   -M <mount point>  Installation mount point. (default '/mnt/archbox')
   -C <config dir>   Configuration file directory. (default './configure')

Required Arguments:
   -D <device>       Raw device (disk) path. Must be a block device.

Configuration Files

The configure directory contains files with my personal minimal configuration. You can either modify the provided files or specify a different configuration directory.

Filename Importance Description
passphrase Required Root volume passphrase.
password Required Root user password.
hostname Required Valid single-word hostname. (ex: archbox)
locale Required Valid locale. (ex: en_US.UTF8)
timezone Required Valid timezone (ex: America/Los_Angeles)
modules Optional Whitespace-delimited list of kernel modules.
hooks Optional Whitespace-delimited list of boot hooks.
packages Optional Whitespace-delimited list of packages.
Must be recognized by pacman.
groups Optional Whitespace-delimited list of groups.
users Optional Properly formated, newline-delimited list of users.
name=$name shell=$shell gid=$gid [ groups=$group1,$group2,... ]
files Optional A directory of files that will be copied over the existing root filesystem.
units Optional Whitespace-delimited list of systemd units to enable on boot.

Filesystem Schema

Additionally, the filesystem schema can be modified in scripts/variables. This is not recommended, and can lead to some subtle problems in your new system.

If you feel the need to make changes here, follow these rules:

  • root and swap must be present in LOGICAL_VOLUMES.
  • All other logical volumes must be present in both LOGICAL_VOLUMES AND LUKS_CONTAINERS.
  • All elements in LOGICAL_VOLUMES must have a corresponding LOGICAL_VOLUME_* definition.
    • name, size, fs_type, and mount must be present in every definition.
  • All elements in TMPFS_DIRECTORIES must have a corresponding TMPFS_DIRECTORY_* definition.
    • size and mount must be present in every definition.
  • Do not edit anything else!

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.