Skip to content

Commit

Permalink
doc: add recommended user configuration
Browse files Browse the repository at this point in the history
  • Loading branch information
jkloetzke committed Mar 7, 2024
1 parent 5363c6c commit 9f789e6
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions doc/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,28 @@ setuptools_scm, wheel,...
Linux/POSIX platform notes
==========================

Recommended configuration
-------------------------

It is recommended to create a user global Bob configuration file which applies
to all projects. The following settings will ensure that shareable packages are
put into a common location and that downloaded source tarballs are mirrored
locally::

preMirrorPrepend:
scm: url
url: "https?://.*/(.*)"
mirror: "~/.cache/bob/mirror/\\1"
upload: True
share:
path: ~/.cache/bob/pkgs
quota: "5G"
autoClean: True

The above configuration should be stored as ``~/.config/bob/default.yaml``. See
:ref:`configuration-config-mirrors` and :ref:`configuration-config-share` for
more details.

Shell completion
----------------

Expand Down

0 comments on commit 9f789e6

Please sign in to comment.