ONECLIENT(1)

NAME
oneclient - Onedata command line client

SYNOPSIS
oneclient [-h|--help] [-V|--version] [-u|--unmount] [-c|--config config_path] [-H|--host hostname] [-P|--port port] [-i|--insecure] [-t|--token access_token] [-l|--log-dir log_path] [--force-proxy-io] [--force-direct-io] [--buffer-scheduler-thread-count threads] [--communicator-thread-count threads] [--scheduler-thread-count threads] [--storage-helper-thread-count threads] [--no-buffer] [--read-buffer-min-size size] [--read-buffer-max-size size] [--read-buffer-prefetch-duration duration] [--write-buffer-min-size size] [--write-buffer-max-size size] [--write-buffer-flush-delay delay] [-f|--foreground] [-d|--debug] [-s|--single-thread] [-o|--opt mount_options] mountpoint

DESCRIPTION
oneclient provides command line interface to mount Onedata (http://onedata.org) distributed file system data spaces on local machine using Fuse.

oneclient relies on Fuse (Filesystem in Userspace) library, which enables POSIX access to remote data managed by Onedata platform. Fuse command line options (-f, -d, -s and -o) can be passed directly to the oneclient on the command line or in the config file (see oneclient.conf(5)).

USAGE
In order to connect to Onedata services, oneclient needs credentials in the form of access token to authenticate the user remotely on the Oneprovider side. Access tokens can be generated in the web user interface or using the REST API.

oneclient connects to a specific Oneprovider service selected by the user and specified using -H or --host option and port using -P or --port. Port can be omitted if Oneprovider service is deployed on default port (5555).

NOTE: If you are connecting to a Onedata provider service, which does not have a globally trusted certificate, you will have to use -i or --insecure on every oneclient invocation.

  Access tokens
In order to get an authentication token, login to Onezone web user interface, expand Access Tokens menu on the left and press Create new access token. Copy the generated token and pass it to the oneclient command line options using -t or --token option.

Additionally, the access token can be specified in the ONECLIENT_ACCESS_TOKEN environment variable.

  Mounting spaces
When oneclient connects successfully to the Oneprovider, the <mountpoint> directory will contain the entire list of user spaces, and all regular command line tools can be used to access and modify the files and directories in there, as long as the permissions allow for.

  Proxy IO and Direct IO modes
oneclient has a unique feature enabling it to transparently detect whenever it has direct access to storage which is used by some Oneprovider instance managing user space, and in such case redirects all IO operations directly to the storage without going through the Oneprovider service (Direct IO mode). This feature is detected by oneclient automatically.

CONFIGURATION
Beside the command line configuration options, oneclient reads options from a global configuration file located by default at /usr/local/etc/oneclient.conf (/etc/oneclient.conf when installed from a distribution package). For details see oneclient.conf(5).

OPTIONS

-h, --help
    Show this help and exit.

-V, --version
    Show current oneclient version and exit.

-u, --unmount
    Unmount oneclient and exit.

-c <config_path>, --config <config_path>
    Specify path to user config file.

-H <host>, --host <host>
    Specify the hostname of the Oneprovider instance to which the oneclient should connect.

-P <port>, --port <port>
    Specify the port to which the oneclient should connect on the Oneprovider.

-i, --insecure
    Disable verification of server certificate, allows to connect to servers without valid certificate.

-t <token>, --token <token>
    Specify Onedata access token for authentication and authorization.

-l <log_path>, --log-dir <log_path>
    Specify custom path for oneclient logs.

--force-proxy-io
    Force proxied access to storage via Oneprovider for all spaces.

--force-direct-io
    Force direct access to storage for all spaces.

--buffer-scheduler-thread-count <threads>
    Specify number of parallel buffer scheduler threads.

--communicator-thread-count <threads>
    Specify number of parallel communicator threads.

--scheduler-thread-count <threads>
    Specify number of parallel scheduler threads.

--storage-helper-thread-count <threads>
    Specify number of parallel storage helper threads.

--no-buffer
    Disable in-memory cache for input/output data blocks.

--read-buffer-min-size <size>
    Specify minimum size in bytes of in-memory cache for input data blocks.

--read-buffer-max-size <size>
    Specify maximum size in bytes of in-memory cache for input data blocks.

--read-buffer-prefetch-duration <duration>
    Specify read ahead period in seconds of in-memory cache for input data blocks.

--write-buffer-min-size <size>
    Specify minimum size in bytes of in-memory cache for output data blocks.

--write-buffer-max-size <size>
    Specify maximum size in bytes of in-memory cache for output data blocks.

--write-buffer-flush-delay <delay>
    Specify idle period in seconds before flush of in-memory cache for output data blocks.

-f, --foreground
    Foreground operation (see fuse(8)).

-d, --debug
    Enable debug mode (implies -f) (see fuse(8)).

-s, --single-thread
    Single-threaded operation (see fuse(8)).

-o <mount_options>, --opt <mount_options>
    Pass mount arguments directly to FUSE (see fuse.mount(8)).

ENVIRONMENT VARIABLES
Some options in the config file can be overriden using environment variables, whose names are capitalized version of the config options. The available environment variables are:

ONECLIENT_CONFIG
    Allows to specify path to user config file.

ONECLIENT_PROVIDER_HOST
    Allows to specify the Oneprovider host to which the oneclient will connect.

ONECLIENT_PROVIDER_PORT
    Allows to specify Oneprovider port, to which oneclient will connect (default: 5555).

ONECLIENT_INSECURE
    If set to 1, disables verification of server certificate and allows to connect to servers without valid certificate. (default: 0).

ONECLIENT_ACCESS_TOKEN
    Allows to specify Onedata access token for authentication and authorization.

ONECLIENT_LOG_DIR
    Allows to specify the log directory for oneclient (default: /tmp).

ONECLIENT_FUSE_FOREGROUND
    If set to 1, oneclient will run in foreground mode (default: 0).

ONECLIENT_FUSE_DEBUG
    If set to 1, oneclient will run in debug mode (default: 0).

ONECLIENT_FUSE_SINGLE_THREAD
    If set to 1, oneclient will run in single thread mode (default: 0).

ONECLIENT_MOUNTPOINT
    Allows to specify default mountpoint for oneclient.

EXAMPLES
In order to simply mount your spaces into some local folder use the following command:

oneclient -H onedata.org -t <ACCESS_TOKEN> ~/mnt/onedata

Connect without validating server certificate and pass token in environment variable:

export ONECLIENT_INSECURE=1

export ONECLIENT_ACCESS_TOKEN=<ACCESS_TOKEN>

export ONECLIENT_PROVIDER_HOST=<ONEPROVIDER_HOST>

oneclient ~/mnt/onedata

To unmount Onedata spaces use oneclient:

oneclient -u ~/mnt/onedata

or using Fuse:

fusermount -u ~/mnt/onedata

COPYRIGHT
Copyright (C) 2014-2017, Academic Computer Centre CYFRONET AGH, Krakow, Poland. Released under the Apache 2.0 license.

SEE ALSO
oneclient.conf(5), fuse(8), fuse.mount(8)