Skip to content

Commit 6c5776a

Browse files
committed
Update README with IP whitelist instructions
1 parent c32d8c1 commit 6c5776a

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,26 @@ If you want to grant access to just a few of those users, you can whitelist them
114114

115115
By default the `users` table is used with the `email` and `password` field names. But you can change this if you are using some other table or fields.
116116

117+
## 🔖 IP Whitelist
118+
119+
You can add a comma separated list of IP's to grant these users easier or exclusive access to your staging site.
120+
For example: `'1.2.3.4,1.2.3.4'`. In the config file itself you can also use an array of IP's.
121+
122+
| Option | Type | Default |
123+
| --------------------------------------- | -------- | ---------- |
124+
| `STAGEFRONT_IP_WHITELIST` | `string` | `null` |
125+
| `STAGEFRONT_IP_WHITELIST_ONLY` | `bool` | `false` |
126+
| `STAGEFRONT_IP_WHITELIST_REQUIRE_LOGIN` | `bool` | `false` |
127+
128+
When you add IP's to your whitelist, the default behavior is that these users will have instant access to the site,
129+
while someone with another IP will be presented with the normal login form.
130+
131+
To exclusively allow whitelisted IP's to access your site, set `STAGEFRONT_IP_WHITELIST_ONLY` to `true`.
132+
Users from other IP's will now get a `403 - Forbidden` error.
133+
134+
To crank up security, you may also require whitelisted IP's to go through the login form.
135+
Set `STAGEFRONT_IP_WHITELIST_REQUIRE_LOGIN` to `true` to set this up.
136+
117137
## ⚙️ Other Options
118138

119139
#### ☑️ Change Route URL

0 commit comments

Comments
 (0)