If you’ve deployed a local instance of the Wizard (Docker or build from source), we kindly request you to fill out this DS Wizard instance registration.
The application is currently deployed on a server provided by CESNET. Here are the addresses of running applications:
The simplest way is to use Docker Compose. Requirements are just to have Docker installed, privileges for current user and the Docker daemon started.
Create a folder (e.g.,
/dsw, all commands in this manual are from this working directory)
Copy (and adjust) docker-compose.yml provided below
Run the DSW with Docker compose
docker-compose up -d
After starting up, you will be able to open the Wizard in your browser on http://localhost
You can use
docker-compose logsto see the logs and
docker-compose downto stop all the services
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43
version: '3' services: server: image: datastewardshipwizard/wizard-server restart: always ports: - 3000:3000 volumes: - /dsw/server/application.yml:/application/engine-wizard/config/application.yml:ro - /dsw/server/integration.yml:/application/engine-wizard/config/integration.yml:ro - /dsw/templates/dmp:/application/engine-wizard/templates/dmp:ro client: image: datastewardshipwizard/wizard-client restart: always ports: - 80:80 environment: API_URL: http://localhost:3000 docworker: image: datastewardshipwizard/document-worker restart: always volumes: - /dsw/docworker/config.cfg:/app/config.cfg:ro - /dsw/templates/dmp:/app/templates:ro rabbitmq: image: rabbitmq:3.8.2-management restart: always environment: RABBITMQ_DEFAULT_USER: rabbit RABBITMQ_DEFAULT_PASS: password mongo: image: mongo:4.0.12 restart: always ports: - 27017:27017 volumes: - /dsw/data:/data/db command: mongod
You can take a look at https://github.com/ds-wizard/dsw-deployment-example
Locally without Docker¶
We highly recommend using Docker, but you are open to compile and run everything directly on your device. It is tested on Ubuntu 16.04 and you might encounter problems when using other plaforms and Linux distributions.
The Haskell tool Stack (for server side)
NPM (for client side)
MongoDB (database, needs to be running)
RabbitMQ (messaging, needs to be running)
Python (>= 3.7, document worker)
wkhtmltopdf (>= 0.12.5, for DMP exports in PDF)
Pandoc (>= 2.6, for DMP exports in other formats aside HTML, PDF, and JSON)
Get the server app (dsw-server)
git clone https://github.com/ds-wizard/engine-backend.git
Copy and edit configuration (see Configuration)
cp engine-wizard/config/application.yml.example engine-wizard/config/application.yml
Build (may take some time to download & build dependencies)
stack build engine-wizard
Run (requires MongoDB according to configuration)
stack exec engine-wizard
Be aware that running engine-wizard requires its assets (e.g.
config/) to be present in the working directory or where configured, e.g,
Be aware that running dsw-server requires its assets (e.g.
config/) to be present in the working directory.
Get the client app (dsw-client)
git clone https://github.com/ds-wizard/engine-frontend.git
Install the app (dependencies)
Run the app
npm run start:wizard
Open app in your favorite browser
For minified production-ready version, use
npm run build:wizard
Get the document-worker
git clone https://github.com/ds-wizard/document-worker.git
Install it using
pip install .
Adjust configuration for your setup (see Configuration)
Run the app
docworker config.cfg /path/to/templates
If you need to upgrade MongoDB version, follow the official instructions in their documentation.
Initially, migrations will fill the database with predefined data needed including three users, all with password “password”:
You can use those accounts for testing or to initially made your own account admin and then delete them.
Having public instance with default accounts is a security risk. Delete or change default accounts (mainly Albert Einstein) if your DSW instance is public as soon as possible.
When you have your own self-hosted instance, it is essential for you to register within the Registry service. It is source of shared knowledge models and can support your deployment. After registration of your organization with unique ID and email verification, you will get your token. This token is then used in Registry configuration. Then your instance is connected automatically to the Registry service for specific functionality such as accessing shared knowledge models.
Initial Knowledge Model¶
When you have a fresh installation, there are just the default users and no knowledge models. You are free to create a new one from scratch if you want. Other option is to import existing KM
dsw:root:X.Y.Z from the Registry. It is the core knowledge model for general data stewardship. The specific latest version (or other version that is the best for you) as well as other shared knowledge models can be found on the landing page of the Registry service. Other option is to import it from file if you have any (according to Usage)
If you also need to enable public questionnaire for Questionnaire demo functionality with this core knowledge model, you have to download public-package-root-2.0.0.json file below and import it directly to the database into publicPackages collection. Optionally, you can move some of your packages similarly.
$ mongoimport --db dsw-server \ --collection publicPackages \ --file public-package-root-2.0.0.json
(If using Docker, you will need docker exec.)
For public questionnaire correctly running, you need to import the related Knowledge Model in the Wizard otherwise you will end up with
Entity does not exist error.
If you want to regularly backup your database (and you should!), all you need to do is to set-up simple script as cronjob:
1 2 3 4 5 6 7 8 9 10
#!/bin/bash # Location of Mongo's data folder (Dockerized Mongo) MONGO_DATA_DIR=/dsw/mongo/data # - or your Mongo without using Docker # - MONGO_DATA_DIR=/data/db # Target for storing backups TARGET_DIR=/var/backups/dsw # Backup BACKUP_FILE=$TARGET_DIR/backup_$(date +%d%m%y-%H%M).tgz tar czf $BACKUP_FILE $MONGO_DATA_DIR
Make it executable (chmod a+x dsw-backup.sh) and add it as cronjob with crontab -e:
0 4 * * * /dsw/dsw-backup.sh
(This will do the backup every day at 4:00 AM. For more information, see crontab.guru.)