The FusionAuth site is open source. Found a bug, an issue, or a typo in our docs? Please report using an issue or submit a pull request.
Thanks!
โ FusionAuth team
If you want to submit a PR or test a change to fix a link, etc it may be helpful for you to build and run locally.
If you have Docker installed your machine, you can use it to build and serve the site. To make things easier, there's a run-docker
script to build the container image and mount some cache volumes to speed up future processes.
To build the site and serve it locally, execute ./run-docker --serve
to start the Docker container with a local HTTP server available at localhost:4000. For more information, see Build and run a local HTTP server.
You can just build the site with no HTTP server by executing ./run-docker
.
This project is built using jekyll and asciidoc. You'll need to have ruby installed.
Install these programs:
gem install bundle
bundle install
On M1 Macs, you may receive an error similar to:
Gem::Ext::BuildError: ERROR: Failed to build gem native extension.
current directory: /Users/<username>/.rbenv/versions/2.7.5/lib/ruby/gems/2.7.0/gems/eventmachine-1.2.7/ext
/Users/<username>/.rbenv/versions/2.7.5/bin/ruby -I /Users/mark/.rbenv/versions/2.7.5/lib/ruby/site_ruby/2.7.0 extconf.rb
To fix this, rebuild the eventmachine gem using:
gem install eventmachine -v '1.2.7' -- --with-ldflags="-Wl,-undefined,dynamic_lookup"
bundle install
We use the Savant build tool. In order to build and run this project, you'll need to first setup Savant.
Linux or macOS
mkdir ~/savant
cd ~/savant
wget http://savant.inversoft.org/org/savantbuild/savant-core/1.0.0/savant-1.0.0.tar.gz
tar xvfz savant-1.0.0.tar.gz
ln -s ./savant-1.0.0 current
export PATH=$PATH:~/savant/current/bin/
You may optionally want to add ~/savant/current/bin
to your PATH that is set in your profile so that this change persists. You'll also need to ensure that you have Java >= 8 installed and the environment variable JAVA_HOME
is set.
sb serve
For more information on the Savant build tool, checkout savantbuild.org.
If you are modifying the doc search and want to use a different Algolia index for testing, update the settings in _config.yml
. To manually refresh the document search index, use this command: ALGOLIA_API_KEY='<admin api key>' bundle exec jekyll algolia
If you want to clean your Jekyll install, run bundle exec jekyll clean
.
This project depends on CSS from the fusionauth-style
project.
If you are making changes to the CSS, you'll need to do the following:
sb int
which pushes up an integration build (similar to a maven snapshot) to the savant repo.fusionauthWebsiteStyleVersion = "0.2.27-{integration}"
Each time you make a CSS change, you can run sb int
in fusionauth-style
and then sb css
in this project to pull down the latest CSS.
Before you merge your site changes with CSS dependencies to main
:
site/_includes/_head.liquid
fusionauth-site
savant build file.sb css
๐ This section is only useful if you work for FusionAuth. Sorry!
Only main
is ever released. You should work on a feature branch so that nothing is inadvertently released, but you must merge to main
before you release. On every project, including this site, main
should always be completely clean and able to be released at anytime.
Deploying happens automatically via a GitHub action when main
is updated.
๐ This section is only useful if you work for FusionAuth. Sorry!
The redirects.json file specifies our redirect rules. This file is published to s3 and read by a Lambda function that processes redirects for the site.
redirects
indexPages
s3Paths
arrays3Prefixes
arrayโ ๏ธ When updating this file, please keep items in alpha order.
๐ This section is only useful if you work for FusionAuth. Sorry!
This is the state of things as of Nov 2023.
The sitemap is generated during the Astro build by @astrojs/sitemap.
As of today, we still have static sitemaps that were generated by Jekyll, located in astro/public. These static sitemaps reference the sitemap generated by Astro.