chore: add macos installation instructions (#118)

* chore: add macos installation instructions * chore: format code --------- Co-authored-by: markphelps <[email protected]>
flipt-io · Sep 13, 2023 · 8b8968e · 8b8968e
1 parent 08287df
commit 8b8968e
Showing 1 changed file with 30 additions and 6 deletions.
diff --git a/installation.mdx b/installation.mdx
@@ -16,7 +16,7 @@ Docker installation is required on the host, see the [official installation docs
   [20.10](https://docs.docker.com/engine/release-notes/20.10/) or higher.
 </Note>
 
-### Run the Image
+### Running
 
 ```console
 docker run -d \
@@ -56,7 +56,7 @@ application.
   [v1.6.1](https://github.com/flipt-io/flipt/releases/tag/v1.6.1).
 </Note>
 
-#### Configuration
+### Configuration
 
 A default configuration file within the image. To supply a custom configuration, update the `docker run` command to mount your local configuration into the container
 
@@ -99,11 +99,37 @@ You can install the Flipt Helm chart with the following command:
 helm install flipt flipt/flipt
 ```
 
+## Homebrew
+
+You can install Flipt using [Homebrew](https://brew.sh/) on macOS and Linux.
+
+Flipt runs as a service and is managed by [Homebrew Services](https://github.com/Homebrew/homebrew-services). This means you can start and stop Flipt using the `brew services` command.
+
+### Installing
+
+```console
+brew install flipt-io/brew/flipt
+```
+
+### Running
+
+```console
+brew services start flipt
+```
+
+Alternatively, you can start Flipt in the foreground using:
+
+```console
+flipt
+```
+
 ## Binary
 
 You can always download the latest release archive of Flipt from the
 [Releases](https://github.com/flipt-io/flipt/releases) section on GitHub.
 
+### Installing
+
 Download to an accessible location on your host and un-zip with the following
 commands (requires [jq](https://stedolan.github.io/jq/)):
 
@@ -116,10 +142,7 @@ $ curl -L "https://github.com/flipt-io/flipt/releases/download/v${FLIPT_VERSION}
 
 This archive contains the Flipt binary, configuration, README, LICENSE, and CHANGELOG files.
 
-<Note>
-  You will need to update the configuration file: `default.yml` if your database
-  locations differ from the standard locations.
-</Note>
+### Running
 
 Run the Flipt binary with:
 
@@ -141,6 +164,7 @@ Flipt is built for the following architectures/os:
 
 - **amd64** / **linux**
 - **arm64** / **linux**
+- **arm64** / **darwin**
 
 You can find the binaries for each architecture in the [Latest Release](https://github.com/flipt-io/flipt/releases/latest) assets section on GitHub.