X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/cfcfa1c48d95a07bb961baeef8d7658ddecce41e..25a4603438ebc74b6d2f5bdd01035da048c69148:/services/fuse/README.rst

diff --git a/services/fuse/README.rst b/services/fuse/README.rst
index f0b2677d86..23b3da70be 100644
--- a/services/fuse/README.rst
+++ b/services/fuse/README.rst
@@ -1,3 +1,7 @@
+.. Copyright (C) The Arvados Authors. All rights reserved.
+..
+.. SPDX-License-Identifier: AGPL-3.0
+
 ========================
 Arvados Keep FUSE Driver
 ========================
@@ -17,36 +21,67 @@ Installation
 Installing under your user account
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-This method lets you install the package without root access.
-However, other users on the same system won't be able to use it.
+This method lets you install the package without root access.  However,
+other users on the same system will need to reconfigure their shell in order
+to be able to use it. Run the following to install the package in an
+environment at ``~/arvclients``::
+
+  python3 -m venv ~/arvclients
+  ~/arvclients/bin/pip install arvados_fuse
+
+Command line tools will be installed under ``~/arvclients/bin``. You can
+test one by running::
+
+  ~/arvclients/bin/arv-mount --version
+
+You can run these tools by specifying the full path every time, or you can
+add the directory to your shell's search path by running::
+
+  export PATH="$PATH:$HOME/arvclients/bin"
 
-1. Run ``pip install --user arvados_fuse``.
+You can make this search path change permanent by adding this command to
+your shell's configuration, for example ``~/.bashrc`` if you're using bash.
+You can test the change by running::
 
-2. In your shell configuration, make sure you add ``$HOME/.local/bin``
-   to your PATH environment variable.  For example, you could add the
-   command ``PATH=$PATH:$HOME/.local/bin`` to your ``.bashrc`` file.
+  arv-mount --version
 
-3. Reload your shell configuration.  For example, bash users could run
-   ``source ~/.bashrc``.
+Installing on Debian and Ubuntu systems
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Installing on Debian systems
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Arvados publishes packages for Debian 11 "bullseye," Debian 12 "bookworm," Ubuntu 20.04 "focal," and Ubuntu 22.04 "jammy." You can install the Python SDK package on any of these distributions by running the following commands::
 
-1. Add this Arvados repository to your sources list::
+  sudo install -d /etc/apt/keyrings
+  sudo curl -fsSL -o /etc/apt/keyrings/arvados.asc https://apt.arvados.org/pubkey.gpg
+  sudo tee /etc/apt/sources.list.d/arvados.sources >/dev/null <<EOF
+  Types: deb
+  URIs: https://apt.arvados.org/$(lsb_release -cs)
+  Suites: $(lsb_release -cs)
+  Components: main
+  Signed-by: /etc/apt/keyrings/arvados.asc
+  EOF
+  sudo apt update
+  sudo apt install python3-arvados-fuse
 
-     deb http://apt.arvados.org/ wheezy main
+Installing on Red Hat, AlmaLinux, and Rocky Linux
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-2. Update your package list.
+Arvados publishes packages for RHEL 8 and distributions based on it. Note that these packages depend on, and will automatically enable, the Python 3.9 module. You can install the Python SDK package on any of these distributions by running the following commands::
 
-3. Install the ``python-arvados-fuse`` package.
+  sudo tee /etc/yum.repos.d/arvados.repo >/dev/null <<EOF
+  [arvados]
+  name=Arvados
+  baseurl=http://rpm.arvados.org/RHEL/\$releasever/os/\$basearch/
+  gpgcheck=1
+  gpgkey=http://rpm.arvados.org/RHEL/RPM-GPG-KEY-arvados
+  EOF
+  sudo dnf install python3-arvados-fuse
 
 Configuration
 -------------
 
 This driver needs two pieces of information to connect to
 Arvados: the DNS name of the API server, and an API authorization
-token.  You can set these in environment variables, or the file
-``$HOME/.config/arvados/settings.conf``.  `The Arvados user
+token.  `The Arvados user
 documentation
 <http://doc.arvados.org/user/reference/api-tokens.html>`_ describes
 how to find this information in the Arvados Workbench, and install it
@@ -55,12 +90,12 @@ on your system.
 Testing and Development
 -----------------------
 
-Debian packages you need to build llfuse:
+Debian packages you need to build llfuse::
 
-$ apt-get install python-dev pkg-config libfuse-dev libattr1-dev
+  sudo apt install python-dev pkg-config libfuse-dev libattr1-dev
 
 This package is one part of the Arvados source package, and it has
 integration tests to check interoperability with other Arvados
 components.  Our `hacking guide
-<https://arvados.org/projects/arvados/wiki/Hacking_Python_SDK>`_
+<https://dev.arvados.org/projects/arvados/wiki/Hacking_Python_SDK>`_
 describes how to set up a development environment and run tests.