First official commit

README.md

@@ -1,13 +1,25 @@
-# Simple Publisher
+# DND Vault Template
 
-Dead simple self hosted Obsidian publisher.
+Template for publishing DND campaign vaults
 
-## How does it work
+## Instructions
 
-You have your vault synced through git to some remote repository.
+- 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.
 
-When you push to the vault repository this triggers a webhook to a repo that you have with this cloned repo, it does something magic and then it deploys a website to wherever you like.
+## Env variables
 
-Also you can have multiple vaults!
+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
 
-Valuts -> Simple Publisher -> Multiple deployment sites
+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