Configuration - astrada/google-drive-ocamlfuse GitHub Wiki

By default the configuration file is first created in ~/.gdfuse/default/config (or ~/.gdfuse/label/config if a label was specified on the command line). If the program is launched with the -xdgbd flag, however, the file is instead created in ~/.config/gdfuse/default/config or ~/.config/gdfuse/label/config; see Configuration path priority for more details.

Since version 0.8.0, the configuration format is TOML.

Important behavior:

comments are allowed
the file is grouped into tables such as [auth], [mount], [docs], and [cache]
only non-default values are normally written
the file contains a top-level config_version
legacy key=value files are migrated automatically on startup
unknown keys are rejected
duplicate keys are rejected
when an existing config file is rewritten, the previous version is kept as config.bak

A full commented reference file is available at docs/wiki/full-config.example.toml.

Example

config_version = 1

[auth]
client_id = "..."
client_secret = "..."

[mount]
read_only = false
umask = "0o022"

[cache]
max_cache_size_mb = 512

Content

Specifies the interval in seconds between queries to detect server-side changes:

[mount]
metadata_cache_time=60

Specifies if the filesystem is to be mounted read-only:

[mount]
read_only=false

Specifies the umask (i.e. the bitmask of the permissions that are not present) mount option:

[mount]
umask="0o002"

Specifies the Sqlite3 busy handler timeout in milliseconds:

[cache]
sqlite3_busy_timeout=5000

Specifies whether to download Google Docs (these files are read-only by default, even if read_only=false; see editable_docs below if you want to upload changes back to Drive):

[docs]
download_docs=true

[Since 0.8.1] Specifies whether exported Google-native files should be writable and uploaded back to Drive. This works only if the configured export format for that file type is not desktop:

[docs]
editable_docs=false

Warning: Editing a Google-native file in place with tools such as vim is not advisable. Some editors save changes by replacing the original file atomically instead of modifying it in place. In this case, important formatting and metadata from the original Google document may be lost. It is safer to copy the file outside of the mounted drive, edit it there, and then copy it back, overwriting the original.

Text document export format:

[docs]
document_format="desktop"

If document_format=desktop, specifies the icon of the desktop link (default is no icon):

[docs]
document_icon=""

Drawings export format:

[docs]
drawing_format="desktop"

If drawing_format=desktop, specifies the icon of the desktop link (default is no icon):

[docs]
drawing_icon=""

Forms export format:

[docs]
form_format="desktop"

If form_format=desktop, specifies the icon of the desktop link (default is no icon):

[docs]
form_icon=""

Presentations export format:

[docs]
presentation_format="desktop"

If presentation_format=desktop, specifies the icon of the desktop link (default is no icon):

[docs]
presentation_icon=""

Spreadsheets export format:

[docs]
spreadsheet_format="desktop"

If spreadsheet_format=desktop, specifies the icon of the desktop link (default is no icon):

[docs]
spreadsheet_icon=""

Maps export format (the only valid format is desktop):

[docs]
map_format="desktop"

If map_format=desktop, specifies the icon of the desktop link (default is no icon):

[docs]
map_icon=""

Fusion table export format (the only valid format is desktop):

[docs]
fusion_table_format="desktop"

If fusion_table_format=desktop, specifies the icon of the desktop link (default is no icon):

[docs]
fusion_table_icon=""

Google Apps Script export format:

[docs]
apps_script_format="desktop"

If apps_script_format=desktop, specifies the icon of the desktop link (default is no icon):

[docs]
apps_script_icon=""

OAuth2 client ID (optional):

[auth]
client_id=""

OAuth2 client secret (optional):

[auth]
client_secret=""

OAuth2 verification code (optional). Useful when authorizing on a different machine.

[auth]
verification_code=""

Google Drive supports multiple files with the same name. This flag specifies the behavior of mv: When set to false, mv behaves in the standard way, overwriting (trashing) the target file if it exists. When set to true, mv will always keep the target file:

[mount]
keep_duplicates=false

Specifies whether to display file extensions for Google Docs:

[docs]
docs_file_extension=true

Specifies the maximum cache size in MB:

[cache]
max_cache_size_mb=512

Specifies whether to permanently turn off CURL logging (even in debug mode). Set it to true to avoid a segmentation fault on some architectures:

[network]
curl_debug_off=false

Specifies whether files removed from trash folder are permanently deleted (WARNING: permanently deleted files cannot be recovered, set it to true at your own risk):

delete_forever_in_trash_folder=false

Specifies whether to directly stream large files, so that are no more cached (please note that this does not affect file uploading):

[io]
stream_large_files=false

Specifies the threshold (in megabytes) to detect large files:

[io]
large_file_threshold_mb=16

Specifies if large files should be read-only, to avoid accidental uploads of very big files (checked only if stream_large_files=true):

[io]
large_file_read_only=false

[Removed in 0.7.0] Specifies whether to upload files in a concurrent thread:

async_upload=true

Specifies connection timeout in milliseconds:

[network]
connect_timeout_ms=5000

Specifies maximum download speed per connection in bytes/second (0 = unlimited):

[network]
max_download_speed="0"

Specifies maximum upload speed per connection in bytes/second (0 = unlimited):

[network]
max_upload_speed="0"

