A comprehensive storage appliance management system providing ZFS pool management, NFS/SMB shares, iSCSI targets, object storage, and monitoring capabilities with a modern web interface.

Features

Storage Management: ZFS pool and dataset management with snapshots
Network Shares: NFS and SMB/CIFS share management
Block Storage: iSCSI target and LUN management
Object Storage: MinIO integration for S3-compatible storage
Authentication & RBAC: User management with role-based access control
Monitoring: Prometheus metrics and real-time monitoring dashboard
Audit Logging: Comprehensive audit trail of all operations
Modern UI: HTMX-based web interface with TailwindCSS

Requirements

Ubuntu 24.04 (or compatible Linux distribution)
Go 1.21 or later
ZFS utilities (zfsutils-linux)
SMART monitoring tools (smartmontools)
NFS server (nfs-kernel-server)
Samba (samba)
iSCSI target utilities (targetcli-fb)
MinIO (included in installer)

Installation

Option 1: Using the Installation Script (Recommended)

Clone the repository:

git clone <repository-url>
cd storage-appliance

Run the installation script as root:

sudo bash packaging/install.sh

The installer will:

Install all system dependencies
Build the application
Create the service user
Set up systemd service
Configure directories and permissions

Start the service:

sudo systemctl start adastra-storage
sudo systemctl enable adastra-storage  # Enable on boot

Check the status:

sudo systemctl status adastra-storage

View logs:

sudo journalctl -u adastra-storage -f

Option 2: Building a Debian Package

Build the Debian package:

cd packaging
chmod +x build-deb.sh
sudo ./build-deb.sh

Install the package:

sudo dpkg -i ../adastra-storage_1.0.0_amd64.deb
sudo apt-get install -f  # Install any missing dependencies

Start the service:

sudo systemctl start adastra-storage
sudo systemctl enable adastra-storage

Option 3: Manual Installation

Install dependencies:

sudo apt-get update
sudo apt-get install -y golang-go zfsutils-linux smartmontools \
    nfs-kernel-server samba targetcli-fb build-essential

Install MinIO:

wget https://dl.min.io/server/minio/release/linux-amd64/minio -O /usr/local/bin/minio
chmod +x /usr/local/bin/minio

Build the application:

go build -o appliance ./cmd/appliance

Create directories:

sudo mkdir -p /opt/adastra-storage/{bin,data,templates,migrations,logs}

Copy files:

sudo cp appliance /opt/adastra-storage/bin/adastra-storage
sudo cp -r internal/templates/* /opt/adastra-storage/templates/
sudo cp -r migrations/* /opt/adastra-storage/migrations/

Create service user:

sudo useradd -r -s /bin/false -d /opt/adastra-storage adastra
sudo chown -R adastra:adastra /opt/adastra-storage

Install systemd service:

sudo cp packaging/adastra-storage.service /etc/systemd/system/
sudo systemctl daemon-reload
sudo systemctl enable adastra-storage
sudo systemctl start adastra-storage

Configuration

Installation Directory

The application is installed to /opt/adastra-storage with the following structure:

/opt/adastra-storage/
├── bin/
│   └── adastra-storage          # Main binary
├── data/
│   └── appliance.db            # SQLite database
├── templates/                   # HTML templates
├── migrations/                  # Database migrations
├── logs/                        # Log files
└── uninstall.sh                 # Uninstaller script

Environment Variables

The service uses the following environment variables (set in systemd service):

INSTALL_DIR: Installation directory (default: /opt/adastra-storage)
DATA_DIR: Data directory (default: /opt/adastra-storage/data)

Service Configuration

The systemd service file is located at /etc/systemd/system/adastra-storage.service.

To modify the service:

sudo systemctl edit adastra-storage

Usage

Accessing the Web Interface

After installation, access the web interface at:

http://localhost:8080

Default credentials:

Username: admin
Password: admin

⚠️ IMPORTANT: Change the default password immediately after first login!

Service Management

Start the service:

sudo systemctl start adastra-storage

Stop the service:

sudo systemctl stop adastra-storage

Restart the service:

sudo systemctl restart adastra-storage

Check status:

sudo systemctl status adastra-storage

View logs:

sudo journalctl -u adastra-storage -f

Prometheus Metrics

The application exposes Prometheus metrics at:

http://localhost:8080/metrics

API Examples

Get pools (requires authentication):

curl -b cookies.txt http://127.0.0.1:8080/api/pools

Create a pool (requires admin permission):

curl -X POST -b cookies.txt -H "Content-Type: application/json" \
    -d '{"name":"tank","vdevs":["/dev/sda"]}' \
    http://127.0.0.1:8080/api/pools

Development

Quick Start

make run

Build

make build

Run Tests

make test

Lint

make lint

Uninstallation

Using the Uninstaller Script

sudo /opt/adastra-storage/uninstall.sh

The uninstaller will:

Stop and disable the service
Remove application files (optionally preserve data)
Optionally remove the service user

Manual Uninstallation

Stop and disable the service:

sudo systemctl stop adastra-storage
sudo systemctl disable adastra-storage

Remove files:

sudo rm -rf /opt/adastra-storage
sudo rm /etc/systemd/system/adastra-storage.service
sudo systemctl daemon-reload

Remove service user (optional):

sudo userdel adastra

Architecture

Components

HTTP Server: Chi router with middleware for auth, RBAC, CSRF
Database: SQLite with migrations
Services: Storage, Shares, iSCSI, Object Store
Infrastructure Adapters: ZFS, NFS, Samba, iSCSI, MinIO
Job Runner: Async job processing for long-running tasks
Monitoring: Prometheus metrics and UI dashboard
Audit: Comprehensive audit logging

Security

Session-based authentication with secure cookies
CSRF protection compatible with HTMX
Role-based access control (RBAC) with fine-grained permissions
Password hashing using Argon2id
Audit logging of all operations

Troubleshooting

Service Won't Start

Check service status:

sudo systemctl status adastra-storage

Check logs:

sudo journalctl -u adastra-storage -n 50

Verify permissions:

ls -la /opt/adastra-storage

Check if port 8080 is available:

sudo netstat -tlnp | grep 8080

Database Issues

The database is located at /opt/adastra-storage/data/appliance.db. If you need to reset:

sudo systemctl stop adastra-storage
sudo rm /opt/adastra-storage/data/appliance.db
sudo systemctl start adastra-storage

⚠️ Warning: This will delete all data!

Permission Issues

Ensure the service user has proper permissions:

sudo chown -R adastra:adastra /opt/adastra-storage
sudo usermod -aG disk adastra  # For ZFS access

License

[Specify your license here]

Support

For issues and questions, please open an issue on the project repository.