GoAdmio

compress

Install FUSE and the fusecompress compressed filesystem

On this page: Overview · Quick start · Syntax · Output · Examples · Troubleshooting · Details · See also


Overview

/go/compress installs the tools needed to use a compressed filesystem on the server. It installs FUSE (Filesystem in Userspace) and fusecompress, which transparently compresses files written to a mounted folder and decompresses them when they are read. A typical use is a backup folder such as /backup, where compression saves disk space.

The command only installs the tools. It doesn't mount anything or change any existing folder.

[!NOTE] On AlmaLinux, Rocky, CentOS, Red Hat, and Fedora the command installs fusecompress itself. On Debian and Ubuntu it installs only FUSE and the libraries needed to build it, so fusecompress is not available afterwards. See Supported systems.


Quick start

# Install FUSE and fusecompress
/go/compress

Syntax

/go/compress

The command takes no options or arguments. Any you pass are ignored (they are only written to the log).

Run it as root. On Debian and Ubuntu the package installation steps are not run with sudo.


Output

The command shows a progress bar titled Installing FUSE & Compressed Filesystem Tools, followed by the output of the package manager and, on RHEL-family systems, of the build.

Situation What you see
Supported system Package manager output, plus build output if fusecompress has to be compiled.
Unsupported operating system Nothing beyond the progress bar.

The command prints no summary and sets no exit code of its own, so a failed package install isn't reported. Check the output, and confirm with command -v fusecompress.

Every run is logged with a timestamp, for example [Nov 20 09:15:02]# compress, to /var/log/go/compress.log.


Examples

# Install the tools
/go/compress
# Check that fusecompress is available
command -v fusecompress
# Mount a folder with transparent compression (example from the script)
mkdir -p /backup
fusecompress -o allow_other /backup
# Mount it automatically at boot: add this line to /etc/fstab
/backup /backup fuse.fusecompress allow_other,defaults 0 0
# Unmount it
fusermount -u /backup

The mount examples are from comments in the script. The command doesn't run them. Test them on a non-critical folder first. A FUSE filesystem uses more CPU and is slower than a native one.


Troubleshooting

Symptom Likely cause Fix
fusecompress: command not found on Debian or Ubuntu The command only installs build dependencies there. Build fusecompress from source (see Details).
Unable to locate package lzo2-dev or libxz-dev These package names don't exist on all releases. Install the equivalent development packages manually, typically liblzo2-dev and liblzma-dev.
No match for argument: fuse-compress or fuse-zip on RHEL-family systems The package isn't in the enabled repositories. Enable EPEL if needed. The command builds fusecompress from source in any case.
git: command not found, or gcc or make not found The build tools aren't installed. Install git, gcc, and make, then run the command again.
git clone fails The server can't reach GitHub. Check the server's network and DNS settings.
Nothing happens The operating system isn't supported. Supported: AlmaLinux, Rocky, CentOS, Red Hat, Fedora, Debian, Ubuntu.
Permission denied or Could not open lock file on Debian or Ubuntu You aren't running as root. Run the command as root.
The mount is gone after a reboot Mounts made by hand aren't permanent. Add the /etc/fstab line from Examples.
/usr/local/goadmio/tmp/fusecompress is using space The build files are kept after installing. Delete the folder, or run clean.

Details

Supported systems

Family Systems What is installed
RHEL AlmaLinux, Rocky, CentOS, Red Hat, Fedora FUSE, fuse-zip, and fuse-compress from the repositories. If fusecompress is still missing, it is built from source and installed to /usr/local.
Debian Debian, Ubuntu FUSE, the FUSE development files, and the compression development libraries. fusecompress is not installed.

The operating system is read from /usr/local/goadmio/linux/os.db. On any other system the command does nothing.

RHEL-family steps

  1. Installs fuse, fuse-zip, and fuse-compress with dnf.
  2. If fusecompress is still not available:
    1. Installs the build tools and libraries autoconf, libtool, fuse-devel, zlib-devel, bzip2-devel, lz4-devel, lzo-devel, and xz-devel.
    2. Clones the fusecompress source from https://github.com/FS-make-simple/fusecompress.git into /usr/local/goadmio/tmp/fusecompress.
    3. Runs ./autogen.sh and ./configure --prefix=/usr/local.
    4. Compiles with make using all CPU cores, then runs make install and ldconfig.

The build needs git, a C compiler, and make, which the command doesn't install. Running the command again is safe: the build is skipped once fusecompress is available.

Debian and Ubuntu steps

  1. Updates the package lists with apt update.
  2. Installs fuse, libfuse-dev, zlib1g-dev, libbz2-dev, liblz4-dev, lzo2-dev, and libxz-dev.

On Debian and Ubuntu, fusecompress has to be downloaded and built manually, using the same source and build steps as on the RHEL family.


See also

Command Description
clean Delete old backups, trash, session files, and expired mail to free up disk space
backup Create a backup for all GoAdmio accounts (local and remote)
storage Auto-mount the /storage folder on boot using rclone
s3 Mount an S3 bucket on a GoAdmio server
package Install all base packages required by GoAdmio