Fast Path Install & Upgrade

    Fast Path Install

    Want to get up and running super fast on your dev box or server? Use our awesome download scripts and you’ll be coding in no time. These commands will download and unpack the latest version of FusionAuth.

    By default, FusionAuth installs leveraging the database as the User search engine. You may optionally also install and configure Elasticsearch to leverage advanced search functionality. Commands for both configurations are provided below.

    Environment Variables

    The following environment variables may be provided to the install script to augment behavior.

    • TARGET_DIR - The location to install the zip. Defaults value is $PWD/fusionauth. This value is ignored when installing Debian or RPM packages.

    • VERSION - The version to install. Defaults to the latest stable version.

    macOS

    Please feel free to read these install scripts before running them. Always a good idea.

    Install in your current working directory using ZIP packages
    
sh -c "curl -fsSL https://raw.githubusercontent.com/FusionAuth/fusionauth-install/master/install.sh | sh"
    Install in your current working directory using ZIP packages, include Elasticsearch
    
sh -c "curl -fsSL https://raw.githubusercontent.com/FusionAuth/fusionauth-install/master/install.sh | sh -s - -s"

    Linux

    Please feel free to read these install scripts before running them. Always a good idea.

    Install in your current working directory using ZIP packages
    
sh -c "curl -fsSL https://raw.githubusercontent.com/FusionAuth/fusionauth-install/master/install.sh | sh -s - -z"
    Install in your current working directory using ZIP packages, include Elasticsearch
    
sh -c "curl -fsSL https://raw.githubusercontent.com/FusionAuth/fusionauth-install/master/install.sh | sh -s - -z -s"
    Install for all users on the system using DEB or RPM packages, requires sudo access
    
sh -c "curl -fsSL https://raw.githubusercontent.com/FusionAuth/fusionauth-install/master/install.sh | sh"
    Install for all users on the system using DEB or RPM packages, include Elasticsearch, requires sudo access
    
sh -c "curl -fsSL https://raw.githubusercontent.com/FusionAuth/fusionauth-install/master/install.sh | sh -s - -s"

    Windows

    Please note, that versions equal to 1.37.0 and less than 1.40.0 did not have a native Windows install option. It is recommended to plan to install version 1.40.0 or later.

    Please feel free to read these install scripts before running them. Always a good idea.

    Install in your current working directory using ZIP packages. Install using Windows PowerShell
    
. { iwr -useb https://raw.githubusercontent.com/FusionAuth/fusionauth-install/master/install.ps1 } | iex; install
    Install in your current working directory using ZIP packages, include Elasticsearch. Install using Windows PowerShell
    
. { iwr -useb https://raw.githubusercontent.com/FusionAuth/fusionauth-install/master/install.ps1 } | iex; install -includeSearch 1

    Fast Path Upgrade

    The Fast Path commands can also be used to upgrade to the latest version of FusionAuth. Follow the steps documented below.

    macOS

    In this example, we’ll assume you have previously installed FusionAuth in /usr/local/fusionauth and this directory will be referred to FUSIONAUTH_HOME. If you have used a different directory you can adjust the following example accordingly.

    Shutdown FusionAuth
    
# Stop Services
<FUSIONAUTH_HOME>/bin/shutdown.sh

    Then, run the appropriate FastPath install/upgrade command from the parent directory of FUSIONAUTH_HOME (if FUSIONAUTH_HOME is /usr/local/fusionauth, run the command from /usr/local). Reference the commands defined in the install steps above to determine which install/upgrade command is appropriate for your environment.

    Start FusionAuth
    
# Start Services
<FUSIONAUTH_HOME>/fusionauth/bin/startup.sh

    Windows

    Please note, that versions equal to 1.37.0 and less than 1.40.0 did not have a native Windows install option. It is recommended to plan to install version 1.40.0 or later.

    In this example, we’ll assume you have previously installed FusionAuth in \fusionauth and this directory will be referred to FUSIONAUTH_HOME. If you have used a different directory you can adjust the following example accordingly.

    First, terminate the running FusionAuth App and Elasticsearch services. Prior to version 1.40.0 if you are not using Windows services, you will need to manually end the FusionAuth processes process by closing the interactive command shell window. Beginning in version 1.40.0, please utilize the following shutdown command.

    Shutdown FusionAuth services
    
# Stop Services
<FUSIONAUTH_HOME>\bin\shutdown.ps1

    Then, run the appropriate FastPath install/upgrade command from the parent directory of FUSIONAUTH_HOME (if FUSIONAUTH_HOME is \fusionauth, run this command from \). Reference the commands defined in the install steps above to determine which install/upgrade command is appropriate for your environment.

    Prior to version 1.37.0, the startup command will be named startup.bat instead of startup.ps1.

    Start FusionAuth
    
# Startup Services
<FUSIONAUTH_HOME>\bin\startup.ps1

    Linux

    Zip

    In this example, we’ll assume you have previously installed FusionAuth in /usr/local/fusionauth and this directory will be referred to FUSIONAUTH_HOME. If you have used a different directory you can adjust the following example accordingly.

    Stop FusionAuth
    
<FUSIONAUTH_HOME>/bin/shutdown.sh

    Then, run the appropriate FastPath install/upgrade command from the parent directory of FUSIONAUTH_HOME (if FUSIONAUTH_HOME is /usr/local/fusionauth, run this command from /usr/local). Reference the commands defined in the install steps above to determine which install/upgrade command is appropriate for your environment.

    Start FusionAuth
    
<FUSIONAUTH_HOME>/fusionauth/bin/startup.sh

    RPM or DEB

    Running the update script will shut down the FusionAuth service if they have not yet been stopped The service will need to be restarted after the update is finished.

    Then, run the appropriate FastPath install/upgrade command anywhere in your filesystem. Reference the commands defined in the install steps above to determine which install/upgrade command is appropriate for your environment.

    Start FusionAuth
    
sudo systemctl start fusionauth-search
sudo systemctl start fusionauth-app

    Feedback

    How helpful was this page?

    See a problem?

    File an issue in our docs repo