Documentation
This page covers the parts of Veltrix that belong to you as a person rather than to the organization: how you sign in and out, your profile, your password, two-factor authentication, notification preferences and how long your session lasts. Organization-wide identity settings (roles, single sign-on) are in Access Control & Single Sign-On.
| Screen | Route | How to reach it |
|---|---|---|
| Sign in | /login | Opened automatically when signed out |
| Sign up | /signup | “Sign up” link on the sign-in page |
| Forgot / reset password | /forgot-password, /reset-password | “Forgot password?” on the sign-in page; the reset link |
| My Profile | /profile | Account menu in the top bar → My Profile |
| Account Settings (security, 2FA, notifications, password) | /profile/settings | Direct address; see Gotchas |
/login and enter your email, then choose Next.If your session expires while you are working, you are sent to sign in and returned to the page you were on. Platform operators land on the platform-admin portal instead of the dashboard.
The email step is the same whether or not the address has an account, so the page cannot be used to discover who has an account.
The sign-up page asks for name, email, password and password confirmation, and creates a new organization on the free plan with you as its Administrator (an AWS Cognito sign-up button also appears when Cognito is configured). It does not add you to an existing organization; ask your administrator to add you instead. See Organization Settings.
Open the account menu in the top bar and choose Sign out. This clears the session in your browser and asks the server to end it. Through the API, POST /api/auth/logout?all=true revokes every session for the user.
Open My Profile from the account menu (Account Settings, in the same menu, holds security and notification settings). The header shows your avatar, name, role and organization. Choose Edit Profile, change the fields, then Save (or Cancel).
| Field | Editable | Notes |
|---|---|---|
| Full Name | Yes | Your display name. |
| No | “Email cannot be changed”. It is your sign-in identity. | |
| Organization | No | Always the organization's name, shown read-only. To rename the organization use Organization Settings. |
| Phone | Yes | Free text. |
| Location | Yes | Free text. |
| Joined | No | When your account was created. |
| Bio | Yes | Multi-line free text. |
| Role | No | Your RBAC role; changed by an administrator. |
Unless an avatar is set, your avatar is generated from your name by an external avatar service. There is no avatar upload control on the page.
/profile/settings) and find the Change Password card.Password rules (enforced by the server for every route that sets a password): at least 12 characters, at most 128 characters and 72 bytes, not a commonly used password, and not based on your name or email address.
Changing your password ends your existing sessions. Only local accounts have a Veltrix password; if you sign in through single sign-on, manage your password at your identity provider.
Reset links only work for active local accounts, and resetting ends all existing sessions. If you do not receive the link, ask an organization administrator to set a new password for you from Access Control → User Management.
Two-factor authentication (2FA) adds a time-based one-time code from an authenticator app to local password sign-in. It is optional and per user. It applies to local accounts only: users who sign in through single sign-on rely on the multi-factor authentication of their identity provider.
/profile/settings. In Security Settings, under Two-Factor Authentication, choose Set up.The setup is not active until you verify a code. You can Cancel or start over at any time before verifying; re-running setup replaces the pending secret.
After your password, you are asked for a code and select Verify and sign in. The sign-in step stays valid for 5 minutes. Up to 5 code attempts are allowed in that window, and a code that has just been used is rejected if replayed.
The badge reads Enabled. Enter a current code under Enter a code to disable and select Disable. Turning 2FA off always needs a valid code.
/pipeline/drift. It refreshes about every 30 seconds. It appears only if your role has configuration-canvas:read and your plan includes drift detection (see Plans, Limits & Trial). If the count cannot load it shows “Drift alerts unavailable”./deployments/<id> checks the deployment exists and opens the pipeline dashboard with that deployment; if it is gone or you lack access you see a message and a link to the pipeline dashboard. A link that points at /alerts/<id> opens the platform alerts list, which is a platform-operator screen, so non-operators are sent back to the dashboard.On /profile/settings, Notification Preferences has three checkboxes — Email Notifications (default on), Browser Notifications (default on) and Mobile Notifications (default off) — saved with Save Changes (“Settings updated successfully!”). They are stored per user, and the page itself says they are not used to deliver notifications yet: do not rely on them to deliver email, browser or mobile alerts.