Skip to content
Permalink
master
Switch branches/tags
Go to file
 
 
Cannot retrieve contributors at this time

Installation

Attention!

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.

Public Instances

The application is currently deployed on a server provided by CESNET. Here are the addresses of running applications:

Tip

You are free to register and test out the Wizard within the ds-wizard.org. Then you can decide if you want a local instance for you or your organization. Eventually you can contact us about DSW Cloud service where we can host and maintain your DSW instance, see our Get Started page.

Registry

When you have your own self-hosted instance, it is essential for you to register within the DSW Registry. 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 :ref:`config-settings`. Then your instance is connected automatically to the Registry service for specific functionality such as accessing shared knowledge models and document templates.

Own Instance

Warning

For production use, consult deployment and other operations with your sysadmin or contact us for professional services.

The following instructions are recommended only for local deployment and trying it out. It does not include any safety measures that are required for production deployment and are handled differently based on specific requirements and deployment site.

With Docker

The simplest way is to use Docker Compose. Requirements are just to have Docker installed, privileges for current user and the Docker daemon started.

  1. Visit and clone https://github.com/ds-wizard/dsw-deployment-example
  2. Check config files (described in :ref:`Configuration`), especially application.yml and docker-compose.yml
  3. Run the DSW with Docker compose docker-compose up -d
  4. After starting up, you will be able to open the Wizard in your browser on http://localhost:8080
  5. You can use docker-compose logs to see the logs and docker-compose down to stop all the services

Without Docker

We highly recommend using Docker, but you are open to compile and run everything directly on your device. It is tested and distributed using Ubuntu 18.04. Additional expertise related to programming and building/running Elm, Haskell, Python, and others is required.

The related code and instructions are available:

Default Users

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.

!DANGER!

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.

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 :ref:`usage`).

Database Backup

If you want to regularly backup your database (and you should!), all you need to do is to setup a cronjob that backups PostgreSQL database (e.g. using pg_dump utility) as well as S3 storage.

Deployment Requirements

The following requirements were estimated using limiting Docker resources provided to containers.

Component Minimal Recommended
Server 128 MB 512 MB
Client 16 MB 64 MB
Doc-Worker 240 MB 448 MB
Total 384 MB 1024 MB

As for CPU, there are no long-running tasks that would require excessive CPU consumption. Limiting CPU resources can only make some operations slightly longer (e.g. importing a knowledge model, generating a document). Number of CPUs/cores will then affect performance for concurrent users/actions. Memory consumption is affected by size of content (as some content is being cached for speed optimizations).

Memory used by document worker might be affected by size of template (and assets) for generating a document. Recommended memory in the table above is approximated for long-term run (without restarts) with a significant amount of contents. It also minimizes the need of garbage collection technique that may slow down the server component.

Note

Real requirements should be aligned with the intended use (number of concurrent users, number of users in total, size of document templates, etc.). The minimal requirements are sufficient for single-user deployment, recommended should handle tens of concurrent users.