Skip to content

Commit dd92b4d

Browse files
authored
Enhance README with new sharing feature details
Added a new feature for sharing visual rollback previews as public URLs with configurable secret keys and expiration times.
1 parent 9d1308d commit dd92b4d

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

.github/README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
> [!NOTE]
88
> With the release of Umbraco 17 we will be following the Umbraco release version numbers - so RollBackPreviewer v2 is for Umbraco 16 and under, the rest will follow v17, v18 etc
99
10-
Enhance Umbraco's rollback functionality with visual rollback previews. This extension builds ontop of the existing Umbraco Rollback modal and allows for the JSON diff to be viewed as well as the visual diff.
10+
Enhance Umbraco's rollback functionality with visual rollback previews. This extension builds ontop of the existing Umbraco Rollback modal and allows for the JSON diff to be viewed as well as the visual diff. **NEW FEATURE!** You can now share the preview as a publicly available URL. With configurable outputs for a secret key to lock this down, and have an expiration time on the URL, this is the perfect way to share content with externals.
1111

1212
<img alt="Visual difference" src="https://github.com/Rockerby/Umbraco.Community.RollbackPreviewer/blob/develop/docs/screenshots/visual_diff.png">
1313
<img alt="JSON difference" src="https://github.com/Rockerby/Umbraco.Community.RollbackPreviewer/blob/develop/docs/screenshots/json_diff.png">
@@ -23,6 +23,22 @@ Once the package installed it will automatically replace the current Rollback mo
2323
> [!IMPORTANT]
2424
> The Rollback Previewer uses iFrames to function so you may need to adjust X-Frame-Options to see the preview
2525
26+
## Configuration
27+
Add the configuration to the `appsettings.json` file as per below:
28+
29+
```JSON
30+
"RollbackPreviewer": {
31+
// Set to true to enable the shareable button, appearing within the rollback modal
32+
"EnableFrontendPreviewAuthorisation": true,
33+
// Set as a string to use as a standard secret key (appended in the query string)
34+
"FrontendPreviewAuthorisationSecret": "super-secret-key",
35+
// Set to true to enable the shared URL to be time limited
36+
"EnableTimeLimitedSecrets": true,
37+
// Set to expire the link after this many minutes
38+
"SecretExpirationMinutes": 60
39+
}
40+
```
41+
2642
## Running locally (v15/v16/v17)
2743

2844
Clone the repository.

0 commit comments

Comments
 (0)