Sharing & Collaboration

Overview

There are different options to share projects with others:

• Public: Anyone with the link can access it.
• Password-protected: Anyone with the link and password can access it.
• Private: Only invited people can access it.

By default, dbdocs projects created are accessible by public, which means anyone can view it via the shareable link.

Access Control and Pricing Tiers

The features available for sharing and collaboration depend on your pricing tier. Here's a breakdown of what each tier offers:

Feature	Free	Personal Pro	Team
Public link sharing	✅	✅	✅
Password-protected link sharing	✅	✅	✅
Private mode	❌	✅	✅
Share with invited users	❌	• Guest viewers: Up to 5 per project • Guest editors: ❌	• Guest viewers: Unlimited • Guest editors: Up to 6 per workspace
Share with workspace members	❌	❌	• Viewers: Unlimited • Editors: Unlimited (based on workspace editor licenses)

Note:

• Guest viewers and editors are users invited to specific projects, not to the entire workspace.
• Workspace members in the Team plan have access to all shared projects within the workspace, based on their assigned roles.

Password protection

Set Password

Your dbdocs project is set to be public by default. However, you can use the "Share" button on the project page to enable password protection for a project, or you can use the following command with dbdocs CLI:

$ dbdocs password --set <password> --project <project name>
✔ Password is set for <project name>

Or

$ dbdocs password --project <project name>
? Enter password: [hidden]
? Re-enter password: [hidden]
✔ Password is set for <project name>

Or you can build your project with password by using build command with --password

$ dbdocs build <path to your dbml file>/database.dbml --password <password>
Pushing new database schema to project your_project...
✔ Password is set for 'Ecommerce'
Done. Visit: https://dbdocs.io/khanh-tran-quoc/Ecommerce

Now your project is protected, only the one who have your password can access your project.

Remove Password

Remove password from your project to make it public

$ dbdocs password --remove --project <project name>
⚠ Password is removed from 'Ecommerce'

Private mode

info

This feature is available in our Personal Pro plan

You may retrictly control who can access your dbdocs project by using private mode and inviting other users to your project.

To do this, set the project to Private mode, meaning only invited people can view your project.

Invite people to your projects

info

This feature is available in our Personal Pro (invite viewers only) and Team plan

You can invite users with specific permission using their email addresses.

Invited users with "can edit" permission will be able to:

• Publish changes to invited projects via dbdocs CLI with command:
  dbdocs build <dbml file path> --project <username>/<project name>
• Edit Markdown notes and diagram layouts directly on the document project page.

Share projects with workspace members

info

This feature is available in our Team plan

Share documentation projects within your workspace to grant all members access.