NAME

piscsi-web — web control interface for PiSCSI

SYNOPSIS

piscsi-web [-password TOKEN] [-v]

DESCRIPTION

piscsi-web provides the browser-based control interface for a PiSCSI daemon. It connects to the daemon to display and manage SCSI devices, images, configuration files, logs, and system services.

The packaged service reads its configuration from /etc/piscsi-web/piscsi-web.env and listens on all interfaces at port 8080 by default. Run the service through systemctl(1) on a packaged installation.

OPTIONS

-password TOKEN: Use TOKEN to authenticate with the PiSCSI daemon. This overrides PISCSI_TOKEN for this invocation.
-v: Print PiSCSI version and copyright information, then exit.

ENVIRONMENT

SERVER_HOST: Address on which to listen. The default is “0.0.0.0”.
SERVER_PORT: TCP port on which to listen. The default is 8080.
PISCSI_HOST: Hostname or IP address of the PiSCSI daemon. The default is “localhost”.
PISCSI_PORT: TCP port of the PiSCSI daemon. The default is 6868.
PISCSI_TOKEN: Authentication token for the PiSCSI daemon.
BASE_DIR: Absolute directory that contains disk images. The default is /var/lib/piscsi/images.
SHARED_DIR: Absolute directory for shared files. The default is /var/lib/piscsi/shared.
CONFIG_DIR: Absolute directory for PiSCSI configuration files. The default is /var/lib/piscsi/config.
DRIVER_DIR: Optional absolute directory containing Macintosh hard-disk driver images. The default is /var/lib/piscsi/data/mac-hard-disk-drivers.
DRIVE_PROPERTIES_FILE: Drive-properties JSON file. Packaged installations use /etc/piscsi-web/drive_properties.json.
MAX_FILE_SIZE: Largest accepted upload in bytes. The default is 4294967296 (4 GiB).
SESSION_KEY_FILE: Absolute path to a base64-encoded master-key file used to protect browser sessions. The default is /etc/piscsi-web/session.key.
SESSION_KEY: Base64-encoded session master key for development only. It is used only when SESSION_KEY_FILE is not set.
SESSION_MAX_AGE: Browser session lifetime in seconds. The default is 86400.
TEMPLATES_DIR: Optional directory containing HTML templates for development.
STATIC_DIR: Optional directory containing static assets for development.

EXAMPLES

Start the packaged service and inspect its status:

sudo systemctl enable --now piscsi-web
systemctl status piscsi-web

Run the application directly against a daemon on another host:

PISCSI_HOST=piscsi.local PISCSI_TOKEN=secret piscsi-web

FILES

/etc/piscsi-web/piscsi-web.env: Packaged service environment file.
/etc/piscsi-web/session.key: Packaged session master-key file.
/etc/piscsi-web/drive_properties.json: Drive-properties database.

SECURITY

The web interface can modify PiSCSI devices and files. Protect access to its listening address, keep the daemon token and session key secret, and do not make the service publicly reachable without an appropriate network access control.