man7.org > Linux > man-pages

Linux/UNIX system programming training

cryptsetup-config(8) — Linux manual page

NAME | SYNOPSIS | DESCRIPTION | OPTIONS | REPORTING BUGS | SEE ALSO | CRYPTSETUP 

CRYPTSETUP-CONFIG(8)       Maintenance Commands      CRYPTSETUP-CONFIG(8)

NAME         top

       cryptsetup-config - set permanent configuration options (store to
       LUKS header)

SYNOPSIS         top

       cryptsetup config <options> <device>

DESCRIPTION         top

       Set permanent configuration options (store to LUKS header). The
       config command is supported only for LUKS2.

       The permanent options can be --priority to set priority (normal,
       prefer, ignore) for keyslot (specified by --key-slot) or --label
       and --subsystem.

       <options> can be [--priority, --label, --subsystem, --key-slot,
       --header, --disable-locks].

OPTIONS         top

       --batch-mode, -q
           Suppresses all confirmation questions. Use with care!

           If the --verify-passphrase option is not specified, this
           option also switches off the passphrase verification.

       --debug or --debug-json
           Run in debug mode with full diagnostic logs. Debug output
           lines are always prefixed by #.

           If --debug-json is used, additional LUKS2 JSON data structures
           are printed.

       --disable-locks
           Disable lock protection for metadata on disk. This option is
           valid only for LUKS2 and is ignored for other formats.

           WARNING: Do not use this option unless you run cryptsetup in a
           restricted environment where locking is impossible to perform
           (where /run directory cannot be used).

       --header <device or file storing the LUKS header>
           Use a detached (separated) metadata device or file where the
           LUKS header is stored. This option allows one to store the
           ciphertext and LUKS header on different devices.

           For commands that change the LUKS header (e.g., luksAddKey),
           specify the device or file with the LUKS header directly as
           the LUKS device.

       --help, -?
           Show help text and default parameters.

       --key-slot, -S <0-N>
           For LUKS operations that add key material, this option allows
           you to specify which keyslot is selected for the new key.

           The maximum number of keyslots depends on the LUKS version.
           LUKS1 can have up to 8 keyslots. LUKS2 can have up to 32
           keyslots based on keyslot area size and key size, but a valid
           keyslot ID can always be between 0 and 31 for LUKS2.

       --label <label>,  --subsystem <subsystem>
           Set label and subsystem description for LUKS2 device. These
           are similar to filesystem labels. The label and subsystem are
           optional fields and can be later used in udev scripts to
           trigger user actions once the device marked by these labels is
           detected.

       --priority <normal|prefer|ignore>
           Set a priority for LUKS2 keyslot. The prefer priority marked
           slots are tried before the normal priority. The ignored
           priority means that the slot is never used, if not explicitly
           requested by --key-slot option.

       --usage
           Show short option help.

       --version, -V
           Show the program version.

REPORTING BUGS         top

       Report bugs at cryptsetup mailing list
       <cryptsetup@lists.linux.dev> or in Issues project section
       <https://gitlab.com/cryptsetup/cryptsetup/-/issues/new>.

       Please attach the output of the failed command with --debug option
       added.

SEE ALSO         top

       Cryptsetup FAQ
       <https://gitlab.com/cryptsetup/cryptsetup/wikis/FrequentlyAskedQuestions>

       cryptsetup(8), integritysetup(8) and veritysetup(8)

CRYPTSETUP         top

       Part of cryptsetup project
       <https://gitlab.com/cryptsetup/cryptsetup/>. This page is part of
       the Cryptsetup ((open-source disk encryption)) project.
       Information about the project can be found at 
       ⟨https://gitlab.com/cryptsetup/cryptsetup⟩. If you have a bug
       report for this manual page, send it to dm-crypt@saout.de. This
       page was obtained from the project's upstream Git repository
       ⟨https://gitlab.com/cryptsetup/cryptsetup.git⟩ on 2025-08-11. (At
       that time, the date of the most recent commit that was found in
       the repository was 2025-08-01.) If you discover any rendering
       problems in this HTML version of the page, or you believe there is
       a better or more up-to-date source for the page, or you have
       corrections or improvements to the information in this COLOPHON
       (which is not part of the original manual page), send a mail to
       man-pages@man7.org

cryptsetup 2.8.1-git            2025-08-09           CRYPTSETUP-CONFIG(8)

Pages that refer to this page: cryptsetup(8)

HTML rendering created 2025-09-06 by Michael Kerrisk, author of The Linux Programming Interface.

For details of in-depth Linux/UNIX system programming training courses that I teach, look here.

Hosting by jambit GmbH.

Cover of TLPI