Skip to content

Commit 2fdbfa3

Browse files
committed
Add example .env file
1 parent 53b5b84 commit 2fdbfa3

File tree

2 files changed

+23
-7
lines changed

2 files changed

+23
-7
lines changed

.env.example

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
STAGEFRONT_ENABLED=true
2+
STAGEFRONT_URL=stagefront
3+
4+
STAGEFRONT_LOGIN=stagefront
5+
STAGEFRONT_PASSWORD=stagefront
6+
STAGEFRONT_ENCRYPTED=false
7+
8+
STAGEFRONT_DATABASE=false
9+
STAGEFRONT_DATABASE_WHITELIST=null
10+
STAGEFRONT_DATABASE_TABLE=users
11+
STAGEFRONT_DATABASE_LOGIN_FIELD=email
12+
STAGEFRONT_DATABASE_PASSWORD_FIELD=password
13+
14+
STAGEFRONT_LIVE_SITE=null

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,8 @@ Laravel will automatically register the `ServiceProvider`.
3434

3535
Set some options in your `.env` file or publish the [configuration file](#publish-configuration-file).
3636

37+
See an [example .env file](.env.example).
38+
3739
Enable StageFront and choose a login and password:
3840

3941
| Option | Type | Default |
@@ -52,13 +54,13 @@ You can generate this using Laravel's `bcrypt('your password')` function.
5254

5355
If you have existing users in the database and want to use those credentials, you can set `STAGEFRONT_DATABASE` to `true`. The above settings will then be ignored.
5456

55-
| Option | Type | Default |
56-
| ------------------------------------ | --------------- | ---------- |
57-
| `STAGEFRONT_DATABASE` | `bool` | `false` |
58-
| `STAGEFRONT_DATABASE_WHITELIST` | `string`|`null` | `null` |
59-
| `STAGEFRONT_DATABASE_TABLE` | `string` | `users` |
60-
| `STAGEFRONT_DATABASE_LOGIN_FIELD` | `string` | `email` |
61-
| `STAGEFRONT_DATABASE_PASSWORD_FIELD` | `string` | `password` |
57+
| Option | Type | Default |
58+
| ------------------------------------ | -------- | ---------- |
59+
| `STAGEFRONT_DATABASE` | `bool` | `false` |
60+
| `STAGEFRONT_DATABASE_WHITELIST` | `string` | `null` |
61+
| `STAGEFRONT_DATABASE_TABLE` | `string` | `users` |
62+
| `STAGEFRONT_DATABASE_LOGIN_FIELD` | `string` | `email` |
63+
| `STAGEFRONT_DATABASE_PASSWORD_FIELD` | `string` | `password` |
6264

6365
If you want to grant access to just a few of those users, you can whitelist them by setting `STAGEFRONT_DATABASE_WHITELIST` to a comma separated string: `'john@doe.io,jane@doe.io'`.
6466

0 commit comments

Comments
 (0)