From afbcc95ccef744588c15ef0aaf864de53dc1fc9b Mon Sep 17 00:00:00 2001
From: Paul Wilde <paul@paulwilde.uk>
Date: Tue, 3 Sep 2024 11:10:46 +0100
Subject: [PATCH] gitignore changes

---
 .gitignore                                    |  3 +-
 .../reference/example_configuration.md        |  1 +
 .../templates/shortcodes/get_source.html      |  2 +
 examples/norg.toml.sample                     | 62 ++++++++++++++-----
 4 files changed, 52 insertions(+), 16 deletions(-)
 create mode 100644 docs/themes/norgbackup/templates/shortcodes/get_source.html

diff --git a/.gitignore b/.gitignore
index 3a64253..fa635f6 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,3 +1,2 @@
 bin
-*.toml
-test
+*test*
diff --git a/docs/content/reference/example_configuration.md b/docs/content/reference/example_configuration.md
index fa4b1f6..30c9398 100644
--- a/docs/content/reference/example_configuration.md
+++ b/docs/content/reference/example_configuration.md
@@ -3,6 +3,7 @@ title = "Example Configuration"
 weight = 10
 +++
 Below is an example configuration in [`toml`](https://toml.io) format which can be used as a base for setting up a new norg backup.  
+{{ get_source(path="static/norg.toml.sample") }}
 ```toml
 # Defines what folders you would like to back up
 source_directories = [
diff --git a/docs/themes/norgbackup/templates/shortcodes/get_source.html b/docs/themes/norgbackup/templates/shortcodes/get_source.html
new file mode 100644
index 0000000..122698e
--- /dev/null
+++ b/docs/themes/norgbackup/templates/shortcodes/get_source.html
@@ -0,0 +1,2 @@
+{% set data = load_data(path=path) %}
+{{ data | markdown | safe }}
diff --git a/examples/norg.toml.sample b/examples/norg.toml.sample
index 4bd8b71..ee7f8fd 100644
--- a/examples/norg.toml.sample
+++ b/examples/norg.toml.sample
@@ -1,24 +1,48 @@
-# Source Directories you would like to back up in a TOML list format
+# Defines what folders you would like to back up
 source_directories = [
-    "/home/me/Music",
-    "/home/me/Pictures"
+  "/home/me",
+  "/opt/other_things"
 ]
 
-# Repositories to back up to, in separate TOML objects
+# Defines your backup repository/repositories
 [[repositories]]
-label = "A Repository"
-path = "/my/backup/location"
+label = "LocalBorgBackup"
+path = "/path/to/backup"
+# You can define to backup tool here, default is "borg"
+tool = "borg"
+
+# You can add more repositories of varying types.
+# When defining multiple repositories, a new backup will run for each repository 
+# defined.
 [[repositories]]
-label = "Another Respository at BorgBase"
+label = "RemoteBorgBase"
 path = "ssh://1234abcd@1234abcd.repo.borgbase.com/./repo"
+tool = "borg"
 
-# Encryption Configuration
+[[repositories]]
+label = "LocalResticBackup
+path = "/path/to/another/backup"
+
+# You can define restic as a backup tool
+tool = "restic"
+
+# if a repository is append-only, you can tell norg not to try and prune it
+# Note: This does not set the actual repository as append-only, only informs Norg
+# so the prune step does not run which can cause failed notifications with restic
+append_only = true
+
+# Defines encryption information i.e. backup encryption passphrase
+# If a passphrase is not set or is incorrect, borg/restic will prompt you for one 
+# which is likely to cause your backups to not run.
 [encryption]
-# `encryption_passphrase` gets set as the `BORG_PASSPHRASE` env var
-encryption_passphrase = "MyReallySecurePassword"
-# I hope to add more Borg encryption env vars here in time
+# Set a string variable for the passphrase
+encryption_passphrase = "MyVeryS3curePassphrase!"
 
-# Actions that are called at various times during runtime
+# Get the passphrase from the result of a command
+# encryption_passcommand = "cat my_passphrase.txt"
+
+# These actions can be configured to run scripts (i.e. back up a database) 
+# at various times throughout the running process
 [actions]
 # "everything" means before or after every possible option for all repositories
 before_everything = ["echo before everything"]
@@ -42,15 +66,25 @@ after_compact = ["echo after compact"]
 before_check = ["echo before check"]
 after_check = ["echo after check"]
 
+# Send a status update to Uptime Kuma
+# more status monitor tools are planned to be supported in the future
 [uptimekuma]
 # The base/push url of your Uptime Kuma monitor - without the query string.
-# The quenry string will be generated at run time and will change dependant on the state of your backup.
+# The query string will be generated at run time and will change dependant on the state of your backup.
 base_url = "https://uptime.kuma.url/api/push/1234abcd"
 
 # what backup states you wish to send an alert for, defaults to Success, Failure and Running
 states = ["Success","Failure", "Running"]
 
+# Set locations of the borg or restic binaries if you need to.
+# Norg will check some common locations and use the first one it finds, but 
+# if you have them installed in a non-standard location, set that location here
 [binaries]
-# You can set locations for borg and restic binaries if you need to
 borg_bin = "/usr/local/bin/borg"
 restic_bin = "/usr/local/bin/restic"
+
+# Logging configuration - will output to console
+[logging]
+# Log level options are below, each option includes the logs from the one before it
+# "notice", "info", "warn", "error", "fatal", "debug"
+log_level = "info"