Deployment
It is a good idea to first try out DSW using the public instances before going for other options (self-hosted or DSW Cloud).
When you have your own self-hosted instance, it is essential for you to register within the DSW Registry. It is a source of shared knowledge models and can support your deployment. After registration of your organization with a unique ID and email verification, you will get your token. This token is then used in Settings. Then your instance is connected automatically to the Registry service for specific functionality such as accessing shared knowledge models and document templates.
For production use, consult deployment and other operations with your sysadmin or contact us for professional services.
The following instructions are intended 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 (e.g. using HTTPS, enabled websockets, backups, and many others).
The simplest way is to use Docker Compose. Requirements are just to have Docker installed, privileges for current users, and the Docker daemon started. At least basic knowledge of Docker is required.
- 1.
- 2.Check config files (described in Configuration), especially
dsw.ymlanddocker-compose.yml - 3.Run the DSW with Docker compose
docker-compose up -d - 4.
- 5.You can use
docker-compose logsto see the logs anddocker-compose downto stop all the services
It is important to use latest patch version, you should monitor the documentation if new hotfix releases are available.
We highly recommend using Docker, but you are open to compile and run everything directly on your device. Additional expertise related to programming and building/running Elm, Haskell, Python, and others is required.
The related code and instructions are available:
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 a 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. Also, adjust authentication settings according to your needs.
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. Another 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 versions that is the best for you), as well as other shared Knowledge Models, can be found on the landing page of the Registry service. Another option is to import it from a file if you have any (according to usage).If you want to regularly backup your database (and you should!), all you need to do is to set up a cronjob that backups PostgreSQL database (e.g. using pg_dump utility) as well S3 storage.
Component | Minimal | Recommended |
Server | 128 MB | 512 MB |
Client | 16 MB | 64 MB |
Document 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). A number of CPUs/cores will then affect performance for concurrent users/actions. Memory consumption is affected by the size of the content (as some content is being cached for speed optimizations).
Memory used by document workers might be affected by the size of the template (and assets) for generating a document. Recommended memory in the table above is approximated for a long-term run (without restarts) with a significant amount of content. It also minimizes the need for garbage collection techniques that may slow down the server component.
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.
Last modified 26d ago