Skip to content

Commit 286f100

Browse files
committed
Update config reference
1 parent b0ef272 commit 286f100

File tree

1 file changed

+29
-28
lines changed

1 file changed

+29
-28
lines changed

README.md

Lines changed: 29 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -44,68 +44,69 @@ This package is currently in the active development.
4444

4545
```yaml
4646
trikoder_oauth2:
47-
48-
authorization_server:
47+
authorization_server: # Required
4948
5049
# Full path to the private key file.
5150
# How to generate a private key: https://oauth2.thephpleague.com/installation/#generating-public-and-private-keys
52-
private_key: # Required, Example: /var/oauth/private.key
51+
private_key: ~ # Required, Example: /var/oauth/private.key
5352
54-
# Passphrase of the private key, if any.
55-
private_key_passphrase: ~ # Optional, default null
53+
# Passphrase of the private key, if any
54+
private_key_passphrase: null
5655
57-
# The string used as an encryption key.
56+
# The plain string or the ascii safe string used to create a Defuse\Crypto\Key to be used as an encryption key.
5857
# How to generate an encryption key: https://oauth2.thephpleague.com/installation/#string-password
59-
encryption_key: # Required
60-
61-
# The type of encryption key. Is the key a plain value or a ascii safe string that should be passed to Defuse\Crypto\Key?
62-
encryption_key_type: 'plain' # Possible values: "plain", "defuse"
58+
encryption_key: ~ # Required
59+
60+
# The type of value of 'encryption_key'
61+
encryption_key_type: plain # One of "plain"; "defuse"
6362
6463
# How long the issued access token should be valid for.
6564
# The value should be a valid interval: http://php.net/manual/en/dateinterval.construct.php#refsect1-dateinterval.construct-parameters
66-
access_token_ttl: PT1H
65+
access_token_ttl: PT1H
6766
6867
# How long the issued refresh token should be valid for.
6968
# The value should be a valid interval: http://php.net/manual/en/dateinterval.construct.php#refsect1-dateinterval.construct-parameters
70-
refresh_token_ttl: P1M
71-
69+
refresh_token_ttl: P1M
70+
71+
# How long the issued auth code should be valid for.
72+
# The value should be a valid interval: http://php.net/manual/en/dateinterval.construct.php#refsect1-dateinterval.construct-parameters
73+
auth_code_ttl: PT10M
74+
7275
# Whether to enable the client credentials grant
7376
enable_client_credentials_grant: true
74-
77+
7578
# Whether to enable the password grant
7679
enable_password_grant: true
77-
80+
7881
# Whether to enable the refresh token grant
7982
enable_refresh_token_grant: true
8083
81-
# How long the issued auth code should be valid for.
82-
# The value should be a valid interval: http://php.net/manual/en/dateinterval.construct.php#refsect1-dateinterval.construct-parameters
83-
auth_code_ttl: PT10M
84+
# Whether to enable the authorization code grant
85+
enable_auth_code_grant: true
8486
85-
resource_server:
87+
# Whether to enable the implicit grant
88+
enable_implicit_grant: true
89+
resource_server: # Required
8690
8791
# Full path to the public key file
8892
# How to generate a public key: https://oauth2.thephpleague.com/installation/#generating-public-and-private-keys
89-
public_key: # Required, Example: /var/oauth/public.key
93+
public_key: ~ # Required, Example: /var/oauth/public.key
9094
9195
# Scopes that you wish to utilize in your application.
9296
# This should be a simple array of strings.
93-
scopes: []
97+
scopes: []
9498
9599
# Configures different persistence methods that can be used by the bundle for saving client and token data.
96100
# Only one persistence method can be configured at a time.
97-
persistence:
98-
101+
persistence: # Required
99102
doctrine:
100103
101104
# Name of the entity manager that you wish to use for managing clients and tokens.
102-
entity_manager: default # Required
105+
entity_manager: default
106+
in_memory: ~
103107
104-
in_memory: ~
105-
106108
# The priority of the event listener that converts an Exception to a Response
107-
exception_event_listener_priority: 10
108-
109+
exception_event_listener_priority: 10
109110
```
110111

111112
3. Enable the bundle in `config/bundles.php` by adding it to the array:

0 commit comments

Comments
 (0)