andythorne / flock
Symfony user storage system with oauth2 support
Installs: 4
Dependents: 0
Suggesters: 0
Security: 0
Stars: 2
Watchers: 2
Forks: 0
Open Issues: 0
Type:project
Requires
- php: ^7.0.8
- friendsofsymfony/oauth-server-bundle: 2.0.x-dev
- friendsofsymfony/user-bundle: 2.1.x-dev
- javiereguiluz/easyadmin-bundle: ^1.17
- ramsey/uuid-doctrine: ^1.4
- sensiolabs/security-checker: ^4.1
- symfony/asset: ^3.3
- symfony/console: ^3.3
- symfony/framework-bundle: ^3.3
- symfony/orm-pack: ^1.0
- symfony/serializer: ^3.3
- symfony/swiftmailer-bundle: ^3.1
- symfony/validator: ^3.3
- symfony/yaml: ^3.3
Requires (Dev)
- symfony/dotenv: ^3.3
- symfony/flex: ^1.0
Conflicts
This package is auto-updated.
Last update: 2024-10-11 03:34:41 UTC
README
Storage system for users with oauth2 support, written in Symfony >= 3.4/4.0 with FOSOAuth, FOSUser and EasyAdmin.
Installation
Flock is a Symfony project, not a bundle. To install it, create a new project with composer:
composer create-project andythorne/flock flock
cd flock
With the incoming release of Symfony Flex, this will be moved to a pack rather than a project.
Running With Docker
Flock comes with an example Docker container setup using:
To get started, run:
docker-compose up -d
Docker will expose the app over the external network flock, which your can link to.
Usage
Public Endpoints
Flock uses the standard FOSUser endpoints for user registration, login and profile management.
See https://symfony.com/doc/master/bundles/FOSUserBundle/index.html for documentation for extending flock's FOSUser implementation
Administration
Flock uses EasyAdmin to provide an admin interface for managing users
and OAuth clients. Create a super admin user (./bin/console fos:user:create <username> <email> <password> --super-admin)
and head to /admin.
OAuth2
In order to use OAuth2, you first need to create an OAuth Client. Head to /admin and create a new Client, and copy
the generated public id and secret into your app's OAuth Client.
For a guide on how to use HWIOAuthBundle in your app to authenticate with flock, see
Authors
Written by: