PantherX Installer

Command line options:

-t, --type: Installation type ['DESTOP', 'SERVER', 'ENTERPRISE'] (Default: Desktop)
-v, --variant: Installation variant ['DEFAULT', 'XFCE', 'MATE', 'GNOME'] (Default: LXQt)
-f, --firmware: Overwrite automatic detection ['BIOS', 'EFI'] (Default: Automatic)
-hn, --hostname: Computer name on the network (Default: pantherx-7xkp1)
-tz, --timezone: Computer time zone (Default: Europe/Berlin)
-l, --locale: Computer locale (Default: en_US.utf8)
-u, --username: First user username (Default: panther)
-pw, --password: First user password (Default: pantherx) - should be changed later `passwd <USERNAME>`
-d, --disk: The disk to install to (Default: /dev/sda)
-de, --disk_encryption: Whether to use full disk encryption (Default: False)
-c, --config: Overwrites all other options; installs from enterprise config settings

Defaults:

• EFI: 200 MB boot partition / BIOS: 10 MB boot partition
• Remaining for data
• 4GB SWAP file

Run

Run with prompts:

# This will prompt you for all options (RECOMMENDED)
px-install run

Run with defaults:

# This will install the system with everything set to default
px-install

Run with command line arguments:

px-install --type DESKTOP \
    --variant XFCE \
	--firmware EFI \
	--hostname panther \
	--timezone Europe/Berlin \
	--locale en_US.utf8 \
	--username panther \
	--password pantherx \
	--key ssh-ed25519 AA ... 4QydPg franz \
	--disk /dev/sda
	--disk_encryption True

If you decide to use full disk encryption (`-de True / --disk_encryption True), you will be prompted for an encryption passphrase a few seconds after the installation has started:

Enter passphrase for /dev/sda2:
Verify passphrase:

Enterprise config overwrite (fully automated):

px-install --config abd1uc3z

Refer to scripts/README.md for more on enterprise configuration.

Helpers

Wifi

To aid Wi-Fi setup:

px-install wifi-setup

This will:

1. Check if a valid interface is available
2. Prompt for Wi-Fi config
3. Print commands to activate Wi-Fi

Online Check

To check if you're online, do:

px-install network-check

Minimal bash-based replicate

There's a minimal, all-in-one installer bash script in scripts/install.sh. It replicates the python application closely. Instead of params it asks for each setting.

Use as Library

from px_install import installation
intallation(config)

The system configuration looks like this:

class SystemConfiguration():
    type: str
	variant: str
    firmware: str
    hostname: str
    timezone: str
    locale: str
    username: str
    password: str
    public_key: str
    disk: BlockDevice
	use_disk_encryption: bool

You can also run the installation in steps:

from px_install import SystemInstallation, default_system_configuration

config = default_system_configuration()

# if needed, config can be updated like this
# some or all items will be validated in the future
# if for ex. the hostname is not valid, a ValueError is thrown
config.update_hostname('domain')
config.update_timezone('Europe/Berlin')
# update_ + type, hostname, timezone, locale, username, password, public_key,  use_disk_encryption

install = SystemInstallation(config, is_enterprise_config=False)

# then you can call each manually:
install.format()
install.mount_partition()
install.create_swap()
install.generate_config()
# Not necessary as of April 2024
# install.pull()
install.install()

Misc

Also included in the repository:

1. pantherx-on-hetzner-cloud.sh -> install PantherX on Hetzner Debian Cloud Server (need to be reconfigured after reboot)
2. pantherx-on-digitalocean.sh -> install PantherX on DigitalOcean Debian or Ubuntu Droplet (need to be reconfigured after reboot)

Tests

$ python3 -m unittest -v
...
Ran 25 tests in 0.621s

Debugging

Access the latest installer, booted from USB:

guix package -i python
python3 -m venv venv
source venv/bin/activate
pip3 install https://source.pantherx.org/px-install_v<LATEST_VERSION>.tgz
# for ex.:
# pip3 install https://source.pantherx.org/px-install_v0.0.32.tgz
px-install run

Note If python3 -m venv venv throws an error like this, just ignore it:

Error in sitecustomize; set PYTHONVERBOSE for traceback:
ValueError: '/root/.guix-profile/lib/python3.9/site-packages' is not in list

Development

guix environment --pure \
--ad-hoc python util-linux tar iproute2 coreutils
python3 -m venv venv
source venv/bin/activate
pip install .

Quick test:

rsync -r --exclude={'venv','git','__pycache','tests','scripts'} ../px-install root@<IP>:/root
# rsync -r --exclude "venv" --exclude="git" -e "ssh -p 2222" ../px-install [email protected]:/root
cd px-install; rm -rf venv; python3 -m venv venv; source venv/bin/activate; pip3 install .; px-install run