Download, Installation and Activation

cunoFS offers a “Scripted Installer” which does not require root privileges to install. We also offer distributions that can be installed using popular Linux package managers. All of our releases are available on GitHub.

Note

A licence is required to use cunoFS, get a free licence by signing up at cuno.io/activate.

A free licence lets you use all features for 14 days, and thereafter you will be limited to the Personal tier of usage.

Downloading and installing

Note

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

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

To install only for the current user, run the following terminal command:
sh cuno-glibc-installer.run
To install system-wide, run:
sudo sh cuno-glibc-installer.run
Please follow the interactive steps, read the displayed end-user licence agreement (EULA) and agree to the terms to continue with the installation.
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.

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
Unpack the archive by running:
sh cuno_amd64_glibc_deb.run
Please follow the interactive steps, read the displayed end-user licence agreement (EULA) and agree to the terms to continue with the extraction.
The archive and its contents will be unpacked into a directory named cuno_1.1.5_amd64_glibc containing the package itself and additional documents:
$ ls cuno_1.1.5_amd64_glibc cuno_1.1.5_amd64.deb CUNO-Installation-and-User-Guide.pdf
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.5_amd64_glibc/cuno_1.1.5_amd64_glibc.deb
Complete the installation by following the interactive instructions.
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.

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
Unpack the archive by running:
sh cuno_x86_64_glibc_rpm.run
Please follow the interactive steps, read the displayed end-user licence agreement (EULA) and agree to the terms to continue with the extraction.
The archive and its contents will be unpacked into a directory named cuno_1.1.5_amd64_glibc containing the package itself and additional documents:
$ ls cuno_1.1.5_x86_64_glibc cuno_1.1.5_x84_64_.rpm CUNO-Installation-and-User-Guide.pdf

Install cunoFS and its dependencies using yum:

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

Complete the installation by following the interactive instructions.
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.

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.

Download and install Docker Desktop for Mac from Docker Hub.
Download the Scripted Installer.
Follow the instructions best suited to your use-case:
Installing cunoFS on to your Mac directly will allow you to use cuno-mac, our handy tool for launching Linux containers that automatically have your local installation of cunoFS installed inside them.
Note

To use cuno-mac, you must also have Python 3 installed and available as python3 in Terminal.

You must also have Docker for Mac installed and ready for use. If you are using a Mac with Apple Silicon, please follow the additional setup instructions:
1. Enable the following feature in the Docker Desktop dashboard:
  
  Settings > Features in development > Beta: Use Rosetta for x86/amd64 emulation on Apple Silicon
2. We also recommend enabling VirtioFS (Settings > General: VirtioFS).
3. Restart the Docker Engine by clicking on the Docker icon in the menu bar and selecting Restart.
You may also use Rancher (set up with Rosetta if necessary) with cuno-mac.
1. In a Terminal on your Mac, navigate to your download directory. If this was the default Downloads folder, you can run:
  cd /Users/$USER/Downloads
2. Run the installer (without sudo):
  sh cuno-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. Export the cuno-mac location to your PATH variable:
  export PATH=$PATH:~/.local/opt/cuno/share/macos
  
  To have this persist and apply to new Terminal sessions, add this as a new line at the bottom of the file /Users/<your username>/.bash_profile using a text editor, or using the following command in a Terminal session:
  
  echo "PATH=\$PATH:~/.local/opt/cuno/share/macos" >> ~/.bash_profile
  
  Warning
  
  Do not miss the \ because otherwise your current PATH will be written literally into the profile and break future changes.
If installing on your Mac’s local user is not preferred, you can install cunoFS within a container of your choice. We provide instructions here for installing within Docker containers using Ubuntu images. These instructions can be adapted to other Linux distributions, as well other virtualisation technologies such as Rancher, and OrbStack (see Installation Prerequisites).

These instructions depend on the architecture of you Mac, please follow the appropriate guide:
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>/cuno-glibc-installer:/tmp/cuno_install \ --name cuno-container \ ubuntu:latest

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

sh /tmp/cuno_install

Please follow the interactive steps, read the displayed end-user licence agreement (EULA) and agree to the terms to continue with the installation.
Enable the following feature in the Docker Desktop dashboard.

Settings > Features in development > Beta: Use Rosetta for x86/amd64 emulation on Apple Silicon

We also recommend enabling VirtioFS (Settings > General: VirtioFS).

Restart the Docker Engine by clicking on the Docker icon in the menu bar and selecting Restart.

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 \ --platform linux/amd64 ubuntu:latest

Note

The --platform linux/amd64 flag is required to run cunoFS on Macs with Apple Silicon.

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

sh /tmp/cuno_install

Please follow the interactive steps, read the displayed end-user licence agreement (EULA) and agree to the terms to continue with the installation.
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.

Activating your licence

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

cuno creds activate

Note

Instructions for cuno-mac users

If any arguments are given to cuno-mac, it will start a temporary container and pass the arguments on to cuno. Therefore, you can activate your cuno installation by running:

cuno-mac creds activate

The first time cuno-mac is run, a Docker image will be created with cunoFS ready to use and a user set up within the image similar to your local user on your Mac.

Testing your installation

You should now be able to run cunoFS from the command line, which you can test out by calling cuno version - this should output the version of cunoFS you have installed.

Note

A note for cuno-mac users

If you have installed cunoFS directly onto a Mac, you must choose between using cuno-mac and cuno depending on the environment you are currently in.

If you’re in a Mac Terminal session and have not run cuno-mac, then you must replace cuno in any instructions with cuno-mac.

If you have already started a cunoFS container by calling cuno-mac, you will see the (cuno) prefix on your command line so any instructions using cuno commands will work as-is.

To return to macOS, run exit.

See Additional instructions for cuno-mac users for information.

To test that cunoFS is fully working before connecting your own object storage, you can use it to browse publicly available data. In the following example, we use cunoFS to browse space telescope data hosted on the stpubdata Amazon S3 bucket:

$ cuno run sh -c "ls s3://stpubdata/"

galex  hst  jwst  k2  kepler  panstarrs  tess

$ cuno run sh -c "ls s3://stpubdata/tess/public/*"

's3://stpubdata/tess/public/ffi':
s0001  s0005  s0009  s0013  s0017  s0021  s0025  s0029 ... [truncated]

's3://stpubdata/tess/public/mast':
tess-s0001-1-1-cube.fits  tess-s0012-1-4-cube.fits  tess-s0023-2-3-cube.fits ... [truncated]

... [truncated]

Note

Note that cuno run is a way to run a single command within a cunoFS context. Most of the time, and for interactive usage, we recommend starting a “wrapped” shell using the command cuno - see the Loading cunoFS section of this guide for more information, or the equivalent section from the full user guide for extra detail.