andythorne/flock

Symfony user storage system with oauth2 support

Flock User Store

, _(*1)

Storage system for users with oauth2 support, written in Symfony >= 3.4/4.0 with FOSOAuth, FOSUser and EasyAdmin., _(*2)

Installation

Flock is a Symfony project, not a bundle. To install it, create a new project with composer:, _(*3)

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., _(*4)

Running With Docker

Flock comes with an example Docker container setup using: - richarvey/nginx-php-fpm - mariadb10, _(*5)

To get started, run:, _(*6)

docker-compose up -d

Docker will expose the app over the external network flock, which your can link to., _(*7)

Usage

Public Endpoints

Flock uses the standard FOSUser endpoints for user registration, login and profile management., _(*8)

See https://symfony.com/doc/master/bundles/FOSUserBundle/index.html for documentation for extending flock's FOSUser implementation, _(*9)

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., _(*10)

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., _(*11)

For a guide on how to use HWIOAuthBundle in your app to authenticate with flock, see, _(*12)

Authors

Written by: - Andy Thorne, _(*13)