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.

Via docker¶

You can find the docker images in the:

Docker-hub page

To run the greenmask container from DockerHub, use the following command:

docker run -it greenmask/greenmask:latest

GitHub container registry

To run the greenmask container from Github registry, use the following command:

docker run -it ghcr.io/greenmaskio/greenmask:latest

Info

For pre-releases (rc, beta, etc.), use explicit tags like v0.2.0b2.

Via brew¶

The greenmask build is available in brew, but only a production build is available. To install the greenmask via brew, use the following command:

brew install greenmask

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.

Playground¶

Greenmask Playground is a sandbox environment for your experiments in Docker with sample databases included to help you try Greenmask without any additional actions. Read the Playground guide to learn more.