Handling API keys¶

Generating GitHub API¶

Your GitHub token can be generated on your GitHub setting. The correct settings should already be applied. To avoid generating a new token every few months, select the “No expiration” option. Click the “Generate token” button and copy the token you are presented with on the next page.

Using env to prevent exposing your API keys¶

To protect you from exposing API keys, GitHub will scan your public repo and prevent you to push if it finds one. If the key is a GitHub key, it will expire the key immediately, forcing you to generate a new one and adding it to Enveloppe again, which is annoying. To avoid this, you can store the key in a standalone file, and have it not be added when commiting. That standalone file is called env. By default it is in the Envenloppe path: .obsidian/plugins/obsidian-mkdocs-publisher/env. You can change the path with the button next to the field.

To have it not be added when commiting, create a file .gitignore in the root of the vault with this content:

.obsidian/plugins/obsidian-mkdocs-publisher/env
.obsidian/plugins/obsidian-mkdocs-publisher/logs.txt

Updating API keys in multiple vaults¶

In the case you use one same key in multiple vaults, the below script will help you automate updating the key in all vaults at once. Install Node and create a file named Update GitHub API key.ts with the content below, then run this in the terminal:

npm i -D tsx
npx tsx "Update GitHub API key.ts"

Here is the content of the script:

import fs from 'node:fs';
import path from 'node:path';

type AbsolutePath = string & { readonly isAbsolute: true };
const ALL_VAULT_FOLDER = path.join("C:", "vault", "folder") as AbsolutePath;
const API_GITHUB = "XXXXXXXXXXXXXXXXXXXX"

async function hasObsidianSetting(folder: AbsolutePath) {
  try {
    for await (const dirEntry of fs.readDir(folder)) {
      if (dirEntry.isDirectory && dirEntry.name === ".obsidian") return true;
    }
    return false;
  }
  return false;
}

async function updateEnvEnveloppe(subfolder: AbsolutePath) {
const env = `GITHUB_TOKEN=${API_GITHUB}`
  const pathToEnvEnveloppe = path.join(subfolder, ".obsidian", "plugins", "obsidian-mkdocs-publisher", "env");
  try {
    await fs.writeTextFile(pathToEnvEnveloppe, env);
  }
}

async function updateAllVault(folder: AbsolutePath = ALL_VAULT_FOLDER) {
  for await (const dirEntry of fs.readDir(folder)) {
    const subFolder = path.join(folder, dirEntry.name) as AbsolutePath;
    if (await hasObsidianSetting(subFolder)) {
      await updateEnvEnveloppe(subFolder);
    } else if (dirEntry.isDirectory) {
      await updateAllVault(subFolder);
    }
  }
}

await updateAllVault();