Fides Documentation – Ethyca
CLI Reference
Fides Sample Project
Command: deploy
Hands-on: Try the Fides Quick Start guide.
The fides deploy command starts the Cookie House sample project for testing and learning about Fides. The Cookie House is a fictional e-commerce application built in Next.js and with sample PostgreSQL and MongoDB databases for testing.
Note: The Cookie House sample project requires a current version of Python and Docker Desktop. For more assistance with this try the Fides Quick Start guide.
Usage Permalink for this section
Usage: fides deploy <command>
The following subcommands are available:
up- Deploy the Cookie House sample project using Docker.down- Destroy the Cookie House sample project and remove all user-created data so it can be restarted cleanly.
Running this command should result in output that resembles the examples below.
Example: Start the sample project Permalink for this section
This example initializes the Cookie house project
$ fides deploy up
Loaded config from: .fides/fides.toml
Docker version is compatible, starting deploy...
Pulling ethyca/fides image from DockerHub to match local fides version: 2.7.0
Attempting to pull:
- ethyca/fides:2.7.0
- ethyca/fides-privacy-center:2.7.0
- ethyca/fides-sample-app:2.7.0
Taxonomy successfully created.
----------
Processing policy resource(s)...
PUSHED 1 policy resource(s).
----------
Processing system resource(s)...
PUSHED 4 system resource(s).
----------
Processing organization resource(s)...
PUSHED 1 organization resource(s).
----------
Deployment successful! Initializing fides...
Directory './.fides' already exists.
Configuration file already exists: ./.fides/fides.toml
To learn more about configuring fides, see:
/platform/installation/quickstart
----------
███████╗██╗██████╗ ███████╗███████╗
██╔════╝██║██╔══██╗██╔════╝██╔════╝
█████╗ ██║██║ ██║█████╗ ███████╗
██╔══╝ ██║██║ ██║██╔══╝ ╚════██║
██║ ██║██████╔╝███████╗███████║
╚═╝ ╚═╝╚═════╝ ╚══════╝╚══════╝
Sample Fides project successfully deployed and running in the background!
- Visit docs.ethyca.com for documentation.
Run `fides deploy down` to stop the application.
Example: Destroy the sample project Permalink for this section
This example wipes all user data and stops the Docker containers so that the project can be restarted cleanly again.
$ fides deploy down
Loaded config from: .fides/fides.toml
[+] Running 9/7
⠿ Container sample_project-fides-pc-1 Removed 10.2s
⠿ Container sample_project-fides-1 Removed 2.0s
⠿ Container sample_project-redis-1 Removed 0.2s
⠿ Container sample_project-sample-app-1 Removed 0.3s
⠿ Container sample_project-fides-db-1 Removed 0.2s
⠿ Container sample_project-postgres-test-1 Removed 0.3s
⠿ Container sample_project-mongodb-test-1 Removed 0.2s
⠿ Volume sample_project_postgres Removed 0.0s
⠿ Network sample_project_default Removed 0.1s