Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/diskominfotik-banda-aceh/sso-keycloak-laravel-client

This package help to connect SSO Banda Aceh that using keycloak (all application that using keycoak for SSO can use this package) with another applications as client with some configurations for laravel (View, Controller, Config and Route)
https://github.com/diskominfotik-banda-aceh/sso-keycloak-laravel-client

keycloak keycloak-client keycloak-rest-api keycloak-sso laravel laravel-framework laravel-package php single-sign-on sso sso-authentication sso-laravel sso-login

Last synced: 26 days ago
JSON representation

This package help to connect SSO Banda Aceh that using keycloak (all application that using keycoak for SSO can use this package) with another applications as client with some configurations for laravel (View, Controller, Config and Route)

Awesome Lists containing this project

README

        

Table of contents
=================

* [Table of contents](#table-of-contents)
* [SSO Banda Aceh PHP](#sso-banda-aceh-php)
* [Installation](#installation)
* [Usage](#usage)
* [Changelog](#changelog)
* [Contributing](#contributing)
* [Security](#security)
* [Credits](#credits)
* [License](#license)

# SSO Banda Aceh PHP
[![Latest Version on Packagist](https://img.shields.io/packagist/v/diskominfotik-banda-aceh/sso-banda-aceh-php.svg?style=flat-square)](https://packagist.org/packages/diskominfotik-banda-aceh/sso-banda-aceh-php)
[![Total Downloads](https://img.shields.io/packagist/dt/diskominfotik-banda-aceh/sso-banda-aceh-php.svg?style=flat-square)](https://packagist.org/packages/diskominfotik-banda-aceh/sso-banda-aceh-php)
![GitHub Actions](https://github.com/diskominfotik-banda-aceh/sso-banda-aceh-php/actions/workflows/main.yml/badge.svg)

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

## Installation

Run this command line for installation :

```bash
composer require diskominfotik-banda-aceh/sso-banda-aceh-php
```
### Specific Version
```bash
composer require diskominfotik-banda-aceh/sso-banda-aceh-php:2.0.0
```
With Tilde (~) or Caret (^) Version Range
```bash
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
```bash
composer dumpautoload
```
- Publish the vendor if you want to use the migration or change the SSO view
```bash
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
```bash
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)
```php
//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](CHANGELOG.md) for more information what has changed recently.

## Contributing

Please see [CONTRIBUTING](CONTRIBUTING.md) for details.

### Security

If you discover any security related issues, please email diskominfotikbna@gmail.com instead of using the issue tracker.

## Credits

- [Diskominfotik Banda Aceh](https://github.com/diskominfotik-banda-aceh)
- [All Contributors](../../contributors)

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.