Skip to content
A FUSE-based filesystem for
C Makefile Shell
Branch: master
Clone or download
Type Name Latest commit message Commit time
Failed to load latest commit information.
.gitignore Applied patch from fjaeger for static linking Nov 28, 2013
Makefile Update deps if compiling statically Dec 4, 2013
README.V1 Doc and license update Oct 29, 2013 Applied patch from fjaeger for static linking Nov 28, 2013
boxcache.c Added some more check Jan 27, 2014
boxcache.h let users choose install PREFIX, removed some warning Nov 5, 2013
boxhttp.h cleanup, again Oct 29, 2013
boxjson.h Fixed a couple of warnings Dec 11, 2013
boxopts.c Fix mountpoint parsing when using "--" Apr 22, 2014
boxpath.c Small fixes Jan 28, 2014
boxpath.h fixed reading dirs with more than 100 items Nov 7, 2013
boxutils.h let users choose install PREFIX, removed some warning Nov 5, 2013
gpl-3.0.txt Doc and license update Oct 29, 2013


A FUSE-based filesystem for

This software is licensed under the GPLv3 Licence and comes with NO WARRANTY. Use at your own risk. See gpl-3.0.txt.

Boxfs use the v2 version of api (see, older versions used the v1 api.


If you prefer a static build or don't want to install libapp and libjson system-wide, you can run make static to:

  • download (git clone) libapp and libjson, inside the boxfs source tree
  • compile them
  • link boxfs against those local libs


Boxfs can read options from command line or from a config file.

The simplest way to start is to run the script boxfs-init and let it create a configuration file for you.

The first time you run boxfs, you will need to complete the authentication (oauth2) process and grant access to your account. It's easy, just follow the instructions on the terminal and on your browser.

The first mount can be quite slow because boxfs will fetch and cache info (metadata, not file contents!) about your folders.

Usage: boxfs [options] [mountPoint]

  -h                          shows this help message
  -f               conffile   file containing configuration options
  -t --token_file  tokenfile  file containing oauth tokens
  -c --cache_dir   cachedir   directory used to cache metadata
  -e --expire_time N          expire time for cache entries (in minutes)
  -l --largefiles             enable support for large files (splitting)
  -v --verbose                turn on verbose syslogging
  -U --uid                    user id to use as file owner (defaults to you)
  -G --gid                    group id to use for group permissions
  -F --fperm                  file permissions (default 0644)
  -D --dperm                  directory permissions (default 0755)

When you've done using your files, unmount your filsystem with fusermount -u mountpoint

Authors and Contributors

Boxfs is written by Domenico Rotiroti with contributions from other GitHub users.

See README.V1 for a list of people who helped in the previous releases.

Known problems/limitations

  • Sharing, tags and other file metadata are not handled
  • Updates made from outside boxfs are not visible until remount
  • Can't create empty files
You can’t perform that action at this time.