services/fuse/README.rst

   1 .. Copyright (C) The Arvados Authors. All rights reserved.
   2 ..
   3 .. SPDX-License-Identifier: AGPL-3.0
   4
   5 ========================
   6 Arvados Keep FUSE Driver
   7 ========================
   8
   9 Overview
  10 --------
  11
  12 This package provides a FUSE driver for Keep, the Arvados_ storage
  13 system.  It allows you to read data from your collections as if they
  14 were on the local filesystem.
  15
  16 .. _Arvados: https://arvados.org/
  17
  18 Installation
  19 ------------
  20
  21 Installing under your user account
  22 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  23
  24 This method lets you install the package without root access.
  25 However, other users on the same system won't be able to use it.
  26
  27 1. Run ``pip install --user arvados_fuse``.
  28
  29 2. In your shell configuration, make sure you add ``$HOME/.local/bin``
  30    to your PATH environment variable.  For example, you could add the
  31    command ``PATH=$PATH:$HOME/.local/bin`` to your ``.bashrc`` file.
  32
  33 3. Reload your shell configuration.  For example, bash users could run
  34    ``source ~/.bashrc``.
  35
  36 Installing on Debian systems
  37 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  38
  39 1. Add this Arvados repository to your sources list::
  40
  41      deb http://apt.arvados.org/buster buster main
  42
  43 2. Update your package list.
  44
  45 3. Install the ``python3-arvados-fuse`` package.
  46
  47 Configuration
  48 -------------
  49
  50 This driver needs two pieces of information to connect to
  51 Arvados: the DNS name of the API server, and an API authorization
  52 token.  You can set these in environment variables, or the file
  53 ``$HOME/.config/arvados/settings.conf``.  `The Arvados user
  54 documentation
  55 <http://doc.arvados.org/user/reference/api-tokens.html>`_ describes
  56 how to find this information in the Arvados Workbench, and install it
  57 on your system.
  58
  59 Testing and Development
  60 -----------------------
  61
  62 Debian packages you need to build llfuse:
  63
  64 $ apt-get install python-dev pkg-config libfuse-dev libattr1-dev
  65
  66 This package is one part of the Arvados source package, and it has
  67 integration tests to check interoperability with other Arvados
  68 components.  Our `hacking guide
  69 <https://arvados.org/projects/arvados/wiki/Hacking_Python_SDK>`_
  70 describes how to set up a development environment and run tests.