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-amd64-glibc-installer.run
To install system-wide, run:
sudo sh cuno-amd64-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.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
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
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.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

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

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 Installed into an (ideally empty) directory.
Follow the instructions for your Mac’s architecture:
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
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.
4. 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

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.

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.