Skip to content

PyPI version

Getting Started with a Local Stack

With the following commands can start and stop an entire DSP Stack locally with Docker Containers.

start-stack

This command runs a local instance of DSP-API and DSP-APP.

dsp-tools start-stack

DSP-TOOLS will ask you for permission to clean Docker with a docker system prune. This will remove all unused containers, networks and images. If you don't know what that means, just type y ("yes") and then Enter.

The following options are available:

  • --max_file_size=int (optional, default: 2000): max. multimedia file size allowed, in MB (max: 100'000)
  • --custom-host (optional, default: localhost): set a host to an IP or a domain to run the instance on a server
  • --latest (optional): instead of the latest deployed version, use the latest development version (from the main branch) of the backend components (api, sipi, fuseki, ingest)
  • --prune (optional): execute docker system prune without asking
  • --no-prune (optional): don't execute docker system prune (and don't ask)
  • --with-test-data (optional): start the stack with some test data
  • --suppress-update-prompt (optional): don't prompt when using an outdated version of DSP-TOOLS (useful for contexts without interactive shell, e.g. when the Terminal output is piped into a file)

Example: If you start the stack with dsp-tools start-stack --max_file_size=1000, it will be possible to upload files that are up to 1 GB big. If a file bigger than max_file_size is uploaded, the upload will be rejected.

More help for this command can be found here.

Login credentials for DSP-APP

To gain system administration rights inside a locally running DSP-APP, login with username root@example.com and password test.

stop-stack

When your work is done, shut down DSP-API and DSP-APP with

dsp-tools stop-stack

The following options are available:

  • --suppress-update-prompt (optional): don't prompt when using an outdated version of DSP-TOOLS (useful for contexts without interactive shell, e.g. when the Terminal output is piped into a file)

This deletes all Docker volumes, and removes all data that was in the database.