Skip to main content

User-space file system for Dropbox

Project description

dbxfs is not licensed to be hosted on GitHub in response to GitHub’s history of exploitative behavior. If you are reading this on GitHub this is an illegal mirror. Do not use and report usage to the author https://twitter.com/cejetvole

dbxfs allows you to mount your Dropbox folder as if it were a local filesystem. It differs from the official Dropbox client in two main ways:

  • Internet connectivity is required for access

  • No disk space is required for access, but will cache if disk space is available

dbxfs has been tested on OpenBSD, Linux, and macOS but it should run on any POSIX system that provides a FUSE-compatible library or has the ability to mount SMB shares. Windows support is coming very soon. It runs on non-x86 architectures like ARM. It doesn’t require a specific file system.

It is written for Python 3.5+ and is licensed under the GPLv3.

Disclaimer: dbxfs is not affiliated with Dropbox, Inc.

Installation

If you are on Linux, you must install your OS’s FUSE library. On Debian/Ubuntu, install the libfuse2 package, on Fedora install fuse.

Run the following command:

$ pip3 install dbxfs

On Arch Linux and derivatives, you can find it in the AUR as dbxfs.

Usage

Use dbxfs like you would use the mount command:

$ dbxfs <mount_point>

To unmount your Dropbox folder on Linux systems, you can use fusermount -u <mount_point>, on all other systems use umount.

You can see the full list of command line options by passing -h to the dbxfs command.

Advanced Refresh Token Storage

By default dbxfs stores your refresh token in an encrypted file but you may want to store it in a GPG encrypted file or something else. To do that you must first obtain a refresh token. You can obtain a refresh token by running the following command:

$ dbxfs --get-refresh-token

Once you have obtained the refresh token, encrypt it with the program of your choice and store the result somewhere. After that, you must edit the dbxfs config file. You can find the location of the config file by running the following command:

$ dbxfs --print-default-config-file

The config file is a JSON encoded file. Add the following JSON key to the top-level JSON object in that file:

"refresh_token_command": ["gpg", "--decrypt", "/path/to/refresh/token/file.gpg"]

Adapt it to a decryption program of your choice. This configuration works great for storing the refresh token using a OpenPGP card.

Contact

Rian Hunter @cejetvole

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dbxfs-1.0.66.tar.gz (51.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

dbxfs-1.0.66-py3-none-any.whl (55.2 kB view details)

Uploaded Python 3

File details

Details for the file dbxfs-1.0.66.tar.gz.

File metadata

  • Download URL: dbxfs-1.0.66.tar.gz
  • Upload date:
  • Size: 51.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.2

File hashes

Hashes for dbxfs-1.0.66.tar.gz
Algorithm Hash digest
SHA256 b9c1e11a7d78aa93ee3c28ae626dfff57df80c930f635eef48c50eaaf4202487
MD5 1336fdfd26eec866f9717453144be25e
BLAKE2b-256 24a84ea1af613a0cf100a9e7b22b52379c11a398cd9408382e298fde08419252

See more details on using hashes here.

File details

Details for the file dbxfs-1.0.66-py3-none-any.whl.

File metadata

  • Download URL: dbxfs-1.0.66-py3-none-any.whl
  • Upload date:
  • Size: 55.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.2

File hashes

Hashes for dbxfs-1.0.66-py3-none-any.whl
Algorithm Hash digest
SHA256 2cb30fe63fc89462b799653138fa3e9a6d7599a58b5c9bc7d80f23c96b4df8b4
MD5 a195922368b751c00954fe9df65a2cb1
BLAKE2b-256 d77f7f123b47f52420d16f569276bbda0a3be7a0c9e33ae9ad7b0bf43a7a11b4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page