UGA-Innovation-Factory/athenix
3
1
Fork 0
Code Issues Pull Requests Actions Projects Releases Activity

Rename project to 'Athenix'

Browse Source
This commit is contained in:
UGA Innovation Factory
2025-12-18 12:07:25 -05:00
parent 85ffa56d12
commit 6ab5f20946
38 changed files with 272 additions and 272 deletions
Download Patch File Download Diff File Expand all files Collapse all files

100
docs/NAMESPACE.md
View File

@@ -1,36 +1,36 @@
# Configuration Namespace Reference
All UGA Innovation Factory-specific options are under the `ugaif` namespace to avoid conflicts with standard NixOS options.
All UGA Innovation Factory-specific options are under the `athenix` namespace to avoid conflicts with standard NixOS options.
## Table of Contents
- [Host Configuration (`ugaif.host`)](#host-configuration-ugaifhost)
- [Software Configuration (`ugaif.sw`)](#software-configuration-ugaifsw)
- [User Management (`ugaif.users`)](#user-management-ugaifusers)
- [System Configuration (`ugaif.system`)](#system-configuration-ugaifsystem)
- [Host Configuration (`athenix.host`)](#host-configuration-athenixhost)
- [Software Configuration (`athenix.sw`)](#software-configuration-athenixsw)
- [User Management (`athenix.users`)](#user-management-athenixusers)
- [System Configuration (`athenix.system`)](#system-configuration-athenixsystem)
- [Convenience Options](#convenience-options)
## Host Configuration (`ugaif.host`)
## Host Configuration (`athenix.host`)
Hardware and host-specific settings.
### `ugaif.host.filesystem`
### `athenix.host.filesystem`
Disk and storage configuration.
**Options:**
- `ugaif.host.filesystem.device` - Boot disk device (default: `/dev/sda`)
- `ugaif.host.filesystem.swapSize` - Swap file size (default: `"32G"`)
- `athenix.host.filesystem.device` - Boot disk device (default: `/dev/sda`)
- `athenix.host.filesystem.swapSize` - Swap file size (default: `"32G"`)
**Example:**
```nix
ugaif.host.filesystem = {
athenix.host.filesystem = {
device = "/dev/nvme0n1";
swapSize = "64G";
};
```
### `ugaif.host.buildMethods`
### `athenix.host.buildMethods`
List of supported build artifact types for this host.
@@ -42,10 +42,10 @@ List of supported build artifact types for this host.
**Example:**
```nix
ugaif.host.buildMethods = [ "lxc" "proxmox" ];
athenix.host.buildMethods = [ "lxc" "proxmox" ];
```
### `ugaif.host.useHostPrefix`
### `athenix.host.useHostPrefix`
Whether to prepend the host type prefix to the hostname (used in inventory generation).
@@ -55,26 +55,26 @@ Whether to prepend the host type prefix to the hostname (used in inventory gener
**Example:**
```nix
ugaif.host.useHostPrefix = false; # "builder" instead of "nix-lxc-builder"
athenix.host.useHostPrefix = false; # "builder" instead of "nix-lxc-builder"
```
### `ugaif.host.wsl`
### `athenix.host.wsl`
WSL-specific configuration options.
**Options:**
- `ugaif.host.wsl.user` - Default WSL user for this instance
- `athenix.host.wsl.user` - Default WSL user for this instance
**Example:**
```nix
ugaif.host.wsl.user = "myusername";
athenix.host.wsl.user = "myusername";
```
## Software Configuration (`ugaif.sw`)
## Software Configuration (`athenix.sw`)
System software and application configuration.
### `ugaif.sw.enable`
### `athenix.sw.enable`
Enable the software configuration module.
@@ -82,7 +82,7 @@ Enable the software configuration module.
**Default:** `true`
### `ugaif.sw.type`
### `athenix.sw.type`
System type that determines the software profile.
@@ -98,10 +98,10 @@ System type that determines the software profile.
**Example:**
```nix
ugaif.sw.type = "headless";
athenix.sw.type = "headless";
```
### `ugaif.sw.kioskUrl`
### `athenix.sw.kioskUrl`
URL to display in kiosk mode browsers (for `tablet-kiosk` and `stateless-kiosk` types).
@@ -111,38 +111,38 @@ URL to display in kiosk mode browsers (for `tablet-kiosk` and `stateless-kiosk`
**Example:**
```nix
ugaif.sw.kioskUrl = "https://dashboard.example.com";
athenix.sw.kioskUrl = "https://dashboard.example.com";
```
### `ugaif.sw.python`
### `athenix.sw.python`
Python development tools configuration.
**Options:**
- `ugaif.sw.python.enable` - Enable Python tools (pixi, uv) (default: `true`)
- `athenix.sw.python.enable` - Enable Python tools (pixi, uv) (default: `true`)
**Example:**
```nix
ugaif.sw.python.enable = true;
athenix.sw.python.enable = true;
```
### `ugaif.sw.remoteBuild`
### `athenix.sw.remoteBuild`
Remote build server configuration for offloading builds.
**Options:**
- `ugaif.sw.remoteBuild.enable` - Use remote builders (default: enabled on tablets)
- `ugaif.sw.remoteBuild.hosts` - List of build server hostnames
- `athenix.sw.remoteBuild.enable` - Use remote builders (default: enabled on tablets)
- `athenix.sw.remoteBuild.hosts` - List of build server hostnames
**Example:**
```nix
ugaif.sw.remoteBuild = {
athenix.sw.remoteBuild = {
enable = true;
hosts = [ "nix-builder" "nix-builder2" ];
};
```
### `ugaif.sw.extraPackages`
### `athenix.sw.extraPackages`
Additional system packages to install beyond the type defaults.
@@ -152,14 +152,14 @@ Additional system packages to install beyond the type defaults.
**Example:**
```nix
ugaif.sw.extraPackages = with pkgs; [
athenix.sw.extraPackages = with pkgs; [
vim
htop
docker
];
```
### `ugaif.sw.excludePackages`
### `athenix.sw.excludePackages`
Packages to exclude from the default list for this system type.
@@ -169,16 +169,16 @@ Packages to exclude from the default list for this system type.
**Example:**
```nix
ugaif.sw.excludePackages = with pkgs; [
athenix.sw.excludePackages = with pkgs; [
firefox # Remove Firefox from default desktop packages
];
```
## User Management (`ugaif.users`)
## User Management (`athenix.users`)
User account configuration and management.
### `ugaif.users.<username>.enable`
### `athenix.users.<username>.enable`
Enable a specific user account on this system.
@@ -188,7 +188,7 @@ Enable a specific user account on this system.
**Example:**
```nix
ugaif.users = {
athenix.users = {
myuser.enable = true;
student.enable = true;
};
@@ -200,7 +200,7 @@ Each user in `users.nix` can be configured with:
```nix
# Option 1: Define inline in users.nix
ugaif.users.myuser = {
athenix.users.myuser = {
description = "Full Name";
isNormalUser = true; # Default: true
extraGroups = [ "wheel" "docker" ]; # Additional groups
@@ -214,30 +214,30 @@ ugaif.users.myuser = {
};
# Option 2: Use external configuration (recommended)
# The external user.nix can set ugaif.users.myuser options directly
ugaif.users.anotheruser.external = builtins.fetchGit {
# The external user.nix can set athenix.users.myuser options directly
athenix.users.anotheruser.external = builtins.fetchGit {
url = "https://github.com/username/dotfiles";
rev = "abc123...";
};
```
## System Configuration (`ugaif.system`)
## System Configuration (`athenix.system`)
System-wide settings and services.
### `ugaif.system.gc`
### `athenix.system.gc`
Automatic garbage collection configuration.
**Options:**
- `ugaif.system.gc.enable` - Enable automatic garbage collection (default: `true`)
- `ugaif.system.gc.frequency` - How often to run (default: `"weekly"`)
- `ugaif.system.gc.retentionDays` - Days to keep old generations (default: `30`)
- `ugaif.system.gc.optimise` - Optimize Nix store automatically (default: `true`)
- `athenix.system.gc.enable` - Enable automatic garbage collection (default: `true`)
- `athenix.system.gc.frequency` - How often to run (default: `"weekly"`)
- `athenix.system.gc.retentionDays` - Days to keep old generations (default: `30`)
- `athenix.system.gc.optimise` - Optimize Nix store automatically (default: `true`)
**Example:**
```nix
ugaif.system.gc = {
athenix.system.gc = {
enable = true;
frequency = "daily";
retentionDays = 14;
@@ -247,7 +247,7 @@ ugaif.system.gc = {
## Convenience Options
### `ugaif.forUser`
### `athenix.forUser`
Quick setup option that enables a user account in one line.
@@ -257,14 +257,14 @@ Quick setup option that enables a user account in one line.
**Example:**
```nix
ugaif.forUser = "myusername"; # Equivalent to ugaif.users.myusername.enable = true
athenix.forUser = "myusername"; # Equivalent to athenix.users.myusername.enable = true
```
**Usage in inventory.nix:**
```nix
nix-wsl = {
devices = {
"alice".ugaif.forUser = "alice-uga";
"alice".athenix.forUser = "alice-uga";
};
};
```