Files
dnd-vault-template/README.md
2026-07-13 17:08:55 +02:00

25 lines
998 B
Markdown

# DND Vault Template
Template for publishing DND campaign vaults
## Instructions
- Create a deploymenty machine where you should have ssh access
- Create a repository with your vault
- All the notes should fall under `content/` inside your vault
- Place `gitea/workflows/deploy.yml` under `.gitea/workflows/deploy.yml`.
- Change env variables
- When you push on the vault repository, the workflow file will clone and setup this nuxt app with the contents of the vault and publish it.
## Env variables
For gitea, you should set:
- `DEPLOY_HOST`: Host to deploy the vault
- `DEPLOY_KEY`: SSH id_ed25519 for accessing the host
- `REGISTRY_USER`: User for the docker registry
- `REGISTRY_PASSWORD`: Password to the docker registry
Inside deploy.yml:
- `TEMPLATE_REPO_URL`: Should point to THIS repo
- `TARGET_SUBFOLDER`: Where to clone content of the vault. No need to change it from `template/content`
- `VAULT_NAME`: Your vault name. Used for the name of the generated docker images