Skip to content

Commit 39ab476

Browse files
committed
chore(docs): update oauth section
1 parent cd26540 commit 39ab476

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

docs/2-features/17-oauth.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,21 @@ This implementation is built on top of the PHP league's [OAuth client](https://g
1212

1313
## Getting started
1414

15-
To get started with OAuth, you will first need to create a configuration file for your desired OAuth provider.
15+
Tempest provides an installer to quickly set up OAuth in your project. You can run the installer using the following command:
16+
17+
```sh
18+
./tempest install auth --oauth
19+
```
20+
21+
The installer will:
22+
- Prompt you to select one or more OAuth providers from the available options
23+
- Publish the necessary configuration files and controller stubs
24+
- Optionally add the OAuth credentials to your `.env` and `.env.example` files
25+
- Optionally install the required Composer dependencies for the selected providers
26+
27+
This is the quickest way to get started with OAuth in your Tempest application.
28+
29+
Alternatively, you can manually create a configuration file for your desired OAuth provider.
1630

1731
Tempest provides a [different configuration object for each provider](#available-providers). For instance, if you wish to authenticate users with GitHub, you may create a `github.config.php` file returning an instance of {b`Tempest\Auth\OAuth\Config\GitHubOAuthConfig`}:
1832

0 commit comments

Comments
 (0)