Installation¶

Prerequisites¶

Ensure that you have PostgreSQL utilities preinstalled, matching the major version of your destination server.
If you are building Greenmask from source, make sure you have the make utility installed.

From GitHub binaries¶

The easiest way to install Greenmask is by using the latest release's binary. Follow these steps:

Check the latest Greenmask release.
From Assets, download the required binary.
Execute the downloaded binary to start using Greenmask.

Additional instructions for macOS users¶

For those downloading greenmask-macos-amd64 or greenmask-macos-arm64, additional steps are required to ensure proper execution.

In your terminal, move to the directory where the Greenmask binary is located.
Change the file permissions to make it executable by using the following command:
```
chmod 777 greenmask-macos-[version]
```
Remove a quarantine attribute, which macOS may have applied, by using the following command:
```
xattr -d com.apple.quarantine greenmask-macos-[version]
```
Info

In both commands above, replace [version] with amd64 or arm64 according to your download.

From source¶

Clone the Greenmask repository by using the following command:
```
git clone git@github.com:GreenmaskIO/greenmask.git
```
Once the repository is cloned, execute the following command to build Greenmask:
```
make build
```

After completing the build process, you will find the binary named greenmask in the root directory of the repository. Execute the binary to start using Greenmask.