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.

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.

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 most frequently used options are:

  • --max_file_size=int (optional, default: 2000): max. multimedia file size allowed, in MB (max: 100'000) If you attempt to upload a multimedia file bigger than max_file_size, it will be rejected.
  • --prune (optional): execute docker system prune without asking
  • --no-prune (optional): don't execute docker system prune (and don't ask)

To see all possible options, type dsp-tools start-stack --help.

More help for this command can be found here.

stop-stack

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

dsp-tools stop-stack

To see all possible options, type dsp-tools stop-stack --help.

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