Specifies when a transfer is too slow. If speed (in bytes/second) is under low_speed_limit for low_speed_time (in seconds), the file transfer will be terminated (0 = don't check):

[network]
low_speed_limit=0
low_speed_time=0

Specifies maximum number of retries after an error occurred (during a Drive API request):

[network]
max_retries=8

Specifies the maximum size in bytes of an upload chunk:

[io]
max_upload_chunk_size=1099511627776

Specifies the minimum size of download/write buffers (used only if stream_large_files=true or write_buffers=true):

[io]
memory_buffer_size=1048576

Specifies the maximum memory occupation of read-ahead/write buffers, before it starts to de-allocate the oldest ones (used only if stream_large_files=true or write_buffers=true):

[io]
max_memory_cache_size=10485760

Specifies how many blocks (of memory_buffer_size bytes) to download in parallel (used only if stream_large_files=true):

[io]
read_ahead_buffers=3

When set to true, creates a new directory /lost+found where you can access unorganized files (those you can get filtering with is:unorganized owner:me in the web interface):

[mount]
lost_and_found=false

[Removed in version 0.7.20] When set to true, creates a new read-only directory /.shared where you can access all files that are shared with you (those you can get in the Shared with me section of the web interface):

shared_with_me=false

Enable XDG Base Directory support (to turn it on use -xdgbd command line option; see Configuration path priority for more information):

xdg_base_directory=false

Path of the directory storing application state (if blank uses the default):

[cache]
data_directory=""

Path of the directory storing application cache (if blank uses the default):

[cache]
cache_directory=""

Path of the directory containing log files (if blank uses the default):

[cache]
log_directory=""

[Since 0.6.20] Specifies a Google Drive folder to use as root, if you don't want to expose your entire drive from your mountpoint. You can use a folder id or a full remote path:

[mount]
root_folder=""

[Since 0.6.23] Specifies the Team Drive id, if you want to mount a Team Drive:

[mount]
team_drive_id=""

[Since 0.7.0] Enables in-memory metadata cache:

[cache]
metadata_memory_cache=true

[Since 0.7.0] Specifies every how many seconds the metadata cache is saved to sqlite3 db:

[cache]
metadata_memory_cache_saving_interval=30

[Since 0.7.0] Permits the download of files marked by Google Drive as abusive:

[io]
acknowledge_abuse=false

[Since 0.7.0] Customize the executable to run when you specify a desktop export format:

[docs]
desktop_entry_exec=""

[Since 0.7.1] Enable caching file writes in memory:

[io]
write_buffers=false

[Since 0.7.4] Disable trash bin access:

[mount]
disable_trash=false

[Since 0.7.8] Let Google Drive autodetect MIME types:

[io]
autodetect_mime=true

[Since 0.7.9] Keep target history/metadata when moving/renaming files:

[mount]
mv_keep_target=false

[Since 0.7.10] Enable async upload queue:

[async]
async_upload_queue=false

[Since 0.7.10] Size of the async upload thread pool (how many concurrent uploads can start):

[async]
async_upload_threads=10

[Since 0.7.10] Logs buffer contents for reads/writes (for debug purposes):

[logging]
debug_buffers=false

[Since 0.7.11] Path of the JSON file that contains service account credentials (downloaded during account creation):

[auth]
service_account_credentials_path=""

[Since 0.7.11] Email of the user for which the application is requesting delegated access. Works only for G Suite domains. It is ignored if service_account_credentials_path is not specified:

[auth]
service_account_user_to_impersonate=""

[Since 0.7.12] Specifies where the logs are going to be written. It can be stdout, stderr, an absolute path, or blank to keep the standard logging behavior:

[logging]
log_to=""

[Since 0.7.12] Specifies a custom Drive API scope:

[auth]
scope=""

[Since 0.7.12] Specifies a custom redirect_uri for the OAuth2 flow:

[auth]
redirect_uri=""

[Since 0.7.14] If set to true, instead of creating .desktop link files, it produces .html files with a redirect to the Google Document edit page:

[docs]
desktop_entry_as_html=false

[Since 0.7.18] Specifies the maximum number of entries (files) of the async upload queue. 0 (default) means unlimited:

[async]
async_upload_queue_max_length=0

[Since 0.7.21] Specifies whether to fetch folder data in a background thread:

[async]
background_folder_fetching=false

[Since 0.7.28] Specifies whether to use a local web server to receive the OAuth2 authorization code:

[auth]
oauth2_loopback=true

[Since 0.7.28] Specifies the port of the local web server:

[auth]
oauth2_loopback_port=8080

Document export formats

desktop format creates a shortcut to the document that will be opened in the web browser for edit. If desktop_entry_as_html=true instead of .desktop files you will get .html files.

If you don't want to export a specific kind of docs, just remove the format portion. For example, if you have this in your config file:

[docs]
drawing_format=""

no drawings will be exported.

Note that if you change any export format, you will have to clear the cache (using -cc command line option). Note also that this feature works only if you set docs_file_extension=true.

Configuration path priority

The application reads or initializes its configuration according to the following logic:

$XDG_CONFIG_HOME/gdfuse/ is read if already existing;
Otherwise $HOME/.gdfuse/ is read if already existing;
Otherwise $XDG_CONFIG_HOME/gdfuse/ is created, but only if the -xdgbd flag has been passed to the command;
Otherwise $HOME/.gdfuse/ is created.

This is done in compliance with the XDG Base Directory Specification.

The config file location logic is independent from the persisted config contents. The current TOML config does not use an xdg_base_directory key to decide where the config file itself lives.