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
2 changes: 1 addition & 1 deletion CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ The build requires 16GB heap (`NODE_OPTIONS=--max-old-space-size=16384`, set aut

### Static assets

Images go in `static/img/product_docs/<product>/` as `.webp` files. Reference with absolute paths: `/img/product_docs/<product>/image.webp`.
Images go in `static/images/<product>/` as `.webp` files, organized by version and section (e.g., `static/images/passwordreset/3.3/administration/`). Reference with absolute paths: `/images/<product>/<version>/<image>.webp`. Some products share images across product boundaries (e.g., passwordreset images under `passwordpolicyenforcer/`).

## Branch Workflow

Expand Down
4 changes: 3 additions & 1 deletion docs/CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,13 @@ Write for the person who knows their job but may be new to this specific product
- `docs/<product>/<version>/` — Versioned product documentation (e.g., `docs/accessanalyzer/12.0/`)
- `docs/<product>/` — Single-version (SaaS) products using `version: "current"`
- `docs/kb/` — Knowledge base articles (canonical source; never manually copy into versioned folders)
- `static/img/product_docs/<product>/` — Images (`.webp` format, absolute paths: `/img/product_docs/...`)
- `static/images/<product>/` — Images (`.webp` format, organized by version/section, absolute paths: `/images/...`)
- `sidebars/<product>/<version>.js` — Sidebar configs (auto-generated; rarely need manual editing)

Edits to one version do not propagate to others. Update each version that needs the change explicitly.

KB articles store images as PNG files in `0-images/` subdirectories alongside the article markdown. These are copied by the KB script — don't move or rename them.

## Writing Standards

The full style guide is in `netwrix_style_guide.md` at the project root. Read it when:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar_position: 20
# Administration

Netwrix Password Reset is a self-service password management system that helps you to reduce the
number of password related help desk calls. Password Reset allows users to securely change their
number of password related help desk calls. With Password Reset, users can securely change their
password and unlock their account, even if they have forgotten their password. This section details
the different benefits of using Password Reset.

Expand Down
136 changes: 67 additions & 69 deletions docs/passwordreset/3.23/administration/configuring_password_reset.md

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,16 @@ sidebar_position: 80

# Editing the HTML Templates

Password Reset's user interface is built with customizable templates. You can easily modify the user
Password Reset's user interface is built with customizable templates. You can modify the user
interface by editing the templates. The templates are written in HTML5 and formatted with CSS3, so
they work with all modern web browsers. Older browsers such as Internet Explorer 8 may work, but the
pages may be badly formatted. Please contact Netwrix support if you need to use Password Reset with
pages may be badly formatted. Contact Netwrix support if you need to use Password Reset with
older web browsers.

## User Interface Files

Password Reset installs seven `.htm` files for every language. Each filename starts with a language
code. The files for the US English language are:
code. The files for the English (United States) language are:

| Filename | Content |
| ----------------- | ------------------------------------ |
Expand All @@ -33,7 +33,7 @@ files are installed into the `\Inetpub\wwwroot\pwreset\` folder by default.
:::note
Always backup the user interface files before and after editing them. Your changes may be
overwritten when Password Reset is upgraded, and some changes could stop Password Reset from working
correctly. Having a backup allows you to quickly revert to a working setup.
correctly. With a backup, you can quickly revert to a working setup.
Web browsers display pages differently, so test your changes with several versions of the most
popular browsers to ensure compatibility.
:::
Expand All @@ -46,7 +46,7 @@ are used to prepare the pages. Some of these comments define ranges. A range loo

<!--RANGE_NAME-->Some text or HTML<!--/RANGE_NAME-->

The Web Interface deletes ranges (and the text inside them) when they are not needed. Some ranges
The Web Interface deletes ranges (and the text inside them) when they aren't needed. Some ranges
span only one word, while others span several lines. The other type of comment tag is called a
field.

Expand All @@ -67,7 +67,7 @@ your domain name in the Domain box.
--><!--/RESOURCE_STRINGS-->

Resource strings are mostly validation error messages, but they can contain any text Password Reset
may need to build the page. Do not modify the identifiers on the left, only edit the text on the
may need to build the page. Don't modify the identifiers on the left, only edit the text on the
right. Resource strings are always inside a range called RESOURCE_STRINGS. Password Reset deletes
this range before sending the page to the user's web browser. See the
[Error Messages](/docs/passwordreset/3.23/administration/using_password_reset.md#error-messages) topic
Expand All @@ -83,7 +83,7 @@ on larger screens.

:::warning
You may rebrand the Password Reset user interface, but it is a violation of the License
Agreement to modify, remove or obscure any copyright notice.
Agreement to modify, remove, or obscure any copyright notice.
:::


Expand All @@ -94,15 +94,15 @@ understanding of Password Reset's templates. You don't need to be an expert in H
examples, but a basic understanding of HTML will help.

Work through them carefully, and backup files before you edit them. The examples in this section are
from the US English files, but the format is the same for all languages.
from the English (United States) files, but the format is the same for all languages.

### Replace the Netwrix Logo

The Netwrix logo is shown at the top of the page. The logo is installed into the
`\Inetpub\wwwroot\pwreset\images\` folder by default, and it is called logo.svg. You can replace
this file with one containing your organization's logo.

You will also need to edit the HTML files if your logo is not in SVG format, or if it has a
You also need to edit the HTML files if your logo isn't in SVG format, or if it has a
different aspect ratio to the Netwrix logo. Open every HTML file in a text editor such as Notepad,
and search for the line shown below. Change the filename (logo.svg), height (70 pixels) and width
(116 pixels) to suit your logo.
Expand All @@ -121,10 +121,10 @@ and search for the line shown below. Change the filename (logo.svg), height (70
### Edit Page Instructions

Instructions appear at the top of each page. You can edit the instructions by opening the relevant
.htm file and searching for the text you wish to modify.
.htm file and searching for the text you want to modify.

Instructions are often inside a range called SECTION_A, SECTION_B, SECTION_C, or SECTION_D. Each
section contains instructions for the different pages in the template. Make sure you edit the
section contains instructions for the different pages in the template. Ensure you edit the
instructions in the correct section, or they may be displayed on the wrong page. The text_long and
text_short classes are used in page instructions to tailor content to the screen size.

Expand Down Expand Up @@ -154,7 +154,7 @@ files to change all instances of a message. See the [Resource Strings](#resource
more information.

You may see placeholders like %1 and %2 in some error messages. These are replaced with more
information about the error. You should keep these, but you can delete them if you do not want them.
information about the error. You should keep these, but you can delete them if you don't want them.

| String | Message |
| --------------------------- | ----------------------------------------------- |
Expand All @@ -171,7 +171,7 @@ more information.
![using_apr_11](/images/passwordreset/3.23/administration/using_apr_11.webp)

You may see placeholders like %1 and %2 in some error messages. These are replaced with more
information about the error. You should keep these, but you can delete them if you do not want them.
information about the error. You should keep these, but you can delete them if you don't want them.

| String | Message |
| --------------------- | ----------------------------------------------------- |
Expand All @@ -191,14 +191,14 @@ If you want to display some text for all error messages, then insert your text a

Finished messages are shown after users successfully complete an enroll, reset, unlock, or change.
These messages are defined in the Resource Strings section near the end of `en_finished.htm`. See
the [Resource Strings](#resource-strings) topic for more information.
the [Resource Strings](#resource-strings) topic for the format and editing instructions.

![using_apr_7](/images/passwordreset/3.23/administration/using_apr_7.webp)

`en_finished.htm` has two resource strings for password changes (RES_FINISHED_CHANGE and
RES_FINISHED_CHANGE_INVITE). The first is shown when a user who has enrolled into APR changes their
password. The second is shown when a user who has not enrolled changes their password. The second
message invites the user to enroll so they can also use the reset and unlock features in future.
message invites the user to enroll so they can also use the reset and unlock features in the future.

### Replace Enroll Question Lists with Text Boxes

Expand All @@ -217,15 +217,15 @@ The lines you need to edit in en_enroll.htm look like this:
```

There are ten of these lines in en_enroll.htm, each with their own question number (the number after
the q). You do not have to edit all ten lines. If users will be allowed to enter two questions, then
the q). You don't have to edit all ten lines. If users will be allowed to enter two questions, then
only edit the q1 and q2 lines. Replace these lines with a line like this:

