Documentation

Installation manual

Prepare

Poolsman comes as a plugin for Cockpit Web UI for server management. If you don't have Cockpit installed yet, Poolsman will install its basic components automatically. However if you'd like to get the full set of Cockpit features, you should install it using the official Cockpit documentation. Be aware that in general case we do not recommend to install the full Cockpit version on Proxmox and Debian systems (see more details in the note below).

NOTE: The full Cockpit version includes some heavy dependencies (e.g. network-manager) that may potentially change the OS behavior or even break something. It's mostly important if you are using lightweight OS like Proxmox or Debian. If you are not sure that the full Cockpit won't break anything, just skip this step and proceed with Poolsman installation. That way Poolsman will install only required Cockpit components.

Install

NOTE: If you are working under root user, you should remove sudo from the installation commands. This recommendation is mostly for Debian and Proxmox systems.

Debian, Ubuntu and Proxmox

Add Poolsman repository:

echo "deb [arch=all] https://download.poolsman.com/repository/debian/ stable main" | \
    sudo tee /etc/apt/sources.list.d/poolsman.list > /dev/null

Import Poolsman repository GPG key:

wget -qO- https://download.poolsman.com/keys/poolsman.gpg | \
    sudo tee /etc/apt/trusted.gpg.d/poolsman.gpg > /dev/null

Refresh package repositories:
```
sudo apt-get -y update
```
Install Poolsman from repository:
```
sudo apt-get -y install poolsman
```
Open Cockpit in your web browser (ip-address-of-machine:9090) and go to the Poolsman tab (ZFS storage).

RHEL-based distro

Poolsman has been tested on RHEL, Fedora, CentOS Stream and Rocky Linux, but should work on other RHEL-based distros too.

Import Poolsman repository GPG key:

sudo rpm --import https://download.poolsman.com/keys/poolsman.asc

Install Poolsman (it will also configure repository during installation for further updates):

sudo dnf install https://download.poolsman.com/repository/rhel/any/stable/poolsman-0.8.0-1.el.noarch.rpm

Enable Cockpit socket and open the firewall if required by following Cockpit documentation.
Open Cockpit in your web browser (ip-address-of-machine:9090) and go to the Poolsman tab (ZFS storage).

openSUSE Leap and Tumbleweed

Import Poolsman repository GPG key:

sudo rpm --import https://download.poolsman.com/keys/poolsman.asc

Install Poolsman (it will also configure repository during installation for further updates):

sudo zypper install https://download.poolsman.com/repository/suse/any/stable/poolsman-0.8.0-1.suse.noarch.rpm

Enable Cockpit socket and open the firewall if required by following Cockpit documentation.
Open Cockpit in your web browser (ip-address-of-machine:9090) and go to the Poolsman tab (ZFS storage).

Arch Linux

Add Poolsman repository:

cat << EOF | sudo tee -a /etc/pacman.conf > /dev/null

[poolsman]
SigLevel = PackageRequired
Server = https://download.poolsman.com/repository/arch/any/stable
EOF

Import Poolsman repository GPG key:

sudo sh -c 'wget -O- https://download.poolsman.com/keys/poolsman.asc | pacman-key -a -'

Sign Poolsman GPG key locally:

sudo pacman-key --lsign-key 8586E2EA978518CB

Install Poolsman:
```
sudo pacman -Syu poolsman
```
Enable Cockpit socket and open the firewall if required by following Cockpit documentation.
Open Cockpit in your web browser (ip-address-of-machine:9090) and go to the Poolsman tab (ZFS storage).

Other Linux distributions

Poolsman should work on any other Linux distribution that is having OpenZFS and Cockpit installed. If there are no packages for your distro, you can install it from .zip archive:

Download latest release in .zip format:

wget https://download.poolsman.com/releases/v0.8.0-1/poolsman-0.8.0-1.zip

Uninstall previous version if required:

sudo rm -rf /usr/share/cockpit/poolsman/

Install new version from .zip archive:

sudo unzip poolsman-0.8.0-1.zip -d /usr/share/cockpit/

Remove downloaded .zip archive:
```
rm poolsman-0.8.0-1.zip
```

Let us know if you'd like to have repository and packages for another Linux distros.

Activate

Download the license key file from your account.
Open Cockpit in your web browser (ip-address-of-machine:9090), go to the Poolsman tab (ZFS storage) and activate your license.

Download portal

You can find all releases and download them from here:

https://download.poolsman.com/