User Password
monetr requires users authenticate using an email and a password. A password that is weak or easy to guess makes it easier for unauthorized people to sign in to your account.
Change your password
You can change your password one of two ways. If you have access to your login you can click the Gear icon in the sidebar and then navigate to the Security tab within your settings. Or you can access the page here: Security Settings.
There will be a few cards on this page, clicking Change Password button on the first card will open a dialog allowing you to update your password.
Once you have updated your password monetr will send a confirmation email to your login's email address. You do not need to reply or do anything with this email, it is intended to notify users of unauthorized activity in the event that their account may have been compromised.
Forgot password
If you do not have access to your login, or have forgotten your password; you can still reset your password as long as you have access to the email address that is associated with your login.
Navigate to the Forgot Password page. Here you can provide the email address associated with your login.
Once you submit the form we will send you an email with a link that can be used to reset your password. Click the link in the email to proceed. If you do not receive the email make sure to check your spam or junk folder, otherwise please reach out to support for help.
Once you open the link in the email, you will be prompted to provide a new password as well as to repeat it to help prevent any typos. Once submitted you will receive a confirmation email that your password was changed, and you should now be able to login to your account with your new credentials.
On self-hosted instances of monetr, resetting your password via forgot password requires that the server has SMTP configured and forgot password enabled. If it doesn't, you can still reset a password using the monetr CLI, see Reset a password with the CLI below.
Reset a password with the CLI
If you are self-hosting monetr you can generate a password reset link for any login using the monetr CLI. This is handy if you don't have SMTP configured, or if the reset email just isn't showing up.
Inside your monetr container run the following command with the email address of the login you want to reset:
Note: Before running this command, you will need to make sure that your config is either stored in the default
location for monetr or you will need to pass -c ${path to your config} to monetr before the admin command. For
example: monetr -c ${path to your config} admin ....
If you know the login's ID instead, you can pass --login-id=$LOGIN_ID in place of --email. One of the two is
required.
monetr will print out a password reset link. Open that link in your browser (or send it to the person who needs it) and
it will take you to the same reset password page that the forgot password email does. The link is only valid for as long
as email.forgotPassword.tokenLifetime is configured for, which is 10 minutes by default. See Forgot Password
Configuration for more info. If the link expires you can
just run the command again to get a new one.
If SMTP is configured and forgot password is enabled, monetr will also send the normal password reset email to the user.
If you don't want that email to be sent, add --silent to the command.
The CLI signs the reset link with the same key that your monetr server uses, so security.privateKey needs to be set in
your config and the key file needs to be readable from wherever you run the command. If it isn't, the server won't
accept the link. See Security Configuration for more info.
monetr will also print a warning if the login is disabled, has TOTP enabled, or hasn't verified their email address yet. Resetting the password won't change any of those, so the user may still have trouble signing in afterwards.