tokenly / platform-admin
A platform administration module for Tokenly services
Installs: 7 346
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 6
Forks: 0
Open Issues: 0
Requires
- php: >=5.5.0
- tokenly/laravel-api-provider: ^3
- tokenly/laravel-event-log: ^3
- tokenly/laravel-record-lock: ~1
Requires (Dev)
- phpunit/phpunit: ~6
README
A platform administration module for Tokenly services using the Laravel application framework.
Installation
- Install with
composer require tokenly/platform-admin
- Install the Laravel Collective HTML package. Follow the installation instructions at https://laravelcollective.com/docs/master/html.
- Add
Tokenly\PlatformAdmin\Provider\PlatformAdminServiceProvider::class,
to your list of service providers - Publish the config with
./artisan vendor:publish --provider="Tokenly\PlatformAdmin\Provider\PlatformAdminServiceProvider"
- Run the new migrations with
./artisan migrate
- add
PLATFORM_ADMIN_ENABLED=true
to your.env
file
Promote an admin
- make sure these environment variables are set in your
.env
filePLATFORM_CONTROL_ENABLED=1
PLATFORM_CONTROL_AUTH_USERNAME=myusername
PLATFORM_CONTROL_AUTH_PASSWORD=s3kreTP@$$w0rd
- set
PLATFORM_CONTROL_PROMOTE_ADMIN_ENABLED=1
in your.env
file - visit
https://mysite.com/platform/control/promote-platform-admin?email=leroyjenkins@email.com
to make user leroyjenkins a platform admin - set
PLATFORM_CONTROL_PROMOTE_ADMIN_ENABLED=0
in your.env
file
Optional environment vars
PLATFORM_ADMIN_REDIRECT_TO="/home" PLATFORM_CONSOLE_QUEUE_COMMANDS=true
Running console commands
A few console commands are available to run from the platform admin. To enable application-specific commands to be run from the platform admin, implement the Tokenly\PlatformAdmin\Console\Contracts\RunsInPlatformAdmin
interface in your command class.
The platform admin supports long-running console commands through the use of a queue. To support long-running console commands, you must:
- Enable pusher broadcasting.
- Run a background process that processes the
platform_artisan_command
queue. - Set the
PLATFORM_CONSOLE_QUEUE_COMMANDS
environment variable to true.
Usage
Create or modify a user to have the platformAdmin privilege Visit http://mysite.com/platform/admin to see the admin