Skip to content

Commit cc5d01f

Browse files
committed
docs: update config file path
1 parent b0535e5 commit cc5d01f

6 files changed

Lines changed: 6 additions & 6 deletions

File tree

docs/getting_started/configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ This section describes the major Config items that are not described elsewhere.
2020

2121
### Access Token Lifetime
2222

23-
By default, Access Tokens can be used for 1 year since the last use. This can be easily modified in the **app/Config/Auth.php** config file.
23+
By default, Access Tokens can be used for 1 year since the last use. This can be easily modified in the **app/Config/AuthToken.php** config file.
2424

2525
```php
2626
public int $unusedTokenLifetime = YEAR;

docs/guides/api_hmac_keys.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ API. When making requests using HMAC keys, the token should be included in the `
1010

1111
> **Note**
1212
> By default, `$authenticatorHeader['hmac']` is set to `Authorization`. You can change this value by
13-
> setting the `$authenticatorHeader['hmac']` value in the **app/Config/Auth.php** config file.
13+
> setting the `$authenticatorHeader['hmac']` value in the **app/Config/AuthToken.php** config file.
1414
1515
Tokens are issued with the `generateHmacToken()` method on the user. This returns a
1616
`CodeIgniter\Shield\Entities\AccessToken` instance. These shared keys are saved to the database in plain text. The

docs/guides/api_tokens.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Access Tokens can be used to authenticate users for your own site, or when allowing third-party developers to access your API. When making requests using access tokens, the token should be included in the `Authorization` header as a `Bearer` token.
44

55
> **Note**
6-
> By default, `$authenticatorHeader['tokens']` is set to `Authorization`. You can change this value by setting the `$authenticatorHeader['tokens']` value in the **app/Config/Auth.php** config file.
6+
> By default, `$authenticatorHeader['tokens']` is set to `Authorization`. You can change this value by setting the `$authenticatorHeader['tokens']` value in the **app/Config/AuthToken.php** config file.
77
88
Tokens are issued with the `generateAccessToken()` method on the user. This returns a `CodeIgniter\Shield\Entities\AccessToken` instance. Tokens are hashed using a SHA-256 algorithm before being saved to the database. The access token returned when you generate it will include a `raw_token` field that contains the plain-text, un-hashed, token. You should display this to your user at once so they have a chance to copy it somewhere safe, as this is the only time this will be available. After this request, there is no way to get the raw token.
99

docs/guides/mobile_apps.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,6 @@ When making all future requests to the API, the mobile client should return the
7070

7171
> **Note**
7272
>
73-
> By default, `$authenticatorHeader['tokens']` is set to `Authorization`. You can change the header name by setting the `$authenticatorHeader['tokens']` value in the **app/Config/Auth.php** config file.
73+
> By default, `$authenticatorHeader['tokens']` is set to `Authorization`. You can change the header name by setting the `$authenticatorHeader['tokens']` value in the **app/Config/AuthToken.php** config file.
7474
>
7575
> e.g. if `$authenticatorHeader['tokens']` is set to `PersonalAccessCodes` then the mobile client should return the raw token in the `PersonalAccessCodes` header as a `Bearer` token.

docs/references/authentication/hmac.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ HMAC Keys/Tokens will expire after a specified amount of time has passed since t
117117
This uses the same configuration value as AccessTokens.
118118

119119
By default, this is set to 1 year. You can change this value by setting the `$unusedTokenLifetime`
120-
value in the `Auth` config file. This is in seconds so that you can use the
120+
value in the **app/Config/AuthToken.php** config file. This is in seconds so that you can use the
121121
[time constants](https://codeigniter.com/user_guide/general/common_functions.html#time-constants)
122122
that CodeIgniter provides.
123123

docs/references/authentication/tokens.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ $tokens = $user->accessTokens();
8181

8282
Tokens will expire after a specified amount of time has passed since they have been used.
8383
By default, this is set to 1 year. You can change this value by setting the `$unusedTokenLifetime`
84-
value in the `Auth` config file. This is in seconds so that you can use the
84+
value in the **app/Config/AuthToken.php** config file. This is in seconds so that you can use the
8585
[time constants](https://codeigniter.com/user_guide/general/common_functions.html#time-constants)
8686
that CodeIgniter provides.
8787

0 commit comments

Comments
 (0)