79
edits
Changes
no edit summary
# CLI or RPC configuration options
# CLI or RPC configuration options
The user can tell CRIU to completely ignore any configuration file in one of the default locations with the <code>--no-default-config</code> option. In this case the user can still tell CRIU to use a configuration file with the <code>--config FILENAME</code> option. CRIU also honours the environment variable <code>CRIU_CONFIG_FILE</code> just as <code>--config FILENAME</code> option.
=== Configuration File Syntax ===
Comments are supported using the '#' character. The rest of the line is ignored. Options are the same as command line options without the '--' prefix, use one option per line (with corresponding argument if applicable, divided by whitespaces). If needed, the argument can be provided in double quotes (this should be needed only if the argument contains whitespaces). In case this type of argument contains a literal double quote as well, it can be escaped using the '\' character. Usage of commands is disallowed and all other escape sequences are interpreted literally.
==== Example of Configuration File ====
<pre>$ cat ~/.criu/default.conf
tcp-established
work-dir "/home/USERNAME/criu/my \"work\" directory"
#this is a comment
no-restore-sibling # this is another comment</pre>
=== Configuration Files in RPC Mode ===
As configuration file settings are overridden by CLI and RPC mode, there is a special RPC options which lets configuration file settings override RPC settings. This is different than the normal sequence and can lead to situation which break the RPC client -> CRIU setup. As this can lead to broken setups the RPC client has to explicitly enable this mode: <code>opts.prefer_config_file = True</code>.
[[Category:CLI]]
[[Category:CLI]]
[[Category:API]]
[[Category:API]]