Skip to content
This repository was archived by the owner on Jan 29, 2020. It is now read-only.

Commit 10e2330

Browse files
committed
Merge pull request #68 from starkskalle/master
Update docs with option to disable permission check for keys
2 parents 967e245 + b10e739 commit 10e2330

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

docs/book/v1/intro.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,19 @@ The `private_key` and `public_key` values contains the paths to the previous
8181
generated pair of keys. The `encryption_key` contains the encryption key value
8282
as a string, as stored in the `data/oauth/encryption.key` file.
8383

84+
By default both key files are checked for correct permissions (chmod 600 or 660
85+
is expected). In case the environment/operating system (e.g. Windows) does not
86+
support such a permissions, the check can be disabled:
87+
88+
```php
89+
// ...
90+
'private_key' => [
91+
'key_or_path' => __DIR__ . '/../data/oauth/private.key',
92+
'key_permissions_check' => false,
93+
],
94+
// ...
95+
```
96+
8497
The `access_token_expire` value is the time-to-live (TTL) value of the access
8598
token. The time period is represented using the [DateInterval](http://php.net/manual/en/class.dateinterval.php)
8699
format in PHP. The default value is `P1D` (1 day).

0 commit comments

Comments
 (0)