cunoFS Documentation Logo
1.1.5

Getting started

  • Getting started with cunoFS
  • Core Concepts
    • Characteristics of object storage
    • Direct use of object storage
    • Interception
    • What cunoFS does
    • What cunoFS does not do
  • Installation Prerequisites
  • Download, Installation and Activation
    • Downloading and installing
    • Activating your licence
    • Testing your installation
  • Authentication
    • Getting your credentials
    • Saving credentials as a file
    • Importing the credentials into cunoFS
    • Testing that your credentials work
  • How to use cunoFS
    • Direct Interception with cunoFS CLI
      • Usage
    • cunoFS Mount
      • Usage
    • cunoFS FlexMount
      • Usage
    • Enabling cunoFS in other environments
  • Configure cunoFS
    • Overview
      • Which mode is for me?
    • Correct operation - Levels of POSIX compatibility
      • Core File Access
        • Example use-cases
        • How to enable
      • POSIX File Access
        • Example use-cases
        • How to enable
      • POSIX Enforced File Access
        • Example use-cases
        • How to enable
    • Efficient operation in your environments
      • Where is the client?
        • Accessing object storage from within the same high-speed network
        • Accessing object storage from remote networks

POSIX managed access

  • Setting up Enforced POSIX Access
    • Key steps

User Guide

  • About this guide
  • Overview
    • Wide support for object storage providers
  • Download and installation
    • Install locations
    • Scripted installer
    • Package manager installation
      • Debian and derivatives (e.g. Ubuntu)
      • RedHat and derivatives
      • Alpine Linux
    • Other operating systems
      • macOS using Docker
      • Additional instructions for cuno-mac users
      • Windows using WSL2
      • Exposing mounted object storage to the Host OS
    • Licence activation
      • Interactive
      • Non-interactive
  • Basic loading
    • Direct Interception with cunoFS CLI
      • Advantages and Disadvantages
      • Usage
        • Fully supported shells
    • cunoFS Mount
      • Advantages
      • Disadvantages
      • Usage
        • Mount on boot
        • Unmounting
    • cunoFS FlexMount
      • Usage
      • Advantages
      • Disadvantages
  • Advanced loading
    • User-mode library
    • Environment variables
    • Shell profiles
    • Containerisation and HPC
      • Docker
        • Automatic interception
        • Manual interception
    • Singularity
    • Lmod
    • Spectrum LSF
  • Credential management
    • Create and retrieve credentials
      • Credential file formats
      • Amazon Web Services S3
      • S3-compatible solutions
      • Microsoft Azure Blob Storage
      • Google Cloud Storage
    • Import credentials
    • Pair containers and credentials
      • Microsoft Azure Blob Storage with Shared Access Signatures
      • Public Access buckets
      • Requester Pays buckets
        • Amazon AWS S3
        • Google Cloud Storage
    • List credentials
    • Unpair and purge credentials
    • Additional flags
    • Alternative methods of authenticating
      • Amazon AWS S3 using native credentials
      • AWS S3 using IAM Roles for EC2
      • Google Cloud Storage using environment variable
      • Azure Storage using environment variables
  • Transparent access to object storage
    • Specifying cloud paths
      • Examples
    • Microsoft Azure Blob Storage usage
    • AWS S3 Access Point support
    • File system behaviours when using cunoFS
      • Symbolic links
      • Hard links and Server-side copy
      • POSIX mode
      • File metadata
      • Performance
  • Configuration options
    • CUNO_OPTIONS
      • Overview
      • The static option
      • The uricompat option
        • Applications with patched URI handling
        • Example
      • The cloudroot option
    • Ownership and Permissions
      • Core File Access
      • POSIX File Access
        • Enabling for Direct Interception
        • Enabling for a cunoFS Mount
        • Usage examples
    • Other Environment Variables
      • CUNO_CREDENTIALS
      • Proxy server tunneling
      • Verbose Debug Output
  • Additional options
    • Server-side encryption
      • SSE in AWS S3
      • SSE in Google Cloud Storage
      • SSE in Microsoft Azure
  • Uninstallation
    • User-local uninstallation
    • System-wide uninstallation
    • User-specific settings
    • Package manager uninstallation
      • Debian derivatives (e.g. Ubuntu)
      • RedHat derivatives (e.g. CentOS)
      • Alpine Linux derivatives
  • Limitations
    • Direct interception
    • Maximum object size
    • Ownership, permissions and file metadata
      • Directories in Azure
      • Auto-completion
      • Memory-mapping
    • Applications
      • Python
      • Rsync
      • Fpsync
      • sudo with Direct Interception
      • Locate
        • Issues with Direct Interception
        • Instructions for using Locate
        • Setting up the Locate cron job
  • Appendix
    • Getting S3 credentials using the AWS console
    • Getting Azure credentials using Azure portal
    • Getting Google Cloud credentials using the console
  • Further assistance
cunoFS Documentation
  • Search

© Copyright 2023, PetaGene Ltd.. Revision 68f00c1a.

Built with Sphinx using a theme provided by Read the Docs.