stancl/tenancy-docs
1
0
Fork 0
mirror of https://github.com/stancl/tenancy-docs.git synced 2025-12-12 02:04:03 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

darkons' rewrite

Browse source
This commit is contained in:
lukinovec 2022-08-03 08:10:19 +02:00
parent 985df20327
commit 9435577f5e
1 changed files with 48 additions and 42 deletions
Download patch file Download diff file Expand all files Collapse all files

90
source/docs/v3/integrations/passport.blade.md
View file

@ -8,7 +8,6 @@ section: content
> **Tip:** If you only want to write a SPA application but don't need an API for some other use (for example, a mobile application), you can avoid much of the complexity by using [Inertia.js](https://inertiajs.com/).
**Very important:** Don't use the command `passport:install` to avoid issues.
## Passport use cases
@ -23,17 +22,34 @@ section: content
### **Using Passport only in central application** {#using-passport-only-in-central-application}
You don't have to do anything special in this use case, just install **Laravel Passport** as its official documentation explains:
[Laravel Passport official documentation](https://laravel.com/docs/9.x/passport)
### **Using Passport only in tenant application** {#using-passport-only-in-tenant-application}
To use **Laravel Passport** inside the tenant application, you must follow the following steps:
1. Add this code to the `register` method in your `AppServiceProvider` to prevent Passport migrations from running in the central application:
1. Don't use `passport:install` command. Instead of that, publish `migrations` and `config` manually:
- Run `php artisan vendor:publish --tag=passport-migrations` command and **MOVE** (not copy) all of them to `database/migrations/tenant/` directory.
- Run `php artisan vendor:publish --tag=passport-config` command. After that, open `config/passport.php` file and set storage database connection to `null`. This will make Passport use the default connection:
```php
return [
'storage' => [
'database' => [
'connection' => null,
],
],
];
```
2. Add this code to the `register` method in your `AppServiceProvider` to prevent Passport migrations from running in the central application:
```php
Passport::ignoreMigrations();
```
2. Register Passport routes adding this code to the `boot` method in your `AuthServiceProvider`:
3. Apply Passport migrations running `php artisan migrate` command.
4. Register Passport routes adding this code to the `boot` method in your `AuthServiceProvider`:
```php
Passport::routes(null, ['middleware' => [
InitializeTenancyByDomain::class, // Or whatever tenant identification middlewares you're going to use
@ -41,20 +57,7 @@ To use **Laravel Passport** inside the tenant application, you must follow the f
]]);
```
3. Publish Passport migrations running `php artisan vendor:publish --tag=passport-migrations` command and **move** (not copy) all of them to `database/migrations/tenant/` directory.
4. Publish Passport config file running `php artisan vendor:publish --tag=passport-config` command. After that, open `config/passport.php` file and set storage database connection to `null`. This will make Passport use the default connection:
```php
return [
'storage' => [
'database' => [
'connection' => null,
],
],
];
```
5. Create Passport Clients in your tenant database seeder like this:
5. To automatically create Passport Clients in your tenant databases, add the following code to your tenant seeder class:
```php
public function run()
{
@ -64,7 +67,7 @@ To use **Laravel Passport** inside the tenant application, you must follow the f
$client->createPersonalAccessClient(null, 'Default personal access client', 'http://your.redirect.path');
}
```
*You can set your tenants database seeder class in `config/tenancy.php` file at `seeder_parameters` key.*
*You can set your tenant database seeder class in `config/tenancy.php` file at `seeder_parameters` key.*
6. Create Passport keys following [Manage Passport keys](#manage-passport-keys) section.
@ -72,30 +75,33 @@ To use **Laravel Passport** inside the tenant application, you must follow the f
### **Using Passport in both the central and tenant application** {#using-passport-in-both-the-central-and-tenant-application}
To use **Laravel Passport** on central and tenant application, you must follow the following steps:
1. Enable [Universal Routes]({{ $page->link('universal-routes') }}) feature.
1. Don't use `passport:install` command. Instead of that, publish `migrations` and `config` manually:
- Run `php artisan vendor:publish --tag=passport-migrations` command and **COPY** all of them to `database/migrations/tenant/` directory.
2. Register Passport routes adding this code to the `boot` method in your `AuthServiceProvider`:
- Run `php artisan vendor:publish --tag=passport-config` command. After that, open `config/passport.php` file and set storage database connection to `null`. This will make Passport use the default connection:
```php
return [
'storage' => [
'database' => [
'connection' => null,
],
],
];
```
2. Apply Passport migrations running `php artisan migrate` command.
3. Enable [Universal Routes]({{ $page->link('universal-routes') }}) feature to allow Passport routes being accessible in both apps.
4. Register Passport routes adding this code to the `boot` method in your `AuthServiceProvider`:
```php
Passport::routes(null, ['middleware' => [
'universal',
PreventAccessFromCentralDomains::class,
InitializeTenancyByDomain::class, // Or whatever tenant identification middlewares you're going to use
]]);
```
3. Publish Passport migrations running `php artisan vendor:publish --tag=passport-migrations` command and make a **copy** of all of them to `database/migrations/tenant/` directory.
4. Publish Passport config file running `php artisan vendor:publish --tag=passport-config` command. After that, open `config/passport.php` file and set storage database connection to `null`. This will make Passport use the default connection:
```php
return [
'storage' => [
'database' => [
'connection' => null,
],
],
];
```
5. Create Passport Clients in your central and tenant database seeders like this:
5. To create Passport Clients in your central app, just use `php artisan passport:client` commands. To automatically create Passport Clients in your tenant databases, add the following code to your tenant seeder class:
```php
public function run()
{
@ -105,7 +111,7 @@ To use **Laravel Passport** on central and tenant application, you must follow t
$client->createPersonalAccessClient(null, 'Default personal access client', 'http://your.redirect.path');
}
```
*You can set your tenants database seeder class in `config/tenancy.php` file at `seeder_parameters` key.*
*You can set your tenant database seeder class in `config/tenancy.php` file at `seeder_parameters` key.*
6. Create Passport keys following [Manage Passport keys](#manage-passport-keys) section.
@ -120,9 +126,9 @@ If you want to use the same Passport keys for all your tenants and your central
If you want to use an unique Passport keys for each tenant, there are multiple ways you can store and load tenant Passport keys, but the most straightforward way is to store the keys in the `Tenant model` and load them into the passport configuration using the [Tenant Config]({{ $page->link('features/tenant-config') }}) feature.
Once the [Tenant Config]({{ $page->link('features/tenant-config') }}) feature is enabled, simply map your tenant Passport keys into the `boot` method of your `TenancyServiceProvider` as follows:
```php
\Stancl\Tenancy\Features\TenantConfig::$storageToConfigMap = [
'passport_public_key' => 'passport.public_key',
'passport_private_key' => 'passport.private_key',
],
```
```php
\Stancl\Tenancy\Features\TenantConfig::$storageToConfigMap = [
'passport_public_key' => 'passport.public_key',
'passport_private_key' => 'passport.private_key',
];
```