This works with rails 6, but requires python2 to build the JS modules. python2 is no longer supported, so this repository is archived and won't receive further updates.
This project contains an example project that illustrates using FusionAuth with Ruby-on-Rails, version 6.
You will need the following things properly installed on your computer.
- Git: Presumably you already have this on your machine if you are looking at this project locally; if not, use your platform's package manager to install git, and
git clonethis repo. - Ruby 2.7: This application is configured to use Ruby (v2.7.1). Please make sure you have that version installed.
- Docker: For standing up FusionAuth from within a Docker container. (You can install it other ways(, but for this example you'll need Docker.)
git clone https://github.com/FusionAuth/fusionauth-example-rails-appcd fusionauth-example-rails-appbundle install: This will bring all the Ruby gems down for use.
This example assumes that you will run FusionAuth from a Docker container. In the root of this project directory (next to this README) are two files a Docker compose file and an environment variables configuration file. Assuming you have Docker installed on your machine, a docker-compose up will bring FusionAuth up on your machine.
The FusionAuth configuration files also make use of a unique feature of FusionAuth, called Kickstart: when FusionAuth comes up for the first time, it will look at the Kickstart file and mimic API calls to configure FusionAuth for use. It will perform all the necessary setup to make this demo work correctly, but if you are curious as to what the setup would look like by hand, the "FusionAuth configuration (by hand)" section of this README describes it in detail.
For now, get FusionAuth in Docker up and running (via docker-compose up) if it is not already running; to see, click here to verify it is up and running.
NOTE: If you ever want to reset the FusionAuth system, delete the volumes created by docker-compose by executing
docker-compose down -v. FusionAuth will only apply the Kickstart settings when it is first run (e.g., it has no data configured for it yet).
- In a terminal window, run
docker-compose up. This will block this terminal window. - In another terminal window, run
bin/rails server. This will start the Rails application. - Open a browser and log in using our user's credentials ("richard@example.com"/"password").
Log into the FusionAuth admin screen with a different browser or incognito window using the admin user credentials ("admin@example.com"/"password") to explore the admin user experience.