Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update fast path install instructions. #2905

Merged
merged 1 commit into from
Feb 21, 2024
Merged

Update fast path install instructions. #2905

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 5 additions & 20 deletions astro/src/content/docs/get-started/download-and-install/_fast-path-install.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,37 +1,22 @@
### macOS
### macOS and Linux

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

```sh title="Install in your current working directory using ZIP packages"
```sh title="Install in your current working directory"
sh -c "curl -fsSL https://raw.githubusercontent.com/FusionAuth/fusionauth-install/master/install.sh | sh"
```
```sh title="Install in your current working directory using ZIP packages and include Elasticsearch"
```sh title="Install in your current working directory and 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.

```sh title="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"
```
```sh title="Install in your current working directory using ZIP packages and include Elasticsearch"
sh -c "curl -fsSL https://raw.githubusercontent.com/FusionAuth/fusionauth-install/master/install.sh | sh -s - -z -s"
```
```sh title="Install for all users on the system using DEB or RPM packages"
sh -c "curl -fsSL https://raw.githubusercontent.com/FusionAuth/fusionauth-install/master/install.sh | sh"
```
```sh title="Install for all users on the system using DEB or RPM packages and include Elasticsearch"
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.

```sh title="Install in your current working directory using ZIP packages. Install using Windows PowerShell"
```sh title="Install in your current working directory. Install using Windows PowerShell"
. { iwr -useb https://raw.githubusercontent.com/FusionAuth/fusionauth-install/master/install.ps1 } | iex; install
```
```sh title="Install in your current working directory using ZIP packages and include Elasticsearch. Install using Windows PowerShell"
```sh title="Install in your current working directory and include Elasticsearch. Install using Windows PowerShell"
. { iwr -useb https://raw.githubusercontent.com/FusionAuth/fusionauth-install/master/install.ps1 } | iex; install -includeSearch 1
```
32 changes: 2 additions & 30 deletions astro/src/content/docs/get-started/download-and-install/fast-path.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ By default, FusionAuth installs leveraging the database as the User search engin
### 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.
* `TARGET_DIR` - The location to install the zip. Defaults value is $PWD/fusionauth.
* `VERSION` - The version to install. Defaults to the latest stable version.

<FastPathInstall />
Expand All @@ -25,7 +25,7 @@ The following environment variables may be provided to the install script to aug

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

### macOS
### macOS and Linux
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.

```sh title="Shutdown FusionAuth"
Expand Down Expand Up @@ -62,31 +62,3 @@ Prior to version `1.37.0`, the startup command will be named `startup.bat` inste
# 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.

```sh title="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.

```sh title="Start FusionAuth"
<FUSIONAUTH_HOME>/fusionauth/bin/startup.sh
```

#### RPM or DEB

<Aside type="note">
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.
</Aside>

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.

```sh title="Start FusionAuth"
sudo systemctl start fusionauth-search
sudo systemctl start fusionauth-app
```
Loading