Download and installation

There are multiple ways to install cunoFS:

• an installation script, which allows users to install cunoFS without root privileges (Scripted installer);

• standard packages for various Linux distributions (Package manager installation).

Install locations

When cunoFS is installed via the Scripted Installer, it gets installed to different locations depending on whether it was installed by root, or by a non-root user. Hereafter, root installations are called ‘system-wide’, and non-root installations are called ‘user-local’.

Note

A package manager install of cunoFS is always system-wide, regardless of the privileges of the user installing it.

cunoFS installation locations for per-user and systemwide installations

Install type	Location (CUNO_ROOT)	Symlinks created in
User-local	~/.local/opt/cuno/	~/.local/bin/ ~/.local/lib/x86_64-linux-gnu ~/.local/share/man/
System-wide	/opt/cuno/	/usr/bin/ /usr/lib/ /usr/share/man/

Scripted installer

Note

For full details about user privileges for installation, see the user guide.

1. Click to download the latest version from your browser, or run the command:

   wget https://github.com/cunoFS/cunoFS/releases/latest/download/cuno-glibc-installer.run
   

2. To install only for the current user, run the following terminal command:

   sh cuno-amd64-glibc-installer.run
   

   To install system-wide, run:

   sudo sh cuno-amd64-glibc-installer.run
   

3. Please follow the interactive steps, read the displayed end-user licence agreement (EULA) and agree to the terms to continue with the installation.

4. The installation will prompt you to set the CUNO_ROOT environment variable to the installation directory. This is not always necessary when using cunoFS, but it will make it easier to follow the steps in this guide.

Package manager installation

Debian and derivatives (e.g. Ubuntu)

1. Click to download the latest version of the self-extracting package for Debian from your browser, or run the command:

   wget https://github.com/cunoFS/cunoFS/releases/latest/download/cuno_amd64_glibc_deb.run
   

2. Unpack the archive by running:

   sh cuno_amd64_glibc_deb.run
   

3. Please follow the interactive steps, read the displayed end-user licence agreement (EULA) and agree to the terms to continue with the extraction.

4. The archive and its contents will be unpacked into a directory named cuno_1.1.4_amd64_glibc containing the package itself and additional documents:

   $ ls cuno_1.1.4_amd64_glibc
   cuno_1.1.4_amd64.deb
   CUNO-Installation-and-User-Guide.pdf
   

5. Install cunoFS and its dependencies using apt:

   Note

   Be sure to use a relative path here, ./, to instruct apt not to search its repositories.

   sudo apt update
   sudo apt install ./cuno_1.1.4_amd64_glibc/cuno_1.1.4_amd64_glibc.deb
   

6. Complete the installation by following the interactive instructions.

7. The installation will prompt you to set the CUNO_ROOT environment variable to the installation directory. This is not always necessary when using cunoFS, but it will make it easier to follow the steps in this guide.

RedHat and derivatives

1. Click to download the latest version of the self-extracting package for RHEL from your browser, or run the command:

   wget https://github.com/cunoFS/cunoFS/releases/latest/download/cuno_x86_64_glibc_rpm.run
   

2. Unpack the archive by running:

   sh cuno_x86_64_glibc_rpm.run
   

3. Please follow the interactive steps, read the displayed end-user licence agreement (EULA) and agree to the terms to continue with the extraction.

4. The archive and its contents will be unpacked into a directory named cuno_1.1.4_amd64_glibc containing the package itself and additional documents:

   $ ls cuno_1.1.4_x86_64_glibc
   cuno_1.1.4_x84_64_.rpm
   CUNO-Installation-and-User-Guide.pdf
   

5. Install cunoFS and its dependencies using yum:

   sudo yum makecache
   sudo yum install ./cuno_1.1.4_x86_64_glibc/cuno_1.1.4_x86_64_glibc.rpm
   

6. Complete the installation by following the interactive instructions.

7. The installation will prompt you to set the CUNO_ROOT environment variable to the installation directory. This is not always necessary when using cunoFS, but it will make it easier to follow the steps in this guide.

Alpine Linux

Warning

cunoFS APK packages for Alpine will be available soon.

sudo apk add --allow-untrusted ./cuno_1.1.4_amd64_musl/cuno_1.1.4_amd64_musl.apk

Other operating systems

cunoFS is built for Linux distributions only, and does not natively support other operating systems. However, there are still ways to use cunoFS.

macOS using Docker

Note

Alternatives to Docker on Mac are available, some recommended alternatives are:

• Rancher Desktop (free) - If you’re on Apple Silicon, enable Rosetta (Settings > Virtual Machine > VZ: Enable Rosetta support) and VirtioFS (Settings > Virtual Machine > Volumes: virtiofs)

• OrbStack for Mac (may be faster) - OrbStack works out of the box.

Unfortunately, colima is not currently supported.

cunoFS can be loaded within a Docker container on macOS.

Note

Macs with Apple Silicon require:

• macOS 13.0 Ventura or later;

• Docker Desktop 4.16.0 or later.

1. Download and install Docker Desktop for Mac from Docker Hub.

2. Download the Scripted Installed into an (ideally empty) directory.

3. Follow the instructions for your Mac’s architecture:

   IntelApple Silicon (ARM)

   1. Run the following command to run a Docker container with the cunoFS installer available at /tmp/cuno_install:

      Warning

      This command will download the latest stable Ubuntu image, which could be large.

      docker run -it --rm --entrypoint /bin/bash \
      -v ‹path_to_installation_script›:/tmp/cuno_install \
      --name cuno-container \
      ubuntu:latest
      

4. Within the Docker container (using docker exec -it cuno-container /bin/bash), install cunoFS:

   sh /tmp/cuno_install
   

5. Please follow the interactive steps, read the displayed end-user licence agreement (EULA) and agree to the terms to continue with the installation.

6. The installation will prompt you to set the CUNO_ROOT environment variable to the installation directory. This is not always necessary when using cunoFS, but it will make it easier to follow the steps in this guide.

Windows using WSL2

cunoFS can be used in a virtual machine, a Docker container, or within the Windows Subsystem for Linux (WSL2). WSL installs Ubuntu by default, so the installation instructions for Debian may be used; or the Scripted Installer can be used. You will then be able to use cunoFS with Linux applications installed in WSL.

Note

Refer to the Microsoft documentation on installing WSL for more information.

Exposing mounted object storage to the Host OS

If you’re running cunoFs in a virtual machine, you can expose any object storage mounted as volumes in it using guest-to-host volume mapping.

Licence activation

Interactive

Activate your licence by running the command and following the interactive steps:

cuno creds activate

Note

Normally, activation means that access to cunoFS is limited to the user who runs cuno creds activate. However, if the user that runs cuno creds activate is root, then access can be optionally given to other users.

Non-interactive

For non-interactive activation, you can supply a file to the command:

cuno creds activate "<file>"

You can also pipe the licence in as input:

echo "<your licence key>" | cuno creds activate

Note

The location of the license file after activation is $CUNO_ROOT/etc/license. By default, the permissions on this file are set to 0600. Administrators can manually modify the group and permissions to allow other system users accessing cuno.