Skip to main content

​
Authentication Commands

Manage authentication settings and user access for your Coconut instance.

​
nut auth init

Initialize the authentication system.
This command sets up authentication for your Coconut instance, allowing you to control who can access it. Example:
After initializing authentication, you’ll need to add users to the whitelist before they can access your Coconut instance.

​
nut auth add-user

Add a user to the authentication whitelist.
This command prompts you to enter user information to grant access to your Coconut instance. Example:

​
nut auth list-users

List all whitelisted users.
This displays a table of all users who have been granted access to your Coconut instance. Example:

​
nut auth toggle

Enable or disable authentication.
This command toggles the authentication system on or off. When disabled, anyone can access your Coconut instance. Example:
Disabling authentication removes access control. Only do this in trusted, private environments.

​
Authentication Workflow

1

Initialize authentication

Run nut auth init to set up the authentication system.
2

Add users

Use nut auth add-user to whitelist users who should have access.
3

Verify users

Check the user list with nut auth list-users to ensure all authorized users are added.
4

Toggle as needed

Use nut auth toggle to enable or disable authentication when required.