Skip to content
This repository has been archived by the owner on Mar 8, 2024. It is now read-only.

Commit

Permalink
Update config comments (#22)
Browse files Browse the repository at this point in the history
* Update text

* Update README with new config
  • Loading branch information
juukie authored and freekmurze committed Oct 16, 2017
1 parent 37dacd6 commit 9bbb705
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 31 deletions.
34 changes: 16 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,37 +48,35 @@ This is the content of the published config file `demo-mode.php`:

```php
return [
/**

/*
* This is the master switch to enable demo mode.
*/
'enabled' => env('DEMO_MODE_ENABLED', true),

/**
* Visitors that go an url that is protected by demo mode will be redirected.
* to this url
/*
* Visitors browsing a protected url will be redirected to this path.
*/
'redirect_unauthorized_users_to_url' => '/under-construction',

/**
* After have been granted access visitors will be redirected to this url.
/*
* After having gained access, visitors will be redirected to this path.
*/
'redirect_authorized_users_to_url' => '/',

/**
* The following IP addresses will automatically have access to the app
* without having to pass the `demoAccess` route.
/*
* The following IP's will automatically gain access to the
* app without having to visit the `demoAccess` route.
*/
'authorized_ips' => [

//
],

/**
* If strict mode is enabled then only the IP addresses listed in `authorized_ips` are allowed.
* Vistors won't be able to gain access by visiting the `demoAccess` route anymore.
/*
* When strict mode is enabled, only IP's listed in `authorized_ips` will gain access.
* Visitors won't be able to gain access by visiting the `demoAccess` route anymore.
*/
'strict_mode' => false,

];
```

Expand Down
25 changes: 12 additions & 13 deletions config/demo-mode.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,33 +2,32 @@

return [

/**
/*
* This is the master switch to enable demo mode.
*/
'enabled' => env('DEMO_MODE_ENABLED', true),

/**
* Visitors that go an url that is protected by demo mode will be redirected.
* to this url.
/*
* Visitors browsing a protected url will be redirected to this path.
*/
'redirect_unauthorized_users_to_url' => '/under-construction',

/**
* After have been granted access visitors will be redirected to this url.
/*
* After having gained access, visitors will be redirected to this path.
*/
'redirect_authorized_users_to_url' => '/',

/**
* The following IP addresses will automatically have access to the app
* without having to pass the `demoAccess` route.
/*
* The following IP's will automatically gain access to the
* app without having to visit the `demoAccess` route.
*/
'authorized_ips' => [

//
],

/**
* If strict mode is enabled then only the IP addresses listed in `authorized_ips` are allowed.
* Vistors won't be able to gain access by visiting the `demoAccess` route anymore.
/*
* When strict mode is enabled, only IP's listed in `authorized_ips` will gain access.
* Visitors won't be able to gain access by visiting the `demoAccess` route anymore.
*/
'strict_mode' => false,

Expand Down

0 comments on commit 9bbb705

Please sign in to comment.