From dad734f7822df30d45483458f2974a3bbbd9a274 Mon Sep 17 00:00:00 2001
From: Emy <109487755+querylab@users.noreply.github.com>
Date: Sat, 2 Nov 2024 20:20:15 -0400
Subject: [PATCH] Update README.md
---
README.md | 154 +++++++++++++++++++++++++++++-------------------------
1 file changed, 82 insertions(+), 72 deletions(-)
diff --git a/README.md b/README.md
index de123c3..d28d787 100755
--- a/README.md
+++ b/README.md
@@ -13,9 +13,9 @@ Lazywarden is a Python automation tool designed to Backup and Restore data from
- 🔒 **Maximum Security:** Data protection with AES-256 encryption and Argon2 key derivation.
- 🔄 **Automated Backups and Imports:** Keep your Bitwarden vault up to date and secure.
- ✅ **Integrity Verification:** SHA-256 hash to ensure data integrity on every backup.
-- ☁️ **Multi-Cloud Support:** Store backups to services such as Dropbox, Google Drive, pCloud, MEGA, NextCloud, Seafile, Storj, Cloudflare R2, Filebase (IPFS) and via SMTP.
+- ☁️ **Multi-Cloud Support:** Store backups to services such as Dropbox, Google Drive, pCloud, MEGA, NextCloud, Seafile, Storj, Cloudflare R2, Backblaze B2, Filebase (IPFS) and via SMTP.
- 🖥️ **Local Storage:** Save backups to a local path for greater control.
-- 🔔 **Real-Time Alerts:** Instant notifications on Discord, Telegram and Slack.
+- 🔔 **Real-Time Alerts:** Instant notifications on Discord, Telegram, Ntfy and Slack.
- 🗓️ **Schedule Management:** Integration with CalDAV, Todoist and Vikunja to manage your schedule.
- 🐳 **Easy Deployment:** Quick setup with Docker Compose.
- 🤖 **Full Automation and Custom Scheduling:** Automatic backups with flexible scheduling options (daily, weekly, monthly, yearly). Integration with CalDAV, Todoist and Vikunja for complete tracking and email notifications.
@@ -29,6 +29,7 @@ Lazywarden is a Python automation tool designed to Backup and Restore data from
+ 
@@ -43,6 +44,7 @@ Lazywarden is a Python automation tool designed to Backup and Restore data from
+ 
## 
Demo Backup
@@ -71,98 +73,106 @@ Lazywarden is a Python automation tool designed to Backup and Restore data from
- Create a `.env` file based on the on this `.env.sample` example file and fill in the necessary variables.
``` BASH
-# Bitwarden Secrets
-BW_URL=80607bef-1153-4eb6-1111-b1a0013ebdd1
-BW_USERNAME=c6a5fc4d-6d36-1111-820a-a1dae99e2f43
-BW_PASSWORD=0de9c3be-253d-1111-be10-de0607329ffa
-BW_TOTP_SECRET=01726d37-0df7-1111-a78d-96fdc8efd59b
-ENCRYPTION_PASSWORD=588b0643-1111-4a78-ba3e-9467ad9c81a7
-ZIP_PASSWORD=3bcadf27-446d-47f0-1111-b1469fa58546
-ZIP_ATTACHMENT_PASSWORD=89d458e7-9ac4-1111-9f23-95cb4b8cff86
-
-# pCloud Credentials
-PCLOUD_USERNAME=8d5f981b-705a-1111-a25d-a2abe925f4e4
-PCLOUD_PASSWORD=23351280-0184-1111-99b0-2b6a1bc921ae
-
-# Mega Credentials
-MEGA_EMAIL=1dafc95a-63c2-4b66-1111-bd7cd5a2ea5e
-MEGA_PASSWORD=51bec27b-7c79-1111-9cef-1be72675a47f
-
-# Dropbox Credentials
-DROPBOX_ACCESS_TOKEN=647ff022-1111-47d9-a54f-fef635b23eff
-DROPBOX_REFRESH_TOKEN=873e5430-1111-4d62-8bf2-acce1e915a9d
-DROPBOX_APP_KEY=81f259ae-d6e4-47b1-1111-6bec568ddc85
-DROPBOX_APP_SECRET=0b407a02-ded5-1111-b953-caf8fc79af99
-
-# Todoist Credentials
-TODOIST_TOKEN=667321ac-2229-42a1-1111-3c568c9d73e6
-
-# CalDAV Credentials
-CALDAV_URL=049c9267-bdb0-4266-1111-b19a00e9b626
-CALDAV_USERNAME=6eff84c9-fbeb-1111-ad30-b19a00e9cc09
-CALDAV_PASSWORD=492c37fd-46df-1111-abe7-b19a00e9e601
-
-# Nextcloud Credentials
-NEXTCLOUD_URL=e375df76-d3b2-1111-83ba-b19a0158fe08
-# Example http://192.175.88.112:8400
-NEXTCLOUD_USERNAME=a267c8cd-9d13-1111-8729-b19a0159276a
-NEXTCLOUD_PASSWORD=7036175d-046b-1111-9797-b19a01594308
-
-# Seafile Credentials
-SEAFILE_SERVER_URL=20060dfc-4fa0-1111-8b41-b19b000857e7
-# Example http://192.175.88.212:8200
-SEAFILE_USERNAME=9959dabb-ae4c-1111-9fc1-b19b00087d64
-SEAFILE_PASSWORD=94e5f170-aedb-1111-b1b9-b19b00088ccd
-
-# Filebase Credentials
-FILEBASE_ACCESS_KEY=53ec784f-4b18-1111-9a47-b1a00136efc5
-FILEBASE_SECRET_KEY=f99d8d83-57b9-1111-9ace-b1a001370117
-
-# KeePass Password
-KEEPASS_PASSWORD=95512b36-32e9-1111-9c15-b1ae0171b2f9
-
-# Storj Credentials
-STORJ_ACCESS_KEY=a7d85af3-ad63-1111-b039-b208012c381a
-STORJ_SECRET_KEY=1303faf7-b34e-1111-ac43-b208012c4f05
-STORJ_ENDPOINT=fb787806-a3f4-1111-8523-b208012c6543
-
-# R2 Credentials
-R2_ACCESS_KEY_ID=ffb0d6ed-1111-46ad-8fdf-b2080132c9dd
-R2_SECRET_ACCESS_KEY=083b5344-1111-4dd8-909e-b2080132dc52
-R2_ENDPOINT_URL=31510979-b5b1-1111-8957-b2080132f436
-
-# Vikunja Credentials
-VIKUNJA_API_TOKEN=7e67437c-1489-1111-8fbb-b20801880db2
-VIKUNJA_URL=d3b7a73f-ebb9-1111-8dc2-b208018843a6
-#Example for Bitwarden Secret Manager http://192.175.88.227:3456/api/v1
+#---------------------------------------------------------------------------------------
+# These are the 6 variables that are mandatory requirements for Bitwarden Secret Manager
+BW_URL=f22bba66-e55d-1111-9a93-abf0dfad069e
+BW_USERNAME=5eb0f2bb-1111-4e42-94f8-9333fda803cf
+BW_PASSWORD=ba4dc990-1111-4d18-ae6b-0b899d513759
+ENCRYPTION_PASSWORD=103c803c-1111-40d4-8578-8b3134c6e93e
+ZIP_PASSWORD=2f9fb3a2-96a3-1111-990d-5d6399153e11
+ZIP_ATTACHMENT_PASSWORD=b2abc553-1111-4b49-9172-1a94f9072715
+
+#---------------------------------------------------------------------------------------
+
+# TOTP Seed for Aegis,Authy,Ente,GoogleAuth (Optional)
+BW_TOTP_SECRET=
+
+# pCloud Credentials (Optional)
+PCLOUD_USERNAME=
+PCLOUD_PASSWORD=
+
+# Mega Credentials (Optional)
+MEGA_EMAIL=
+MEGA_PASSWORD=
+
+# Dropbox Credentials (Optional)
+DROPBOX_ACCESS_TOKEN=
+DROPBOX_REFRESH_TOKEN=
+DROPBOX_APP_KEY=
+DROPBOX_APP_SECRET=
+
+# Todoist Credentials (Optional)
+TODOIST_TOKEN=
+
+# CalDAV Credentials (Optional)
+CALDAV_URL=
+CALDAV_USERNAME=
+CALDAV_PASSWORD=
+
+# Nextcloud Credentials (Optional)
+NEXTCLOUD_URL=
+NEXTCLOUD_USERNAME=
+NEXTCLOUD_PASSWORD=
+
+# Seafile Credentials (Optional)
+SEAFILE_SERVER_URL=
+SEAFILE_USERNAME=
+SEAFILE_PASSWORD=
+
+# Filebase Credentials (Optional)
+FILEBASE_ACCESS_KEY=
+FILEBASE_SECRET_KEY=
+
+# KeePass Password (Optional)
+KEEPASS_PASSWORD=
+
+# Storj Credentials (Optional)
+STORJ_ACCESS_KEY=
+STORJ_SECRET_KEY=
+STORJ_ENDPOINT=
+
+# R2 Credentials (Optional)
+R2_ACCESS_KEY_ID=
+R2_SECRET_ACCESS_KEY=
+R2_ENDPOINT_URL=
+
+# Vikunja Credentials (Optional)
+VIKUNJA_API_TOKEN=
+VIKUNJA_URL=
+
+# Backblaze B2 Credentials (Optional)
+B2_APP_KEY_ID=
+B2_APP_KEY=
# Google Drive Settings
GOOGLE_SERVICE_ACCOUNT_FILE=/root/lazywarden/config/bitwarden-drive-backup-google.json
-GOOGLE_FOLDER_ID=1oWWis81111Tz5qRA3W4YTtO0LjvXFvoA
+GOOGLE_FOLDER_ID=
# Backup Settings
BACKUP_DIR=/root/lazywarden/backup-drive/
CRON_SCHEDULE="0 0 23 * *"
TIMEZONE=America/New_York
-TIMESTAMP=2024_10_18_22_47_46
+TIMESTAMP=2024_10_31_13_03_29
+
# API URLs for Bitwarden
API_URL=https://vault.bitwarden.com/api
IDENTITY_URL=https://vault.bitwarden.com/identity
# Organization ID
-ORGANIZATION_ID=232c1890-1111-40b4-b769-b195012f78af
+ORGANIZATION_ID=
# Access Token for Bitwarden Authentication
-ACCESS_TOKEN=0.34827757-1111-1111-1111-b20a01647f46.WDp3AUjnle1LqlXvs0Ox9xEWzgY8Hp:CKue3vgWTvIQzEmDlBlqGw==
+ACCESS_TOKEN=
-# Notifications and Alerts
+# Notifications and Alerts (Optional)
TELEGRAM_TOKEN=
TELEGRAM_CHAT_ID=
DISCORD_WEBHOOK_URL=
SLACK_WEBHOOK_URL=
+NTFY_URL=
-# SMTP Configuration for Email Notifications
+# SMTP Configuration for Email Notifications (Optional)
SMTP_SERVER=mail.smtp2go.com
SMTP_PORT=8025
SMTP_USERNAME=