21020: Update arv-mount service definition
[arvados.git] / doc / sdk / fuse / install.html.textile.liquid
1 ---
2 layout: default
3 navsection: sdk
4 navmenu: FUSE Driver
5 title: Installing the FUSE Driver
6 ...
7 {% comment %}
8 Copyright (C) The Arvados Authors. All rights reserved.
9
10 SPDX-License-Identifier: CC-BY-SA-3.0
11 {% endcomment %}
12
13 The Arvados FUSE driver is a Python utility that allows you to browse Arvados projects and collections in a filesystem, so you can access that data using existing Unix tools.
14
15 h2. Installation
16
17 If you are logged in to a managed Arvados VM, the @arv-mount@ utility should already be installed.
18
19 To use the FUSE driver elsewhere, you can install from a distribution package or pip.
20
21 h2. Option 1: Install from distribution packages
22
23 First, "add the appropriate package repository for your distribution":{{ site.baseurl }}/install/packages.html.
24
25 {% assign arvados_component = 'python3-arvados-fuse' %}
26
27 {% include 'install_packages' %}
28
29 h2. Option 2: Install with pip
30
31 Run @pip install arvados_fuse@ in an appropriate installation environment, such as a virtualenv.
32
33 Note: The FUSE driver depends on the @libcurl@ and @libfuse@ C libraries.  To install the module you may need to install development headers from your distribution.  On Debian-based distributions you can install them by running:
34
35 <notextile>
36 <pre><code># <span class="userinput">apt install build-essential python3-dev libcurl4-openssl-dev libfuse-dev libssl-dev</span>
37 </code></pre>
38 </notextile>
39
40 h2. Usage
41
42 For an introduction of how to mount and navigate data, refer to the "Access Keep as a GNU/Linux filesystem":{{site.baseurl}}/user/tutorials/tutorial-keep-mount-gnu-linux.html tutorial.