Skip to content

Commit 4097782

Browse files
committed
update readme
1 parent 7e4e2d4 commit 4097782

File tree

2 files changed

+16
-10
lines changed

2 files changed

+16
-10
lines changed

DEVELOP.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Before starting make sure your development environment is properly set. See [Vol
1717

1818
{
1919
"volto-addon-template": {
20-
"url": "https://github.com/collective/volto-middleware-rejectanonymous.git",
20+
"url": "https://github.com/RedTurtle/volto-middleware-rejectanonymous.git",
2121
"package": "volto-middleware-rejectanonymous",
2222
"branch": "main",
2323
"path": "src"

README.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
# volto-middleware-rejectanonymous
22

3-
[Volto](https://github.com/plone/volto) add-on
3+
[Volto](https://github.com/plone/volto) add-on that reject unconditionnally anonymous users from a Volto site.
44

5-
## Features
5+
They should be redirected to a login form (customizable).
66

7-
[rejectanonymous](https://rejectanonymousjs.github.io/) middleware
7+
When login management is outside Plone, the first SSR page load is without login headers, so you have to refresh the page to have the proper tokens.
88

9-
Demo GIF
9+
With this middleware, you can force SSR to make a fake call to a Plone view that simply make a redirect (and returns the auth tokens).
1010

1111
## Getting started
1212

13-
### Try volto-addon-template with Docker
13+
### Try volto-middleware-rejectanonymous with Docker
1414

1515
1. Get the latest Docker images
1616

@@ -32,7 +32,7 @@ Demo GIF
3232

3333
1. Go to http://localhost:3000
3434

35-
### Add volto-addon-template to your Volto project
35+
### Add volto-middleware-rejectanonymous to your Volto project
3636

3737
1. Make sure you have a [Plone backend](https://plone.org/download) up-and-running at http://localhost:8080/Plone
3838

@@ -69,14 +69,20 @@ Demo GIF
6969

7070
1. Happy editing!
7171

72+
### Configuration
73+
74+
This add-on can be enabled with an environment variable `RAZZLE_REJECT_ANONYMOUS`. It is disabled by default.
75+
76+
Default redirect url is `/login` but you can override it with `RAZZLE_REJECT_ANONYMOUS_REDIRECT_URL` environment variable.
77+
7278
## Release
7379

74-
See [RELEASE.md](https://github.com/collcetive/volto-middleware-rejectanonymous/blob/master/RELEASE.md).
80+
See [RELEASE.md](https://github.com/RedTurtle/volto-middleware-rejectanonymous/blob/master/RELEASE.md).
7581

7682
## How to contribute
7783

78-
See [DEVELOP.md](https://github.com/collcetive/volto-middleware-rejectanonymous/blob/master/DEVELOP.md).
84+
See [DEVELOP.md](https://github.com/RedTurtle/volto-middleware-rejectanonymous/blob/master/DEVELOP.md).
7985

8086
## Copyright and license
8187

82-
See [LICENSE.md](https://github.com/collcetive/volto-middleware-rejectanonymous/blob/master/LICENSE.md) for details.
88+
See [LICENSE.md](https://github.com/RedTurtle/volto-middleware-rejectanonymous/blob/master/LICENSE.md) for details.

0 commit comments

Comments
 (0)