Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 62 additions & 5 deletions docs/en-US/handbook/auth/user/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,11 +52,7 @@ When sign up is not allowed, the sign up page cannot be accessed

![](https://static-docs.nocobase.com/09325c4b07e09f88f80a14dff8430556.png)

### Sign up form Settings

:::info
`v1.4.0-beta.7` and later versions supported.
:::
### Sign up form Settings<Badge>v1.4.0-beta.7+</Badge>

You can set which fields in the user collection need to be displayed in the sign up form and whether they are required or not. At least one of username or email fields needs to be set to display and required.

Expand All @@ -65,3 +61,64 @@ You can set which fields in the user collection need to be displayed in the sign
Sign up page

![](https://static-docs.nocobase.com/202411262135801.png)

### Forgot Password<Badge>v1.7.0+</Badge>

The forgot password feature allows users to reset their password via email verification if they forget it.

#### Administrator Configuration

1. **Enable Forgot Password Feature**

In "Settings" > "Authentication" > "Forgot password" tab, check the "Enable Forgot Password Feature" checkbox.

![20250423071957_rec_](https://static-docs.nocobase.com/20250423071957_rec_.gif)

2. **Configure Notification Channel**

Select an email notification channel (currently only email is supported). If no notification channel is available, you need to add one first.

![20250423072225_rec_](https://static-docs.nocobase.com/20250423072225_rec_.gif)

3. **Configure Password Reset Email**

Customize the email subject and content, supporting HTML or plain text format. You can use the following variables:
- Current user
- System settings
- Reset password link
- Reset link expiration (minutes)

![20250427170047](https://static-docs.nocobase.com/20250427170047.png)

4. **Set Reset Link Expiration**

Set the validity period (in minutes) for the reset link, default is 120 minutes.

![20250423073557](https://static-docs.nocobase.com/20250423073557.png)

#### User Workflow

1. **Initiate Password Reset Request**

Click the "Forgot Password" link on the login page (requires the administrator to enable the forgot password feature first) to go to the forgot password page.

![20250421103458_rec_](https://static-docs.nocobase.com/20250421103458_rec_.gif)

Enter the registered email address and click the "Send Reset Email" button.

![20250421113442_rec_](https://static-docs.nocobase.com/20250421113442_rec_.gif)

2. **Reset Password**

The user will receive an email containing a reset link. Click the link to open a page where you can set a new password.

![20250421113748](https://static-docs.nocobase.com/20250421113748.png)

After setting it up, the user can log in to the system with the new password.

#### Notes

- The reset link has a time limit, by default it is valid for 120 minutes after generation (configurable by the administrator).
- The link can only be used once and becomes invalid immediately after use.
- If the user does not receive the reset email, please check if the email address is correct or check the spam folder.
- The administrator should ensure that the mail server configuration is correct to guarantee that the reset email can be sent successfully.
67 changes: 62 additions & 5 deletions docs/fr-FR/handbook/auth/user/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,11 +52,7 @@ Lorsque l'inscription n'est pas autorisée, la page d'inscription ne pourra pas

![](https://static-docs.nocobase.com/09325c4b07e09f88f80a14dff8430556.png)

### Paramètres du formulaire d'inscription

:::info
Les versions `v1.4.0-beta.7` et ultérieures prennent en charge cette fonctionnalité.
:::
### Paramètres du formulaire d'inscription<Badge>v1.4.0-beta.7+</Badge>

Vous pouvez définir les champs de la collection des utilisateurs à afficher dans le formulaire d'inscription et s'ils sont requis ou non. Au moins un des champs `nom d'utilisateur` ou `email` doit être défini pour s'afficher et être requis.

Expand All @@ -65,3 +61,64 @@ Vous pouvez définir les champs de la collection des utilisateurs à afficher da
Page d'inscription

![](https://static-docs.nocobase.com/202411262135801.png)

### Mot de passe oublié<Badge>v1.7.0+</Badge>

La fonctionnalité de mot de passe oublié permet aux utilisateurs de réinitialiser leur mot de passe via une vérification par e-mail lorsqu'ils l'ont oublié.

#### Configuration administrateur

1. **Activer la fonctionnalité "Mot de passe oublié"**

Dans "Paramètres" > "Authentification utilisateur" > onglet "Mot de passe oublié", cochez la case "Activer la fonctionnalité Mot de passe oublié".

![20250423071957_rec_](https://static-docs.nocobase.com/20250423071957_rec_.gif)

2. **Configurer le canal de notification**

Sélectionnez un canal de notification par e-mail (actuellement, seul l'e-mail est pris en charge). S'il n'y a pas de canal de notification disponible, vous devez d'abord en ajouter un.

![20250423072225_rec_](https://static-docs.nocobase.com/20250423072225_rec_.gif)

3. **Configurer l'e-mail de réinitialisation du mot de passe**

Personnalisez l'objet et le contenu de l'e-mail, en supportant les formats HTML ou texte brut. Vous pouvez utiliser les variables suivantes :
* Utilisateur actuel (Current user)
* Paramètres système (System settings)
* Lien de réinitialisation du mot de passe (Reset password link)
* Expiration du lien de réinitialisation (minutes) (Reset link expiration (minutes))

![20250427170047](https://static-docs.nocobase.com/20250427170047.png)

4. **Définir la durée de validité du lien de réinitialisation**

Définissez la durée de validité du lien de réinitialisation (en minutes), la valeur par défaut est de 120 minutes.

![20250423073557](https://static-docs.nocobase.com/20250423073557.png)

#### Flux utilisateur

1. **Demander la réinitialisation du mot de passe**

Sur la page de connexion, cliquez sur le lien "Mot de passe oublié" (l'administrateur doit d'abord activer la fonctionnalité de mot de passe oublié) pour accéder à la page de mot de passe oublié.

![20250421103458_rec_](https://static-docs.nocobase.com/20250421103458_rec_.gif)

Entrez l'adresse e-mail enregistrée et cliquez sur le bouton "Envoyer l'e-mail de réinitialisation".

![20250421113442_rec_](https://static-docs.nocobase.com/20250421113442_rec_.gif)

2. **Réinitialiser le mot de passe**

L'utilisateur recevra un e-mail contenant un lien de réinitialisation. Cliquez sur le lien, puis définissez un nouveau mot de passe sur la page qui s'ouvre.

![20250421113748](https://static-docs.nocobase.com/20250421113748.png)

Une fois terminé, l'utilisateur peut se connecter au système avec le nouveau mot de passe.

#### Remarques

* Le lien de réinitialisation a une durée limitée, par défaut il est valide pendant 120 minutes après sa génération (configurable par l'administrateur).
* Le lien ne peut être utilisé qu'une seule fois et devient invalide immédiatement après utilisation.
* Si l'utilisateur ne reçoit pas l'e-mail de réinitialisation, veuillez vérifier si l'adresse e-mail est correcte ou consulter le dossier des courriers indésirables.
* L'administrateur doit s'assurer que la configuration du serveur de messagerie est correcte pour garantir que les e-mails de réinitialisation peuvent être envoyés avec succès.
61 changes: 61 additions & 0 deletions docs/ja-JP/handbook/auth/user/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,3 +51,64 @@ NocoBaseが現在サポートしているユーザー認証タイプは以下の
登録が許可されていない場合、登録ページにはアクセスできません。

![](https://static-docs.nocobase.com/09325c4b07e09f88f80a14dff8430556.png)

### パスワードを忘れた場合<Badge>v1.7.0+</Badge>

パスワードを忘れた場合機能により、ユーザーはパスワードを忘れた際に、メール認証を通じてパスワードを再設定できます。

#### 管理者設定

1. **パスワードを忘れた場合機能を有効にする**

「設定」>「ユーザー認証」>「パスワードを忘れた場合」タブで、「パスワードを忘れた場合機能を有効にする」チェックボックスをオンにします。

![20250423071957_rec_](https://static-docs.nocobase.com/20250423071957_rec_.gif)

2. **通知チャネルを設定する**

メール通知チャネルを選択します(現在はメールのみサポート)。利用可能な通知チャネルがない場合は、まず追加する必要があります。

![20250423072225_rec_](https://static-docs.nocobase.com/20250423072225_rec_.gif)

3. **パスワードリセットメールを設定する**

メールの件名と内容をカスタマイズします。HTMLまたはプレーンテキスト形式をサポートしています。以下の変数を使用できます:
* 現在のユーザー(Current user)
* システム設定(System settings)
* パスワードリセットリンク(Reset password link)
* リセットリンクの有効期限(分)(Reset link expiration (minutes))

![20250427170047](https://static-docs.nocobase.com/20250427170047.png)

4. **リセットリンクの有効期限を設定する**

リセットリンクの有効時間(分)を設定します。デフォルトは120分です。

![20250423073557](https://static-docs.nocobase.com/20250423073557.png)

#### ユーザーの使用フロー

1. **パスワードリセットリクエストを開始する**

ログインページで「パスワードを忘れた場合」リンクをクリックし(管理者が事前にパスワードを忘れた場合機能を有効にする必要があります)、パスワードを忘れた場合のページに移動します。

![20250421103458_rec_](https://static-docs.nocobase.com/20250421103458_rec_.gif)

登録したメールアドレスを入力し、「リセットメールを送信」ボタンをクリックします。

![20250421113442_rec_](https://static-docs.nocobase.com/20250421113442_rec_.gif)

2. **パスワードをリセットする**

ユーザーはリセットリンクを含むメールを受信します。リンクをクリックした後、開いたページで新しいパスワードを設定します。

![20250421113748](https://static-docs.nocobase.com/20250421113748.png)

設定が完了すると、ユーザーは新しいパスワードでシステムにログインできます。

#### 注意事項

* リセットリンクには時間制限があります。デフォルトでは生成後120分間有効です(管理者が設定可能)。
* リンクは一度しか使用できず、使用後はすぐに無効になります。
* ユーザーがリセットメールを受信しない場合は、メールアドレスが正しいか確認するか、迷惑メールフォルダを確認してください。
* 管理者は、リセットメールが正常に送信されるように、メールサーバーの設定が正しいことを確認する必要があります。
67 changes: 62 additions & 5 deletions docs/zh-CN/handbook/auth/user/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,11 +52,7 @@ NocoBase 目前支持的用户认证类型有:

![](https://static-docs.nocobase.com/09325c4b07e09f88f80a14dff8430556.png)

### 注册表单设置

:::info
`v1.4.0-beta.7` 以上版本支持。
:::
### 注册表单设置<Badge>v1.4.0-beta.7+</Badge>

支持设置用户表中的哪些字段在注册表单中显示以及是否必填。至少需要设置用户名或邮箱中一个字段为显示和必填。

Expand All @@ -65,3 +61,64 @@ NocoBase 目前支持的用户认证类型有:
注册页

![](https://static-docs.nocobase.com/202411262135801.png)

### 忘记密码<Badge>v1.7.0+</Badge>

忘记密码功能允许用户在忘记密码时,通过邮箱验证的方式重新设置密码。

#### 管理员配置

1. **启用忘记密码功能**

在"设置" > "用户认证" > "忘记密码"选项卡中,勾选"启用忘记密码功能"复选框。

![20250423071957_rec_](https://static-docs.nocobase.com/20250423071957_rec_.gif)

2. **配置通知渠道**

选择一个邮件通知渠道(当前仅支持邮件)。如果没有可用的通知渠道,需要先添加一个。

![20250423072225_rec_](https://static-docs.nocobase.com/20250423072225_rec_.gif)

3. **配置密码重置邮件**

自定义邮件主题和内容,支持 HTML 或纯文本格式。可以使用以下变量:
- 当前用户(Current user)
- 系统设置(System settings)
- 重置密码链接(Reset password link)
- 重置链接有效期(分钟)(Reset link expiration (minutes))

![20250427170047](https://static-docs.nocobase.com/20250427170047.png)

4. **设置重置链接有效期**

设置重置链接的有效时间(分钟),默认为 120 分钟。

![20250423073557](https://static-docs.nocobase.com/20250423073557.png)

#### 用户使用流程

1. **发起密码重置请求**

在登录页面点击"忘记密码"链接(需要管理员先开启忘记密码功能),进入忘记密码页面。

![20250421103458_rec_](https://static-docs.nocobase.com/20250421103458_rec_.gif)

输入注册邮箱并点击"发送重置邮件"按钮。

![20250421113442_rec_](https://static-docs.nocobase.com/20250421113442_rec_.gif)

2. **重置密码**

用户会收到一封包含重置链接的邮件。点击链接后,在打开的页面中设置新密码。

![20250421113748](https://static-docs.nocobase.com/20250421113748.png)

设置完成后,用户可以使用新密码登录系统。

#### 注意事项

- 重置链接有时间限制,默认是在生成后的 120 分钟内有效(可由管理员配置)
- 链接只能使用一次,使用后立即失效
- 如果用户没有收到重置邮件,请检查邮箱地址是否正确,或查看垃圾邮件文件夹
- 管理员应确保邮件服务器配置正确,以保证重置邮件能够成功发送
Loading