diskominfotik-banda-aceh/sso-banda-aceh-php

This package help to connect SSO Banda Aceh with another applications with some features (View, Controller, Config and Route)

v1.0.0 2023-01-02 07:59 UTC

Requires

• php: ^8.0
• illuminate/support: ^8.0
• laravel/socialite: ^5.5
• socialiteproviders/keycloak: ^5.2

Requires (Dev)

• orchestra/testbench: ^6.0
• phpunit/phpunit: ^9.0

MIT

• Diskominfotik Banda Aceh

• diskominfotik-banda-aceh
• sso-banda-aceh-php

README

• Table of contents
• SSO Banda Aceh PHP
  • Installation
  • Usage
  • Changelog
  • Contributing
  • Security
  • Credits
  • License

SSO Banda Aceh PHP

This package provide some config for SSO laravel client that using keycloak for SSO

Installation

Run this command line for installation :

composer require diskominfotik-banda-aceh/sso-banda-aceh-php

Specific Version

composer require diskominfotik-banda-aceh/sso-banda-aceh-php:2.0.0

With Tilde (~) or Caret (^) Version Range

composer require diskominfotik-banda-aceh/sso-banda-aceh-php "^2.0.0"

Version

Laravel Version	SSO Version
Laravel Ver.8	V1.0.0
Laravel Ver.9	V2.0.0
Laravel Ver.10	V3.0.0

Usage

• Copy service provider in app.php file for laravel < 5.5

'providers' => [
    DiskominfotikBandaAceh\SSOBandaAcehPHP\SSOBandaAcehPHPServiceProvider::class
]

• Run this command line for make sure the package run properly

composer dumpautoload

• Publish the vendor if you want to use the migration or change the SSO view

php artisan vendor:publish --provider="DiskominfotikBandaAceh\SSOBandaAcehPHP\SSOBandaAcehPHPServiceProvider"

Note :
//Add --tag for specific publish. Ex : --tag=migrations,views,config
//Add --force for replace existing config file

• Migrate SSO User

php artisan migrate

• Copy .env keycloak in laravel client

KEYCLOAK_CLIENT_ID=
KEYCLOAK_CLIENT_SECRET=
KEYCLOAK_REDIRECT_URI=
KEYCLOAK_BASE_URL=
KEYCLOAK_REALM=
KEYCLOAK_PROFILE=

• Comment the default auth routes in web.php (if the login just using SSO)

//Auth::routes;

• [Optional] Setting your User model in sso-banda-aceh.php config file (if not using the default in App\Models\User)

'models' => [     
     'users' => User::class
]

• [Optional] Setting redirect after login in sso-banda-aceh.php config file (if not using the default redirect to admin.home)

'redirect_after_login' => 'admin.home'

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

Credits

• Diskominfotik Banda Aceh
• All Contributors

License

The MIT License (MIT). Please see License File for more information.