Skip to content

CLI Commands ​

The CLI Command interface can be accessed by running VoidAuth with arguments. One way to accomplish this is to use your existing application compose file, running commands in the format docker compose run voidauth <command> [options] from within the same directory as the compose.yaml. Documentation for CLI Commands will omit the method for running the selected commands, ex. voidauth migrate.

Serve ​

voidauth serve

This is the default command if none are supplied, and starts the VoidAuth application.

Migrate ​

voidauth migrate

Migrates all data from the current database to the database specified by the MIGRATE_TO_* environment variables. Read more on the Database Migration page.

Generate ​

Generate Random Value ​

voidauth generate random

Generates a random hexadecimal value with 192-bits of entropy. Can be used to generate random values for environment variables.

User ​

Manage MFA (Multi-Factor Authentication) ​

voidauth user mfa <action> [username]

Enables or disables MFA for an existing user. The action can be enable or disable. The username parameter can be supplied positionally, for example voidauth user mfa enable example_user, or by flag, for example voidauth user mfa enable --username example_user. Enabling MFA for a user will require them to set up an MFA method the next time they use VoidAuth.

Password Reset ​

voidauth user password-reset [username]

Generates a password reset link for an existing user. The username parameter can be supplied positionally voidauth user password-reset example_user or by flag voidauth user password-reset --username example_user.

A fork of VoidAuth by Derek Paschal — with LDAP Directory Sync.