conan.conf
The typical location of the conan.conf file is the directory ~/.conan/:
[log]
run_to_output = True # environment CONAN_LOG_RUN_TO_OUTPUT
run_to_file = False # environment CONAN_LOG_RUN_TO_FILE
level = 50 # environment CONAN_LOGGING_LEVEL
# trace_file = # environment CONAN_TRACE_FILE
print_run_commands = False # environment CONAN_PRINT_RUN_COMMANDS
[general]
default_profile = default
compression_level = 9 # environment CONAN_COMPRESSION_LEVEL
sysrequires_sudo = True # environment CONAN_SYSREQUIRES_SUDO
request_timeout = 30 # environment CONAN_REQUEST_TIMEOUT
# sysrequires_mode = enabled # environment CONAN_SYSREQUIRES_MODE (allowed modes enabled/verify/disabled)
# vs_installation_preference = Enterprise, Professional, Community, BuildTools # environment CONAN_VS_INSTALLATION_PREFERENCE
# verbose_traceback = False # environment CONAN_VERBOSE_TRACEBACK
# bash_path = "" # environment CONAN_BASH_PATH (only windows)
# recipe_linter = False # environment CONAN_RECIPE_LINTER
# read_only_cache = True # environment CONAN_READ_ONLY_CACHE
# pylintrc = path/to/pylintrc_file # environment CONAN_PYLINTRC
# cache_no_locks = True
# user_home_short = your_path # environment CONAN_USER_HOME_SHORT
# skip_vs_projects_upgrade = False # environment CONAN_SKIP_VS_PROJECTS_UPGRADE
# non_interactive = False # environment CONAN_NON_INTERACTIVE
# conan_make_program = make # environment CONAN_MAKE_PROGRAM (overrides the make program used in AutoToolsBuildEnvironment.make)
# cmake_generator # environment CONAN_CMAKE_GENERATOR
# http://www.vtk.org/Wiki/CMake_Cross_Compiling
# cmake_toolchain_file # environment CONAN_CMAKE_TOOLCHAIN_FILE
# cmake_system_name # environment CONAN_CMAKE_SYSTEM_NAME
# cmake_system_version # environment CONAN_CMAKE_SYSTEM_VERSION
# cmake_system_processor # environment CONAN_CMAKE_SYSTEM_PROCESSOR
# cmake_find_root_path # environment CONAN_CMAKE_FIND_ROOT_PATH
# cmake_find_root_path_mode_program # environment CONAN_CMAKE_FIND_ROOT_PATH_MODE_PROGRAM
# cmake_find_root_path_mode_library # environment CONAN_CMAKE_FIND_ROOT_PATH_MODE_LIBRARY
# cmake_find_root_path_mode_include # environment CONAN_CMAKE_FIND_ROOT_PATH_MODE_INCLUDE
# cpu_count = 1 # environment CONAN_CPU_COUNT
# Change the default location for building test packages to a temporary folder
# which is deleted after the test (Defaulted to False).
# temp_test_folder = True # environment CONAN_TEMP_TEST_FOLDER
[storage]
# This is the default path, but you can write your own. It must be an absolute path or a
# path beginning with "~" (if the environment var CONAN_USER_HOME is specified, this directory, even
# with "~/", will be relative to the conan user home, not to the system user home)
path = ~/.conan/data
[proxies]
# Empty section will try to use system proxies.
# If don't want proxy at all, remove section [proxies]
# As documented in http://docs.python-requests.org/en/latest/user/advanced/#proxies
# http = http://user:pass@10.10.1.10:3128/
# http = http://10.10.1.10:3128
# https = http://10.10.1.10:1080
# Default settings now declared in the default profile
Log
The level variable, defaulted to 50 (critical events), declares the LOG level .
If you want to show more detailed logging information, set this variable to lower values,
as 10 to show debug information. You can also adjust the environment variable CONAN_LOGGING_LEVEL.
The print_run_commands, when is 1, Conan will print the executed commands in self.run to the output.
You can also adjust the environment variable CONAN_PRINT_RUN_COMMANDS
The run_to_file variable, defaulted to False, will print the output from the self.run
executions to the path that the variable specifies.
You can also adjust the environment variable CONAN_LOG_RUN_TO_FILE.
The run_to_output variable, defaulted to 1, will print to the stdout the output from the
self.run executions in the conanfile. You can also adjust the environment variable CONAN_LOG_RUN_TO_OUTPUT.
The trace_file variable enable extra logging information about your conan command executions.
Set it with an absolute path to a file.
You can also adjust the environment variable CONAN_TRACE_FILE.
General
The vs_installation_preference variable determines the preference of usage when searching a Visual installation. The order of preference
by default is Enterprise, Professional, Community and BuildTools. It can be fixed to just one type of installation like only BuildTools. You
can also adjust the environment variable CONAN_VS_INSTALLATION_PREFERENCE.
The verbose_traceback variable will print the complete traceback when an error occurs in a recipe or even in the conan code base, allowing
to debug the detected error.
The bash_path variable is used only in windows to help the
tools.run_in_windows_bash() function to locate our Cygwin/MSYS2 bash.
Set it with the bash executable path if it’s not in the PATH or you want to use a different one.
The cmake_*** variables will declare the corresponding CMake variable when you use the
cmake generator and the CMake build tool.
The cpu_count variable set the number of cores that the tools.cpu_count() will return,
by default the number of cores available in your machine.
Conan recipes can use the cpu_count() tool to build the library using more than one core.
The pylintrc variable points to a custom pylintrc file that allows configuring custom rules
for the python linter executed at export time. A use case could be to define some custom indents
(though the standard pep8 4-spaces indent is recommended, there are companies that define different styles).
The pylintrc file has the form:
[FORMAT]
indent-string=' '
Running pylint --generate-rcfile will output a complete rcfile with commments explaining the fields.
The recipe_linter variable allows to disable the package recipe analysis (linting) executed at conan install.
Please note that this linting is very recommended, specially for sharing package recipes and collaborating with others.
The sysrequires_mode variable, defaulted to enabled (allowed modes enabled/verify/disabled)
controls whether system packages should be installed into the system via SystemPackageTool helper,
typically used in system_requirements().
You can also adjust the environment variable CONAN_SYSREQUIRES_MODE.
The sysrequires_sudo variable, defaulted to True, controls whether sudo is used for installing apt, yum, etc.
system packages via SystemPackageTool. You can also adjust the environment variable CONAN_SYSREQUIRES_SUDO.
The request_timeout variable, defaulted to 30 seconds, controls the time after Conan will stop waiting for a response.
Timeout is not a time limit on the entire response download; rather, an exception is raised if the server has not issued a
response for timeout seconds (more precisely, if no bytes have been received on the underlying socket for timeout seconds).
If no timeout is specified explicitly, it do not timeout.
The user_home_short specify the base folder to be used with the short paths feature.
If not specified, the packages marked as short_paths will be stored in the C:\.conan (or the current drive letter).
If the variable is set to “None” will disable the short_paths feature in Windows, for modern Windows that enable long paths at the system level.
The verbose_traceback variable will print the complete traceback when an error occurs in a recipe or even
in the conan code base, allowing to debug the detected error.
Storage
The storage.path variable define the path where all the packages will be stored.
On Windows:
It is recommended to assign it to some unit, e.g. map it to X: in order to avoid hitting the 260 chars path name length limit).
Also see the short_paths docs to know more about how to mitigate the limitation of 260 chars path name length limit.
It is recommended to disable the Windows indexer or exclude the storage path to avoid problems (busy resources).
Note
If you want to change the default “conan home” (directory where conan.conf file is) you can adjust
the environment variable CONAN_USER_HOME.
Proxies
If you are not using proxies at all, or you want to use the proxies specified by the operating system,
just remove the [proxies] section completely. You can run conan config rm proxies.
If you leave leave the [proxies] section blank, conan will copy the system configured
proxies, but if you configured some exclusion rule it won’t work:
[proxies]
# Empty section will try to use system proxies.
# If you don't want Conan to mess with proxies at all, remove section [proxies]
You can specify http and https proxies as follows. Use the no_proxy_match keyword to specify a list of URLs or patterns that will skip the proxy:
[proxies]
# As documented in http://docs.python-requests.org/en/latest/user/advanced/#proxies
http: http://user:pass@10.10.1.10:3128/
http: http://10.10.1.10:3128
https: http://10.10.1.10:1080
no_proxy_match: http://url1, http://url2, https://url3*, https://*.custom_domain.*
Use http=None and/or https=None to disable the usage of a proxy.
If this fails, you might also try to set environment variables:
# linux/osx
$ export HTTP_PROXY="http://10.10.1.10:3128"
$ export HTTPS_PROXY="http://10.10.1.10:1080"
# with user/password
$ export HTTP_PROXY="http://user:pass@10.10.1.10:3128/"
$ export HTTPS_PROXY="http://user:pass@10.10.1.10:3128/"
# windows (note, no quotes here)
$ set HTTP_PROXY=http://10.10.1.10:3128
$ set HTTPS_PROXY=http://10.10.1.10:1080