Skip to content

jerryhopper/fusionauth-kickstart

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 

Repository files navigation

fusionauth-kickstart

What is Kickstart?

Kickstart is the name of FusionAuth's template-system for quickly setting up a fusionauth instance. Kickstart allows you to build a template that will be executed during startup to quickly replicate development or production environments. No clue what fusionauth is? Checkout https://fusionauth.io

What is Github Actions?

GitHub Actions is an API for cause and effect on GitHub: orchestrate any workflow, based on any event, while GitHub manages the execution, provides rich feedback, and secures every step along the way. With GitHub Actions, workflows and steps are just code in a repository, so you can create, share, reuse, and fork your software development practices. Read all about it here : https://github.com/features/actions

About this repo

In this repo, i demonstrate the how to use Fusionauth's kickstart.json to quickly setup a fusionauth instance with a preconfigured application with specific grants and a user so we can test some code against fusionauth.

To keep things simple, the code that is being used is a simple device-authorization script in bash (source: https://github.com/jerryhopper/fusionauth-bash-deviceauth)

More info about device authorization : https://fusionauth.io/learn/expert-advice/oauth/oauth-device-authorization/

How to use this repo?

This repository is here to help you create tests for your own code, and because you need to push a change to trigger the github-actions, you need to clone this repository and push a change. This will trigger a action as defined in https://github.com/jerryhopper/fusionauth-kickstart/blob/master/.github/workflows/test.yml

Now you can see the progress of the action in the 'actions' tab of your git-repository.

If everything goes well, all tests will succeed. (https://github.com/jerryhopper/fusionauth-kickstart/actions/runs/400985304)

What's next?

Now you can test your own custom code against a pre-configured fusionauth instance, without the need for a development enviroment.

If you are interested how you can do this in conjunction with https://travis-ci.com/, checkout this repo : https://github.com/jerryhopper/fusionauth-bash-deviceauth https://travis-ci.com/github/jerryhopper/fusionauth-bash-deviceauth

Troubleshooting

Troubleshooting your kickstart.json? just checkout the fusionauth logs.

A successfull kickstart initialization looks like this:

fusionauth    | ---------------------------------------------------------------------------------------------------------
fusionauth    | -------------------------------------------- Kickstarting ? --------------------------------------------
fusionauth    | ---------------------------------------------------------------------------------------------------------
fusionauth    | 
fusionauth    | 2020-12-04 4:25:36.050 PM INFO  io.fusionauth.api.service.system.kickstart.KickstartRunner - Summary:
fusionauth    |   - Created API key ending in [...b1bd]
fusionauth    |   - Completed [POST] request to [/api/application/89d998a5-aaef-45d0-9765-adf1f3e00c65]
fusionauth    |   - Completed [POST] request to [/api/user/registration/00000000-0000-0000-0000-000000000001]

About

FusionAuth Kickstart example.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published