Installation

Pseudify can be used in 2 variants that offer different features:

  • Variant 1: The pseudonymization setup intended for continuous integration/continuous delivery (CI/CD) systems. This variant can only run pseudonymization tasks.
  • Variant 2: The analysis setup that offers you a GUI for modeling the pseudonymization profile and additionally a locally hosted AI model for advanced PII detection.

The pseudonymization setup

Dependencies

The following components must be installed:

Get the install package

Go to some empty directory.
Download the "install package" and unpack the userdata in the current directory: 

$ docker run --rm -it -v "$(pwd)":/install -w /install -u $(id -u):$(id -g) alpine/curl /bin/sh -c "\
    curl -fsSL https://github.com/waldhacker/pseudify-ai/releases/latest/download/install-package.tar.gz -o install-package.tar.gz \
    && tar -xzf ./install-package.tar.gz ./userdata \
    && rm -f ./install-package.tar.gz \
"

Run pseudify

Now you can test whether pseudify is running correctly:

$ docker run --rm -it -v "$(pwd)/userdata/":/opt/pseudify/userdata/ \
    ghcr.io/waldhacker/pseudify-ai:2.0 pseudify:information

If you need to know how to manage database access look at the configuration chapter.

The analyze setup

For local use only

The GUI is designed as as a single user app and intended for local usage on a development machine.
This is important for security reasons.
NEVER EVER host the analyze setup on a publicly accessible server.

Dependencies

The following components must be installed:

If you want to use the AI support, you need to install:

Get the install package

Go to some empty directory.
Download the "install package" and unpack it in the current directory: 

$ docker run --rm -it -v "$(pwd)":/install -w /install -u $(id -u):$(id -g) alpine/curl /bin/sh -c "\
    curl -fsSL https://github.com/waldhacker/pseudify-ai/releases/latest/download/install-package.tar.gz -o install-package.tar.gz \
    && tar -xzf ./install-package.tar.gz \
    && rm -f ./install-package.tar.gz \
"

Start pseudify without AI support:

$ docker compose up -d

Start pseudify with AI support:

$ docker compose -f docker-compose.yml -f docker-compose.llm-addon.yml up -d
$ docker exec -it pseudify_ollama bash -c 'ollama pull $OLLAMA_MODEL'

Launch the GUI

Now go to your browser an open http://127.0.0.1:9669 to access the GUI.

If you need to know how to manage database access look at the configuration chapter.

Shutdown (without AI support):

$ docker compose down

Shutdown (with AI support):

$ docker compose -f docker-compose.yml -f docker-compose.llm-addon.yml down