Vault

From Vault Definition

Definition: A vault is a folder where you store your notes and supporting assets (e.g., images).

Comparison with other software

Thorg vault is similar to Dendron Vault.

From Vault Requirements

For a folder to be recognized as a vault for a given workspace the following requirements must be met:

Must be registered in $THORG_WORKSPACE/.thorg/data/workspace_config.json
- Why: So that workspace is aware that we want this folder to be recognized as a vault. This is most useful if you
Must contain $VAULT/root.md with valid globally unique 'id' in FrontMatter
- Why: So that we can have globally unique identifier for the vault.

From Vault Properties

From vault Id

vault Id The vault id comes from the 'id' in FrontMatter of the root.md note located directly under your vault folder.

YOUR_WORKSPACE_DIR/YOUR_VAULT_1/root.md

YOUR_WORKSPACE_DIR/YOUR_VAULT_1/root.md contents:

---
id: abc123
---

abc123 is the vault id of YOUR_VAULT_1

From Vault Name

The Thorg vault name is simply the name of the folder under your workspace.

To keep things simple, for now there is NO separate name configuration for the vault.

Q: What if I have different Git repositories with the same name? A: Clone with different local names.

Let's say you have two repositories from different users that share the same name:

git@gitlab.com:user-1/public.git
git@gitlab.com:user-2/public.git

Cloning these as-is would create conflicting directory and vault names. To avoid this, assign different names when cloning:

git clone git@gitlab.com:user-1/public.git ./user-1-public
git clone git@gitlab.com:user-2/public.git ./user-2-public

This creates two separate directories and therefore two different vault names:

./user-1-public
./user-2-public

Many to Many:Thorg Workspace
- A vault can be part of multiple workspaces, and a workspace can have multiple vaults. See Common Thorg Workspace Patterns

thorg.vault.register - registers existing vault or creates and registers a new vault with Thorg Workspace.

Children

Backlinks

Relationships