How to update Credential Digger

Update library

If you use the python library, you can upgrade directly the credentialdigger package:

pip install --upgrade credentialdigger

In case you have installed Credential Digger in a virtual environment, remember to activate it before launching the upgrade command.

Update Docker container

Since there are 2 different setups for Docker, the update strategy depends on the setup you're running.

Single container (UI with sqlite database)

In this case, an upgrade will delete the database. In case you want to save your data, you can export it:

docker cp credential_digger_sqlite:/credential-digger-ui/data.db .

To update the container, we suggest to delete it, delete its image, and restart it from scratch:

# Stop container
docker stop credential_digger_sqlite  
# Remove container
docker rm credential_digger_sqlite  
# Remove image
docker image rm credential-digger_credential_digger
# Recreate and restart
docker-compose up --build 

In case you want to restore the old database, you can copy it in the new container (please note that you must have exported it before):

docker cp ./data.db credential_digger_sqlite:/credential-digger-ui/.

Two containers: UI and postgres

In case the Docker setup is based on postgres, then you will have 2 different containers running: the former for the UI (i.e., the backend), the latter for the database (postgres). Thus, with this configuration, we need to recreate only the container running the UI. All the data are stored in postgres (i.e, in the other container), and will be persisted with the update

# Stop container
docker stop credential_digger_backend  
# Remove container
docker rm credential_digger_backend
# Remove image
docker image rm credential-digger_credential_digger
# Recreate and restart
docker-compose -f docker-compose.postgres.yml up --build credential_digger

Major upgrades of the library

TODO