README.EN.md

DocHub

Dochub is ArchOps tool. Dochub allows describing architecture as a code.

Dochub supports:

• PlantUML
• Markdown
• Mermaid
• Swagger
• AsyncAPI
• Manifests

Features

Dochub allows solves issues with:

• Versioning Architecture;
• Decentralized architecture management in Agile-oriented companies;
• Ecosystem Architecture Management;
• Unified portal of documentations;
• Consistency control;
• Extensible metamodel

Versioning Architecture

Dochub provides to manage architecture using Git.

Decentralized architecture management in Agile-oriented companies

DocHub can use external git repositories as external sources. It allows developing different parts of big project with several teams.

Ecosystem architecture management

DocHub is built with today's challenges in ecosystem architecture management in mind. In it, the products are interconnected, but develop autonomously. DocHub allows you to create a single information space for the ecosystem. Stimulates positive product synergy.

Unified portal of documentations

DocHub is the simplest way to a centralised documentation portal.

Consistency control

DocHub can find problems in the description of the architecture.

Extensible metamodel

МThe DocHub math model can be extended as you wish. It is possible to both modify existing entities and create your own.

An example of creating the C4 Model notation

Live demo portal

https://dochub.info/

Configure

Dochub configures with environment variables. Example available in example.env. Rename it to .env

cp -f example.env .env

Define the required environment variables in .env

Developing

Dochub is regular vuejs single page application (spa).

build with docker (simple)

Pay your attention! Docker builds can be much longer than regular npm way.

Requirements:

• docker >= v20
• docker-compose >= v2.2.3

export DOCKER_BUILDKIT=1 # or configure in daemon.json
export COMPOSE_DOCKER_CLI_BUILD=1
git clone [email protected]:RabotaRu/DocHub.git
cd DocHub
docker-compose up --build

build with npm (recommended)

Requirements:

• nodejs >= 20
• plantuml with shade plugin

0. you can deploy plantuml with docker as an external service

docker-compose up plantuml

1. Configure .env

VUE_APP_DOCHUB_GITLAB_URL=https://gitlab.example.com

2. Install dependencies. Results will available at ./node_modules directory.

npm install

2. Build SPA. Static files available at ./dist directory.

npm run build

3. Serve with nodejs. Open http://localhost:8080/main in your browser.

npm run serve

Deployment

You need the following components in order to work doсhub:

• Plantuml-server with shade plugin needs to render;
• Gitlab. Dochub uses gitlab as an auth.
  • Create OAuth2 provider in your GitLab. https://docs.gitlab.com/ee/integration/oauth_provider.html.

flowchart LR
    gitlab <--> dochub <--> plantuml

Loading

You can serve dochub like regular static site via nginx, s3 or something else.

Full VueJS documentation about deployment.

Kubernetes

You can use the helm chart

License

Apache License 2.0 Open source license.

Articles

• Архитектура как кот VS Архитектура как кол;
• Архитектура как данные;

Stargazers over time