Running Fidesctl in Docker
The recommended way to get Fidesctl running is via Docker. The following guide will describe how to get things going, step-by-step.
Docker and Docker-Compose are the only requirements here.
dockerlocally (see Docker Desktop or your preferred installation). The minimum verified Docker version is
- If your
dockerinstallation did not include
docker-compose, make sure to get at least version
1.29.0. Installation instructions can be found here.
- In a new project folder (or in the root directory of your current project), create a
This is a reference file that you can copy/paste into a local
docker-compose.yml file, which should be created in your project's root folder. It will create a database and spin up the fidesctl webserver.
Make sure that you don't have anything else running on port
8080 before using this file.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47
Now you can start interacting with your installation. Run the following commands to get going:
docker-compose up -d-> This will spin up the docker-compose file in the background.
docker-compose run --rm fidesctl /bin/bash-> This opens a shell within the fidesctl container.
fidesctl init-> This will create a default configuration file at
1 2 3 4 5 6 7 8
Created a fidesctl config file: ./.fides/fidesctl.toml To learn more about configuring fidesctl, see: https://ethyca.github.io/fides/installation/configuration/ ---------- For example policies and help getting started, see: https://ethyca.github.io/fides/guides/policies/ ---------- Fidesctl initialization complete.
fidesctl status-> This confirms that your
fidesctlCLI can reach the server and everything is ready to go!
Once your installation is running, you can use
fidesctl from the shell to get a list of all the possible CLI commands.
You're now ready to start enforcing privacy with Fidesctl!
See the Tutorial page for a step-by-step guide on setting up a Fidesctl data privacy workflow.