Skip to content

Commit eccdf51

Browse files
authored
Docs for recipes_only (#4238)
* Docs for recipes_only * Wording review
1 parent 97a504a commit eccdf51

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

devops/using_conancenter.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,14 @@ we recommend building your own binary packages from source:
103103

104104
- Read more: :ref:`creating and hosting your own Conan Center binaries <devops_conancenter_hosting_your_own_conancenter_fork>`
105105

106+
If the ``conancenter`` remote is used directly, your organization might require
107+
that the binaries are built from source, and not downloaded directly from ConanCenter.
108+
This can exceptionally be achieved with the ``recipes_only`` field
109+
:ref:`in the remote configuration<reference_config_files_remotes_json>`, but it is
110+
highly likely that you will also want to build the packages from source, and not
111+
depend on the recipes and binaries provided by ConanCenter. See the above link
112+
for more information.
113+
106114
Control and customization
107115
-------------------------
108116
It is very common for users of dependencies to require custom changes to external

reference/config_files/remotes.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,10 @@ The fields for each remote are:
3535
* ``disabled`` (Optional, ``bool`` value, ``false`` by default): If the remote is enabled or not to be used by commands
3636
like search, list, download and upload. Notice that a disabled remote can be used to authenticate against it even
3737
if it's disabled.
38+
* ``allowed_packages``: (Optional, ``list`` of ``string`` values): List of recipes that are allowed to be
39+
downloaded from this remote. If the list is empty or not present, all packages are allowed. Uses fnmatch rules.
40+
* ``recipes_only``: (Optional, ``bool`` value, ``false`` by default): If true, only recipes will be
41+
downloaded from this remote, no binaries will be downloaded.
3842

3943

4044
.. seealso::

0 commit comments

Comments
 (0)