Diagrams.net

DETAILS: Tier: Free, Premium, Ultimate Offering: Self-managed

Introduced in GitLab 15.10.

Offline environment support introduced in GitLab 16.1.

With the diagrams.net integration, you can create and embed SVG diagrams in wikis. The diagram editor is available in both the plain text editor and the rich text editor.

On GitLab.com, this integration is enabled for all SaaS users and does not require any additional configuration.

On self-managed GitLab, you can choose to integrate with the free diagrams.net website, or use a self-managed diagrams.net site in offline environments.

To set up the integration on a self-managed instance, you must:

Choose to integrate with the free diagrams.net website or configure your diagrams.net server.
Enable the integration.

After completing the integration, the diagrams.net editor opens with the URL you provided.

Configure your diagrams.net server

You can set up your own diagrams.net server to generate the diagrams.

This is a required step for users on offline (or "air-gapped") self-managed GitLab installations.

For example, to run a diagrams.net container in Docker, run the following command:

docker run -it --rm --name="draw" -p 8080:8080 -p 8443:8443 jgraph/drawio

Make note of the hostname of the server running the container, to be used as the diagrams.net URL when you enable the integration.

For more information, see Run your own diagrams.net server with Docker.

Enable Diagrams.net integration

Sign in to GitLab as an Administrator user.
On the left sidebar, at the bottom, select Admin area.
Select Settings > General.
Expand Diagrams.net.
Select the Enable Diagrams.net checkbox.
Enter the Diagrams.net URL. To connect to:
- The free public instance: enter https://embed.diagrams.net.
- A self-managed diagrams.net instance: enter the URL you configured earlier.
Select Save changes.