Skip to content

Commit

Permalink
docs: borg-serve: simplify example of env in authorized_keys
Browse files Browse the repository at this point in the history
see #8318

so long as it can be assumed that the user has configured a POSIX
compliant login shell, using a simple command [1] looks cleaner, as
no ``export`` or ``;`` are used.

[1] Section "2.9.1 Simple Commands" in volume "Shell & Utilities" of POSIX.1-2024
  • Loading branch information
qyanu committed Jan 3, 2025
1 parent f9f1d21 commit 6c18a99
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions docs/usage/serve.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,12 @@ locations like ``/etc/environment`` or in the forced command itself (example bel

# Set a BORG_XXX environment variable on the "borg serve" side
$ cat ~/.ssh/authorized_keys
command="export BORG_XXX=value; borg serve [...]",restrict ssh-rsa [...]
command="BORG_XXX=value borg serve [...]",restrict ssh-rsa [...]

.. note::
The examples above use the ``restrict`` directive. This does automatically
The examples above use the ``restrict`` directive and assumes a POSIX
compliant shell set as the user's login shell.
This does automatically
block potential dangerous ssh features, even when they are added in a future
update. Thus, this option should be preferred.

Expand Down

0 comments on commit 6c18a99

Please sign in to comment.