https://github.com/fusionauth/homebrew-fusionauth
macOS Homebrew tap for FusionAuth
https://github.com/fusionauth/homebrew-fusionauth
fusionauth homebrew homebrew-tap macos
Last synced: 8 months ago
JSON representation
macOS Homebrew tap for FusionAuth
- Host: GitHub
- URL: https://github.com/fusionauth/homebrew-fusionauth
- Owner: FusionAuth
- License: apache-2.0
- Created: 2018-10-06T18:07:42.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2024-09-12T22:52:45.000Z (over 1 year ago)
- Last Synced: 2024-09-13T11:20:07.809Z (over 1 year ago)
- Topics: fusionauth, homebrew, homebrew-tap, macos
- Language: Ruby
- Homepage: https://fusionauth.io
- Size: 157 KB
- Stars: 2
- Watchers: 11
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# homebrew-fusionauth
macOS [Homebrew](https://brew.sh/) tap for FusionAuth
Easy installation of FusionAuth via Homebrew.
Simply install and start the services. Then navigate to http://localhost:9011 and follow the setup prompts.
# Installation
The following examples assume you will be installing `fusionauth-app`. And `postgresql` as well as `opensearch` as prerequisites.
## Prerequisites
FusionAuth requires a database and a search engine. The recommended database is PostgreSQL, and the recommended search engine is OpenSearch.
> [!IMPORTANT]
> fusinauth-search was announced end of life in [FusionAuth Version 1.48.0](https://fusionauth.io/docs/release-notes/#version-1-48-0) and is no longer available for homebrew. It is recommended to use OpenSearch instead.
### Postgres
If you don't have PostgreSQL installed, you can install it using Homebrew:
```bash
# Install PostgreSQL 16
brew install postgresql@16
# Check the service status
brew services info postgresql@16
# Start PostgreSQL 16 service
brew services start postgresql@16
```
To run the FusionAuth installation in silent mode, you need to create a PostgreSQL user and database for FusionAuth. You can do this with the following commands:
```bash
# Ensure the PostgreSQL binaries are in your PATH
export PATH="$PATH:$(brew --prefix postgresql@16)/bin"
# Create the fusionauth user fusionauth with password fusionauth
psql --command="CREATE USER fusionauth PASSWORD 'fusionauth'" --command="\du" postgres
# Create the fusionauth database owned by the fusionauth user
createdb --owner=fusionauth fusionauth
```
### OpenSearch
If you don't have OpenSearch installed, you can install it using Homebrew:
```bash
brew install opensearch
brew services info opensearch
brew services start opensearch
```
## Install FusionAuth
To install FusionAuth using Homebrew, you can use the following commands:
```bash
brew tap fusionauth/fusionauth
brew install fusionauth-app
```
### Silent Configuration
After installing FusionAuth, you can configure it before starting the service to run a silent configuration. The configuration file is located at `$(brew --prefix)/etc/fusionauth/fusionauth.properties`.
```bash
# Add linebreak to the end of the fusionauth.properties file
echo "" >> $(brew --prefix)/etc/fusionauth/fusionauth.properties
# Add your kickstart file path
echo "fusionauth-app.kickstart.file=/path/to/your/kickstart/kickstart.json" >> $(brew --prefix)/etc/fusionauth/fusionauth.properties
# Add the silent mode property
echo "fusionauth-app.silent-mode=true" >> $(brew --prefix)/etc/fusionauth/fusionauth.properties
# Change the search.type=database to search.type=elasticsearch
sed -i '' 's/search.type=database/search.type=elasticsearch/g' $(brew --prefix)/etc/fusionauth/fusionauth.properties
# Add the open search URL
echo "search.servers=http://localhost:9200" >> $(brew --prefix)/etc/fusionauth/fusionauth.properties
# Check the full configuration
cat $(brew --prefix)/etc/fusionauth/fusionauth.properties
```
## Manage FusionAuth
After installing and configuring FusionAuth, you can manage the service using Homebrew.
### Start
After configuring FusionAuth, you can start the service using Homebrew:
```bash
brew services start fusionauth-app
```
### Status
You can check the status of the FusionAuth service using:
```bash
brew services info fusionauth-app
```
And check the logs using:
```bash
cat $(brew --prefix)/var/log/fusionauth/fusionauth-app.log
```
### Upgrade
To upgrade FusionAuth, you can use the following command:
```bash
brew upgrade fusionauth-app
```
### Stop
To stop the FusionAuth service, you can use:
```bash
brew services stop fusionauth-app
```
## Uninstall FusionAuth
To uninstall FusionAuth, you can use the following command:
```bash
# Stop the FusionAuth service if it is running
brew services stop fusionauth-app
# Uninstall FusionAuth
brew uninstall fusionauth-app
```
### Remove Configuration
If you want to remove the configuration and log files as well, you can search for the files and folders in `$(brew --prefix)` and remove them manually.
### Untap FusionAuth
```bash
brew untap fusionauth/fusionauth
```