Skip to content

datacontract-manager/datacontract-manager-ce

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 

Repository files navigation

Data Contract Manager (Community Edition)

Deploy to Azure

Data Contract Manager (Community Edition) is a free version of the Data Contract Manager that you can host yourself.

In the Community Edition, every user can change any data product or data contract.
If you need advanced role and permission management, SSO, or customizations, consider the Enterprise Edition.

Community support is offered in Slack in the channel #datacontract-manager.

Demo

Play with our demo app!

Getting Started

Data Contract Manager (Community Edition) is available as Docker image datacontractmanager/datacontract-manager-ce on Docker Hub.

Deploy to Azure or start Data Contract Manager (Community Edition) locally with Docker Compose:

git clone https://github.com/datacontract-manager/datacontract-manager-ce.git
cd datacontract-manager-ce
docker compose up --detach

Now you can access the Data Contract Manager (Community Edition) at http://localhost:8081.

NOTE: The Docker Compose configuration uses a dummy mail server, so no mails are actually sent. Configure our SMTP host accordingly as environment variables.

Requirements

  • Docker Resources: 1 CPU and 1 GB of RAM, more is better
  • PostgreSQL version 16 or newer
  • PostgreSQL with the extensions available: vector, hstore, uuid-ossp
  • SMTP server for transactional emails, such as SendGrid, AWS SES, Azure Communication Services email (Office 365 / Exchange is not recommended, as SMTP Basic Auth is deprecated)

Configuration

Configure an external database and mail server for production use.

Environment Variable Example Description
APPLICATION_HOST_WEB http://localhost:8081 The host of the application, used e.g., in email templates build URLs to Data Contract Manager.
APPLICATION_MAIL_FROM Data Contract Manager <[email protected]> The sender email address for emails.
SPRING_DATASOURCE_URL jdbc:postgresql://postgres:5432/postgres JDBC URL of the database
SPRING_DATASOURCE_USERNAME postgres Login username of the database
SPRING_DATASOURCE_PASSWORD postgres Login password of the database
SPRING_MAIL_HOST smtp.example.com SMTP server host
SPRING_MAIL_PORT 587 SMTP server port
SPRING_MAIL_USERNAME Login user of the SMTP server
SPRING_MAIL_PASSWORD Login password of the SMTP server
SPRING_MAIL_PROPERTIES_MAIL_SMTP_AUTH true Use basic authentication for SMTP
SPRING_MAIL_PROPERTIES_MAIL_SMTP_STARTTLS_ENABLE true Ensure that TLS is used

Deploy on Azure

Deploy to Azure

Use the Azure Resource Manager template to deploy Data Contract Manager as WebApp, together with a Postgres database in a virtual network. You need to provide SMTP server configuration.

Get help, reporting bugs and feature requests

Community support is offered in Slack in the channel #datacontract-manager.

Want to report a bug or request a feature? Open an issue.

License

The Data Contract Manager (Community Edition), being made available as a Docker image, is licensed under the Community License.

About

Data Contract Manager (Community Edition)

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages