{"id":13463924,"url":"https://github.com/vasi/squashfuse","last_synced_at":"2025-05-15T18:08:00.456Z","repository":{"id":3115528,"uuid":"4142220","full_name":"vasi/squashfuse","owner":"vasi","description":"FUSE filesystem to mount squashfs archives","archived":false,"fork":false,"pushed_at":"2025-03-04T21:39:32.000Z","size":974,"stargazers_count":309,"open_issues_count":9,"forks_count":70,"subscribers_count":19,"default_branch":"master","last_synced_at":"2025-04-02T10:08:07.457Z","etag":null,"topics":["hacktoberfest"],"latest_commit_sha":null,"homepage":"","language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vasi.png","metadata":{"files":{"readme":"README","changelog":"NEWS","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2012-04-25T23:03:48.000Z","updated_at":"2025-04-01T20:26:49.000Z","dependencies_parsed_at":"2023-07-05T18:17:22.634Z","dependency_job_id":"530d341c-587d-4656-aca2-e3697b392c0e","html_url":"https://github.com/vasi/squashfuse","commit_stats":{"total_commits":387,"total_committers":17,"mean_commits":"22.764705882352942","dds":"0.16537467700258401","last_synced_commit":"d1d7ddafb765098b34239eacaf2f9abee1fbc27c"},"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vasi%2Fsquashfuse","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vasi%2Fsquashfuse/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vasi%2Fsquashfuse/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vasi%2Fsquashfuse/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vasi","download_url":"https://codeload.github.com/vasi/squashfuse/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248027407,"owners_count":21035594,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hacktoberfest"],"created_at":"2024-07-31T14:00:30.577Z","updated_at":"2025-04-09T11:06:08.779Z","avatar_url":"https://github.com/vasi.png","language":"C","funding_links":[],"categories":["C"],"sub_categories":[],"readme":"         squashfuse - Mount SquashFS archives using FUSE\n\n               https://github.com/vasi/squashfuse\n\nSquashfuse lets you mount SquashFS archives in user-space. It supports almost\nall features of the SquashFS format, yet is still fast and memory-efficient. So\nthat everyone can use it, squashfuse supports many different operating systems\nand is available under a permissing license.\n\nSquashFS is an efficiently compressed, read-only storage format. Support for it\nhas been built into the Linux kernel since 2009. It is very common on Live CDs\nand embedded Linux distributions.\n\nQuick start:\n  $ ./configure \u0026\u0026 make\n  $ ./squashfuse foo.squashfs mountpoint\n\n\n1. Table of contents\n====================\n0. Introduction\n1. Table of contents\n2. Getting started\n   - System requirements\n   - Getting the source\n   - Building\n   - Usage\n3. About squashfuse\n   - Is squashfuse for you?\n   - What's included?\n   - Features\n   - Known bugs\n4. References\n   - Licensing\n   - Acknowledgements\n   - Links\n\n\n2. Getting started\n==================\n\n2a. System requirements\n-----------------------\nTo build and use squashfuse, you must be able to use the terminal of your\noperating system.\n\nRuntime requirements:\n  - FUSE 2.5 or later\n  - At least one of the following compression libraries\n      - zlib\n      - lzo2\n      - xz (aka. liblzma)\n      - lz4\n      - zstd\n  - (optional) libattr, for better extended attribute support on Linux\n\nBuild requirements:\n  - A C compiler\n  - make (any variant)\n  - sed\n  - (optional) pkg-config, for detection of dependencies\n\nTo build from the development repository, rather than a tarball, you'll need:\n  - autoconf 2.60 or later\n  - automake 1.11 or later\n  - libtool 2\n\nKnown fully-supported platforms:\n  - Linux\n  - Mac OS X\n  - FreeBSD\n  - NetBSD\n  - OpenIndiana\n  - Android\n  - other platforms may work too!\n\nFor a precise list of packages you will need on your OS, and other platform\nnotes, please see the file `PLATFORMS'.\n\n\n2b. Getting the source\n----------------------\nThe squashfuse distribution can be downloaded from SourceForge:\nhttps://sourceforge.net/projects/squashfuse/files/\n\nThe development repository uses git, at GitHub:\nhttp://github.com/vasi/squashfuse\n\n\n2c. Installation\n----------------\nSquashfuse is built with the usual `configure \u0026\u0026 make'. If you need more\ndetailed instructions:\n\n0. Ensure you're at your terminal, in the directory containing this README.\n\n1. (if needed) If the file `configure' is already present, skip this step.\n   Otherwise, run `./autogen.sh' to generate one.\n\n2. Run `./configure' to set up the build. You can find useful configuration\n   options in the file `CONFIGURATION', or by running `./configure --help'.\n\n   If configure fails, check that you really have all the requirements\n   installed. You may also want to check the `PLATFORMS' file to see if there\n   are any special notes for your operating system.\n\n3. Run `make' to build `squashfuse'.\n\n4. (optional) If you want to use squashfuse in this directory, that's ok.\n   But if you'd rather install it, run `make install'. If you need root\n   privileges, `sudo make install' may work.\n\n\n2d. Example: Ubuntu\n-------------------\n\nFor example on Ubuntu 22.04:\n\n  $ sudo apt install gcc make pkg-config libfuse3-dev \\\n    zlib1g-dev liblzo2-dev liblzma-dev liblz4-dev libzstd-dev \\\n    automake autoconf libtool \\\n    fuse3 fio squashfs-tools\n  $ ./autogen.sh\n  $ ./configure\n  $ make -j4\n  $ make check\n  $ sudo make install\n\n2e. Example: NixOS\n------------------\n\nFor example on NixOS:\n\n  $ nix-shell\n  $ ./autogen.sh\n  $ ./configure\n  $ make -j4\n\nTo install to your system, a custom Nix package should be built. Otherwise,\nyou can simply move the binaries to `~/.local/bin'\n\n2f. Example: macOS\n------------------\n\nOn macOS, for example, install macFUSE, and then:\n\n  $ brew install autoconf automake pkg-config libtool lzo xz\n  $ ./autogen.sh\n  $ ./configure --prefix=/usr/local/ \\\n        --with-lzo=/usr/local/Cellar/lzo/2.10 \\\n        --with-xz=/usr/local/Cellar/xz/5.4.4\n  $ make -j\n  $ make check\n  $ make install\n\n2g. Usage\n---------\nYou'll need a SquashFS archive to use squashfuse. If you don't already have\none, you can create one using the `mksquashfs' utility from the squashfs-tools\nproject.\n\nTo create a SquashFS archive:\n  $ mksquashfs DIRECTORY ARCHIVE\n\nTo mount a SquashFS archive with squashfuse:\n  $ squashfuse ARCHIVE MOUNTPOINT\n\nTo unmount when you're done:\n  $ umount MOUNTPOINT         # On Mac/BSD\n  $ fusermount -u MOUNTPOINT  # On Linux\n\nFor more options, see the man page squashfuse(1).\n\n\n3. About squashfuse\n===================\n\n3a. Is squashfuse for you?\n--------------------------\nSquashfuse is a great option if you have a SquashFS archive, and:\n  - You're not running Linux, or\n  - You don't have root access, or\n  - You're too concerned about security to use root, or\n  - You find it inconvenient to elevate privileges, or\n  - SquashFS is not built into your kernel, but FUSE is, or\n  - You want to hack on the SquashFS format without risking kernel panics.\n\nSquashfuse is probably not the right tool for the job, if:\n  - You don't have FUSE.\n    More and more systems have FUSE, but some don't. Squashfuse requires it.\n    \n  - You have a very old SquashFS archive.\n    Neither squashfuse nor the Linux kernel support SquashFS versions less\n    than 4.0. Use `unsquashfs' from the squashfs-tools project.\n\n  - You want to create or modify a SquashFS archive.\n    Neither squashfuse nor the Linux kernel support write access, use\n    `mksquashfs' from squashfs-tools.\n\n  - You want to extract an entire SquashFS archive.\n    If you don't want to mount anything, it's more efficient and convenient\n    to just use unsquashfs.\n\n  - You want your root filesystem `/' to be SquashFS.\n    This isn't well-tested, though it may be possible.\n  \n  - You're highly concerned about bugs.\n    The SquashFS kernel module has seen much more testing than squashfuse.\n\n\nIf you don't yet use SquashFS, consider starting, now that squashfuse exists.\nFor many uses, the chief drawbacks of SquashFS were requiring Linux and root\naccess, but squashfuse has that covered.\n\n  - Use SquashFS for archival and backup, instead of tar.\n    It offers faster creation (multi-core), and browsing without unpacking.\n  \n  - Use SquashFS instead of zip. \n    It has better compression, and faster directory lookup.\n    \n  - Use SquashFS instead of compressed disk images like DMG, uzip or Partimage.\n    It has better compression and portability.\n  \n\n3b. What's included?\n--------------------\nSquashfuse currently comprises three programs:\n\n  * squashfuse      Allows you to mount a squashfs filesystem.\n  \n  * squashfuse_ll   Like `squashfuse', but implemented using the low-level\n                    FUSE API. It's a tiny bit faster, but less portable.\n  \n  * squashfuse_ls   Lists all the files in a squashfs archive. A demonstration\n                    of using the squashfuse core in the absence of FUSE.\n\n\n3c. Features\n------------\nSquashfuse supports the following SquashFS features: \n  - zlib, LZO, LZMA2, LZ4 and zstd decompression\n  - Fast, indexed directory lookup\n  - Fast, indexed seeking within files\n  - Caching of decompressed blocks\n  - De-duplicated files\n  - Sparse files\n  - Extended attributes\n  - Files larger than 4GB\n\nSquashfuse is missing the following features:\n  - LZMA1 compression (deprecated)\n  - Support for SquashFS versions less than 4.0\n  - Multi-core decompression\n\n\n3c. Known bugs\n--------------\n- On 32-bit systems with a large inode cache, when mounting a large SquashFS\n  archive created with the \"-no-exports\" option, squashfuse_ll may use a large\n  amount of memory. This is due to a bug in the FUSE API, where ino_t is shrunk\n  to 32-bits.\n\n\n4. References\n=============\n\n4a. Licensing\n-------------\nSquashfuse is copyright (c) 2012-2014 Dave Vasilevsky \u003cdave@vasilevsky.ca\u003e\nSquashfuse is distributed under the 2-clause BSD license. See the file LICENSE\nfor details.\n\n\n4b. Acknowledgements\n--------------------\nThanks to:\n\n* Phillip Lougher, for designing the SquashFS format, and implementing support\n  in the kernel. Also for providing permission to use and distribute\n  squashfs_fs.h under a BSD-style license.\n\n* Maël Kerbiriou, for implementing LZ4 support.\n\n\n4c. Links\n---------\n* SquashFS\n  - SquashFS home page, includeing squashfs-tools:\n    http://squashfs.sourceforge.net/\n  - squashfs-tools for non-Linux: https://github.com/vasi/squashfs-tools\n\n* FUSE\n  - FUSE home page: http://fuse.sourceforge.net/\n  - OSXFUSE (FUSE for Macs): http://osxfuse.github.io/\n\n* Other implementations of the SquashFS format\n  - Linux kernel: https://github.com/torvalds/linux/tree/master/fs/squashfs\n  - 7-zip / p7zip: http://www.7-zip.org/\n  - GRUB 2 bootloader: http://www.gnu.org/software/grub/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvasi%2Fsquashfuse","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvasi%2Fsquashfuse","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvasi%2Fsquashfuse/lists"}