```html
<input class="field_question" name="q1" id="q1" value="<!--Q1-->" maxlength="64" />
```

Change the three question numbers on each line so they match the original numbers, otherwise
Password Reset will not work correctly. You should also edit the validation error messages in
Password Reset doesn't work correctly. Also edit the validation error messages in
`en_enroll.htm` as some of them make reference to selecting questions from a list.

:::note
Expand Down Expand Up @@ -256,7 +256,7 @@ browser's cache to see the changes.
### Change Icon Colors

The Web Interface icons are in Scalable Vector Graphics (SVG) format. Vector graphics maintain their
sharpness when resized. You can easily change the colors of the icons with a text editor. Open the
sharpness when resized. You can change the colors of the icons with a text editor. Open the
SVG file with a text editor like Notepad, and edit this section of the file:

fill="#FF7F00"
Expand All @@ -266,8 +266,8 @@ this one to generate the color code:
[https://www.w3schools.com/colors/colors_picker.asp](https://www.w3schools.com/colors/colors_picker.asp)

:::note
Some old web browsers with basic HTML5 support cannot display SVG images. Password Reset
works with these browsers, but the SVG images are not shown. You can convert the icons to GIF or PNG
Some old web browsers with basic HTML5 support can't display SVG images. Password Reset
works with these browsers, but the SVG images aren't shown. You can convert the icons to GIF or PNG
format if you want them shown on these older browsers.

:::
Loading
Loading