תחילת העבודה¶
הדף הזה מוביל אותך מתיבת Unraid חדשה לגיבוי הראשון שלך.
דרישות¶
| דרישה | הערות |
|---|---|
| Unraid 6.12+ | גרסאות מוקדמות יותר לא נבדקו. Unraid הוא היעד העיקרי, אבל BombVault רצה גם על מארח Docker רגיל ועל TrueNAS Scale (ראו מארח Docker כללי ו-TrueNAS SCALE). |
| מיקום מאגר restic | נתיב מקומי (מומלץ: המערך או המטמון שלך), SMB, NFS, או כל backend של rclone. |
| שקע Docker | מעוגן אוטומטית על ידי התבנית (/var/run/docker.sock). |
Flash של Unraid (/boot) |
מעוגן במלואו אוטומטית על ידי התבנית (/boot אל /host/boot). מפעיל את גיבוי ה-flash ומאפשר לקונטיינר ששוחזר להופיע שוב כאפליקציית Unraid רגילה וניתנת לעריכה. |
| מכונות KVM (בהסכמה) | גיבוי מכונות וירטואליות מדבר עם libvirt דרך SSH, בלי עיגון של libvirt. מגדירים אותו תחת הגדרות, אינטגרציות, SSH למארח (ראו הגדרות). |
| מערכי נתונים של ZFS (בהסכמה) | אותו קישור SSH כמו גיבויי VM, zfs במארח, ו-Host Data ממופה כ-/mnt עם מצב גישה Read/Write - Slave, ברירת המחדל בתבנית. ראו מערכי נתונים של ZFS. |
| אפליקציית Android (אופציונלית) | Android 10 ומעלה, מצומדת לשרתים בגרסה 9.7.0 ומעלה. ראו אפליקציית Android. |
התקנה ב-Unraid¶
הדרך הקלה ביותר היא Community Applications.
- פותחים את הלשונית Apps ב-Unraid.
- מחפשים BombVault.
- לוחצים Install, קובעים את המשתנים הנדרשים (להלן) ומחילים.
התקנת תבנית ידנית
אם מעדיפים להוסיף את התבנית ביד:
- עוברים אל Docker, Add Container, Template repositories ומוסיפים:
- מחפשים BombVault בתבניות.
- קובעים את המשתנים הנדרשים ולוחצים Apply.
מארח Docker כללי¶
לא ב-Unraid? BombVault רצה גם כקונטיינר רגיל על כל מארח Docker. ל-TrueNAS SCALE יש צעדים משלו תחת TrueNAS SCALE.
- מורידים את
deploy/docker-compose.generic.ymlהמוכן לעריכה מהמאגר. - קובעים
APP_KEY(ראו להלן) ומכוונים את נפח Host Data לשורש הנתונים האמיתי שלך. ההערות בקובץ עוברות על שניהם. docker compose up -d, ואז פותחיםhttps://<host-ip>:3443/.
מה שונה מ-Unraid:
- אין תחום Flash. אין USB אתחול לתפוס או לשחזר, ולכן לתחום Flash אין מה לעשות כאן. במקום זה, כש-Host Data מגיע ל-
/etcשל המארח, הוספה בדף הגיבויים מציעה תצורת המערכת כהצעת תיקייה: ערכת תיקיות/etcלהתחלה שבודקים וערכים לפני שמירה. - אין התראות מקוריות של Unraid. ערוצי ההתראות של BombVault עצמה (webhook, התראות כשל מחוץ לאתר וכו') עובדים כרגיל. רק הדחיפה הייחודית ל-Unraid למערכת ההתראות המקורית שלו מדולגת, כי אין מערכת כזו לדחוף אליה.
- גיבוי VM בהסכמה וצריך מארח libvirtd נפרד שאפשר להגיע אליו דרך SSH. ראו את הבלוק המוער בקובץ ה-compose. אין מנהל VM מובנה במארח Docker כללי עצמו.
- אין אריח בלוח המחוונים. TollRoll הוא תוסף של Unraid, ולכן גם הצעד הזה מדולג.
- מציאת הנתונים של קונטיינר. בלי מוסכמת
appdataשל Unraid, תיקיית הנתונים של קונטיינר נמצאת מהמקטעים ב-DATA_ROOT_SEGMENTS, מ-volumes בעלי שם של Docker, מתיקיית העבודה של פרויקט Compose ומהתוויתbombvault.data(ראו זיהוי מקורות הגיבוי). volumes בעלי שם והפריסה המוגדרת מראש של/etcמגיעים רק לנתיבים בתוך עיגון Host Data, ולכן מכוונים את Host Data לאב קדמון משותף שמכסה גם את שורש הנתונים של Docker. PLATFORM. קובעים אותו ל-genericאו ל-truenas. אם הוא לא מוגדר, BombVault מזהה את Unraid לפי הסימון שלה בעיגון ה-flash ומתייחסת לכל השאר כגנרי, והצעדים של Unraid בלבד מדולגים במקום להיות מנוסים ולהיכשל.
TrueNAS SCALE¶
BombVault עדיין לא בקטלוג האפליקציות של TrueNAS, ולכן מתקינים אותה כאפליקציה מותאמת: Apps, Discover Apps, ואז Install via YAML בתפריט לצד Custom App. ה-YAML שלהלן קובע את אותם דברים כמו הערך בקטלוג בתיקיית truenas-apps של המאגר. מחליפים את tank במאגר שלך וממלאים את APP_KEY כפי שהסעיף הבא מתאר.
services:
bombvault:
image: junkerderprovinz/bombvault:latest
hostname: bombvault
restart: unless-stopped
cap_drop: [ALL]
cap_add: [CHOWN, DAC_OVERRIDE, FOWNER, SETGID, SETPCAP, SETUID, SYS_CHROOT]
environment:
APP_KEY: ""
PLATFORM: truenas
HOST_SOURCE_ROOT: /mnt/tank
HOST_MOUNT_ROOT: /mnt/tank
# For VM backups:
# LIBVIRT_URI: qemu+ssh://root@<truenas-ip>/system?socket=/run/truenas_libvirt/libvirt-sock
volumes:
- /mnt/tank/apps/bombvault:/config
- /var/run/docker.sock:/var/run/docker.sock
- type: bind
source: /mnt/tank
target: /mnt/tank
bind:
propagation: rslave
ports:
- "30528:3443"
ואז פותחים https://<truenas-ip>:30528/. מה שמפורט תחת מה שונה מ-Unraid חל גם כאן, וב-TrueNAS:
- יכולות. BombVault צריכה את שבע שלמעלה. גיבויי VM נכשלים בלי
SETPCAP, ובליSYS_CHROOTכל קונטיינר נעצר לאורך כל הגיבוי שלו במקום להיקרא מתצלום. - Host Data הוא נתיב מארח על מערך נתונים, כאן
/mnt/tank, מעוגן באותו נתיב בתוך האפליקציה. לכןHOST_SOURCE_ROOTו-HOST_MOUNT_ROOTשניהם מציינים אותו.rslaveמעביר הלאה את העיגונים שהמארח עושה מאוחר יותר, מה שגיבויי מערכי נתונים של ZFS צריכים. - נתונים ב-ixVolume אינם מגובים. אפליקציה שהאחסון שלה הוא ixVolume שומרת את הנתונים שלה תחת
/mnt/.ix-apps, מחוץ ל-Host Data. BombVault שומרת רק את ההגדרה של האפליקציה, והריצה מציינת את התיקיות שהשאירה בחוץ. לכל אפליקציה שרוצים לגבות את הנתונים שלה בוחרים אחסון Host Path על מערך נתונים מתחת ל-Host Data. - גיבויי VM ומערכי נתונים של ZFS מגיעים ל-TrueNAS דרך SSH כ-root. מפעילים את שירות ה-SSH תחת System, Services, ומוסיפים את המפתח הציבורי מהגדרות, אינטגרציות, SSH למארח למשתמש root תחת Credentials, Users. גיבויי VM צריכים גם את
LIBVIRT_URIכמו למעלה, כי libvirtd של TrueNAS מאזין על שקע משלו. כש-LIBVIRT_URIו-LIBVIRT_HOSTשניהם לא מוגדרים, BombVault משתמשת בשער ברירת המחדל של האפליקציה כמארח, כיhost.docker.internalלא נפתר באפליקציית TrueNAS. מדריך גיבוי VM מכסה את הפרטים, כולל מכונות על zvols. - רפליקת ZFS משתמשת במפתח אחר. רפליקה בשרת ZFS שני נכנסת עם המפתח שחלון הרפליקה מציג, לא עם מפתח ה-Host SSH. מוסיפים אותו בשרת המקבל.
- אפליקציה שנמחקה חוזרת בשני שלבים. מתקינים אותה מחדש ב-TrueNAS באותו שם קודם, מה שיוצר את הרשת שלה שוב, ואז משחזרים את הנתונים שלה ב-BombVault. עד אז בדיקת השחזור מדווחת על הרשת החסרה, והשחזור מסרב לפני שהוא משנה משהו.
- לצד המקור יוצר קונטיינר Docker רגיל. הוא רץ, אבל מסך האפליקציות של TrueNAS לא מציג אותו.
- גיבויי SQL של מסד הנתונים עובדים על עיגוני מערכי נתונים. ייבוא לתיקיית נתונים שהיא מערך נתונים בפני עצמו מעביר את התוכן הישן לתיקייה לצדה, ולכן למערך הנתונים שמעליה צריך מקום בשבילו.
ZimaOS, CasaOS ומארחים אחרים¶
- ZimaOS ו-CasaOS: מוסיפים את החנות הקהילתית ומתקינים ממנה את BombVault. היא רצה שם כ-
PLATFORM=genericעם Host Data על/DATA. ZimaOS שומר נתוני אפליקציות ב-/DATA/AppData/<app>, ש-BombVault מוצאת בעצמה, כיDATA_ROOT_SEGMENTSמתאים ל-appdataבכל רישיות. - MOS: מתקינים את BombVault מ-MOS Hub. היא רצה שם כ-
PLATFORM=genericעם Host Data על/mnt/cache. - Synology: ב-Container Manager יוצרים פרויקט מקובץ ה-compose (DSM 7.2 ומעלה).
- Proxmox: מריצים אותה במכונה וירטואלית או בקונטיינר LXC שיש בו Docker.
בלי הערות, קובץ ה-compose הכללי קצר. מחליפים את ./data בתיקיית המארח שמחזיקה את הנתונים של הקונטיינרים שלך, קובעים את HOST_SOURCE_ROOT לאותו נתיב וממלאים את APP_KEY:
services:
bombvault:
image: junkerderprovinz/bombvault:latest
restart: unless-stopped
hostname: bombvault
container_name: bombvault
volumes:
- ./config:/config
- /var/run/docker.sock:/var/run/docker.sock
- ./data:/host/user
environment:
APP_KEY: ""
PLATFORM: generic
HOST_SOURCE_ROOT: /host/user
ports:
- "3443:3443"
כדי לגבות גם volumes בעלי שם של Docker, מעגנים תיקייה שמחזיקה גם את הנתונים שלך וגם את שורש הנתונים של Docker (docker info -f '{{.DockerRootDir}}', בדרך כלל /var/lib/docker), כמו שהתבנית של Unraid מעגנת את כל /mnt.
ההגדרה היחידה הנדרשת¶
המשתנה היחיד שחייבים לקבוע הוא APP_KEY, סוד הקסדצימלי של 32 בייטים (64 תווים הקסדצימליים) שמשמש לגזירת סיסמת מאגר ה-restic.
יוצרים אחד בכל מחשב:
מדביקים את התוצאה בשדה APP_KEY של התבנית (Unraid), או במשתנה הסביבה APP_KEY ב-docker-compose.yml (מארח Docker כללי).
אל תאבדו את ה-APP_KEY
איבוד APP_KEY הופך גיבויים מוצפנים לבלתי ניתנים לשחזור. שומרים אותו במקום בטוח ונפרד מהשרת. ברגע ש-BombVault רצה, קובעים סיסמת התחברות ומורידים את ערכת השחזור תחת הגדרות, שחזור (ראו מחוץ לאתר והתאוששות). היא מחזיקה את המפתח, כל יעד ואת פקודות restic.
התבנית גם מעגנת בשבילך את שקע Docker, את ה-flash (/boot) ואת שורש Host Data (/mnt). מקורות ויעדים של גיבוי נמצאים שניהם תחת Host Data. למדריך המלא של המשתנים ולהגדרת מחוץ לאתר, ראו הגדרות.
הפעלה ראשונה¶

- פותחים את ממשק הרשת בכתובת
https://<your-unraid-ip>:3443(תעודה חתומה בעצמה מהקופסה). התקנה חדשה נפתחת בברוכים הבאים ל-BombVault, שמפרט מה ש-BombVault מצאה בשרת. - בוחרים בואו נתחיל. הסקירה מציגה אז את הכרטיס צעדים ראשונים עם שלושה צעדים:
- בחירת תחומים: מפעילים מה ש-BombVault מגבה (קונטיינרים, VMs, Flash, תיקיות, מערכי נתונים של ZFS, גיבוי עצמי). בחירה פותחת את הרשימה של הפריטים בתחום, שבה השהיית התזמון משאירה אחד בחוץ. התחומים שמפעילים כאן רצים כל לילה, ושמשנים תחת הגדרות, לוח זמנים.
- הוספת יעד: מקום שני לגיבויים. לכל תחום כבר יש תיקייה בשרת הזה,
/mnt/user/bombvault/{container,vms,flash,config,files,zfs}, שנוצרת בגיבוי הראשון. הבטוח ביותר הוא יעד שני מחוץ למקום, כמו Storage Box או Backblaze B2. - גיבוי ראשון: אחרי זה הוא רץ מעצמו כל לילה. הכרטיס נשאר עד שהגיבוי הראשון הסתיים.
- פותחים גיבויים כדי לראות כל פריט ברשימה אחת. גיבוי הכול עכשיו מתחיל ריצה על כל התחומים המופעלים, וגיבוי עכשיו בדף של פריט מגבה רק אותו.

כבר השתמשת ב-BombVault? שחזור מגיבוי בדף הברוכים הבאים פותח את דף השחזור, שבו אשף החירום מחזיר את ההגדרות, הקונטיינרים, המכונות והתיקיות של שרת שאבד. ראו מחוץ לאתר והתאוששות.
אופציונלי: בחירת סדר גיבוי
אם חלק מהקונטיינרים צריכים תמיד להיות מגובים לפני אחרים (למשל מסד נתונים לפני האפליקציה שמשתמשת בו), פותחים את הכרטיס סדר תחת הגדרות, לוח זמנים וגוררים אותם לרצף הרצוי. ריצות מתוזמנות והגיבוי המלא עוקבים אחריו אז. כל מה שלא סודר מגובה לפי מי שהכי מאחר.
דוגמה: גיבוי הקונטיינר הראשון שלך, מקצה לקצה¶
זה עובר על תיבת Unraid חדשה עם כמה קונטיינרים, ביניהם plex, עד שהגיבוי הראשון הסתיים ואתה יודע איפה למצוא אותו. זה לוקח כעשר דקות ועוד זמן הגיבוי הראשון.
- התקנה. בלשונית Apps של Unraid מחפשים BombVault ולוחצים Install.
- קביעת המפתח. במחשב מריצים
openssl rand -hex 32ומדביקים את 64 התווים בשדהAPP_KEYשל התבנית. שומרים עותק במנהל הסיסמאות שלך עכשיו, לפני כל דבר אחר. לוחצים Apply. - פתיחה. עוברים אל
https://<your-unraid-ip>:3443ומקבלים את התעודה החתומה בעצמה. ברוכים הבאים ל-BombVault מפרט מה שהיא מצאה, כמו 12 קונטיינרים, 2 מכונות וירטואליות וכונן ה-flash. - בואו נתחיל. הסקירה נפתחת עם הכרטיס צעדים ראשונים.
- בחירת תחומים. קונטיינרים מופעל מההתחלה. מפעילים מה עוד שרוצים, כמו Flash. בחירה פותחת את רשימת הקונטיינרים שנמצאו, והשהיית התזמון משאירה אחד בחוץ, למשל קונטיינר בדיקה שלא אכפת לך ממנו. תחומים מופעלים רצים כל לילה בגיבוי המלא.
- הוספת יעד. לכל תחום כבר יש תיקייה משלו בשרת הזה, מתחת ל-
/mnt/user/bombvault, ולכן לגיבוי הראשון יש לאן ללכת. הצעד הזה מוסיף מקום שני, והבטוח ביותר הוא מחוץ למקום. אפשר לעשות אותו עכשיו עם דוגמת ה-S3, או לחזור אליו אחרי שהגיבוי הראשון הסתיים. הכרטיס נשאר עד אז. - גיבוי ראשון. פותחים גיבויים ולוחצים גיבוי הכול עכשיו, או מחכים ללילה. הטבעת בראש הסטטוס הופכת לטבעת התקדמות וסופרת את הפריטים, כמו גיבוי מתבצע עכשיו: 3 מתוך 12. כל קונטיינר נעצר בזמן שהנתונים שלו נקראים ומופעל שוב מיד אחר כך. קונטיינר שהנתונים שלו על ZFS למטה רק כמה שניות של תצלום. הגיבוי הראשון קורא הכול, ולכן הוא לוקח הכי הרבה זמן. הבאים שומרים רק מה ששונה.
- בדיקה. כשהטבעת אומרת הכול גובה, פותחים היסטוריה בסקירה: לכל קונטיינר יש שורה ירוקה בריצות. פותחים גיבויים, לוחצים על
plexומסתכלים בלשונית גיבויים שלו: התצלום הראשון שם, עם מקומי כמקום שמחזיק אותו. כמה דקות אחר כך לשונית אימות שלו מציגה את בדיקת השחזור, ששחזרה מדגם מהגיבוי וקראה אותו בחזרה. - הגנה על המפתח. פותחים הגדרות, אבטחה וקובעים סיסמת התחברות. ואז פותחים הגדרות, שחזור ולוחצים הורדת ערכת שחזור בלשעת חירום. שומרים את הקובץ מחוץ לשרת, לצד עותק ה-
APP_KEYמשלב 2. התזכורת שמירת ערכת השחזור בסקירה נעלמת ברגע שלוחצים שמרתי אותה בבטחה.
מעכשיו הקונטיינרים מגובים כל לילה. צעדים טובים הבאים, בסדר הזה: יעד מחוץ לאתר, כדי ששרת מת לא ייקח איתו את הגיבויים, אחר כך התראות, כדי שכשל יגיע אליך, ואז מבט בלוחות זמנים אם 03:00 לא מתאים לך.

בדיקת שילוב מארח
הכרטיס שילוב מארח בסקירה בודק כל עיגון וכל CLI (שקע Docker, libvirt, restic, qemu-img, rclone) ומדווח על חלקים חסרים, כך שאפשר לוודא שהקונטיינר מחובר נכון לפני שסומכים עליו. הוא מחכה תחת התאמה אישית עד שמוסיפים אותו.
גיבוי VPS כצומת¶
VPS או שרת קטן אחר לא צריך BombVault עם ממשק רשת משלו. מוסיפים אותו כצומת של המופע הזה, והמופע הזה מריץ את הגיבויים שלו:
- קובעים סיסמת התחברות תחת הגדרות, אבטחה, אם עוד לא קבעת.
- פותחים את מופעים, בוחרים הוספת צומת ומקלידים שם כמו
vps-helsinki. - בוחרים לאן הגיבויים שלו נשלחים, למשל שרת המקלט של המופע הזה, ומתי הוא מגבה.
- מעתיקים לשרת את קובץ ה-compose שהחלון מציג, מכוונים את הכרך Host Data ואת
HOST_SOURCE_ROOTלנתונים לגיבוי, ומריציםdocker compose up -d.
כשהצומת עונה, הכרטיס שלו אומר מחובר והקונטיינרים שלו מופיעים תחת גיבויים. צמתים עובר על זה עם דוגמה.
למצוא את הדרך¶

בסרגל הצד יש חמישה ערכים: סקירה, חריגות (כל עוד זיהוי החריגות פועל), גיבויים, שחזור ו, מתחת להתנתק, הגדרות. הפעולה הראשית של דף צפה בפינה הימנית התחתונה, ועוד מחזיק את הנדירות. בטלפון הסרגל מחזיק סקירה, גיבויים, שחזור והגדרות, ועוד מחזיק את השאר.
דפים והגדרות משתמשים בכל רוחב החלון. חלון שומר את הכפתורים שלו בתחתית, כשזה שמתקדם נמצא בצד ימין. בטלפון, תחתית עם יותר משלושה כפתורים שומרת את דרך היציאה ואת הפעולה הראשית ושמה את האחרים תחת עוד.

- סקירה מראה אם הכול מגובה ומה דורש אותך. ראו סקירה.
- גיבויים מפרט כל קונטיינר, מכונה וירטואלית, ערכת תיקיות, את כונן ה-flash, כל מערך נתונים של ZFS ואת הגיבוי העצמי כפריטים. אריחים מעל הרשימה בוחרים סוג, ומסננים, מיון וחיפוש מצמצמים אותה. לכל פריט יש דף משלו עם שלוש לשוניות: גיבויים, הגדרות ואימות. כפתור חזרה משמאל לסמל הפריט מוביל לרשימה. ראו גיבויים ופריטים.
- שחזור הוא דף אחד לכל דבר: בוחרים תחום, מחפשים פריט ובוחרים גיבוי. גם אשף החירום והמקורות האחרים מתחילים כאן. ראו שחזור.
- הגדרות הן ארבעה עשר אריחים: כללי, מראה, לוח זמנים, יעדים, שחזור, התראות, אימות, אבטחה, מופעים, צימוד, אינטגרציות, אפליקציות, מערכת ומידע. ראו הגדרות. מקישים
/או Ctrl+K כדי לחפש בכולן, גם לפי השמות שהיו לדפים בגרסאות קודמות. גוררים את האריחים לסדר שלך תחת מראה. במקום שעמודת אריחים לצד הדף הייתה מכווצת אותו, כמו בחלון ברוחב של כ-1200 פיקסלים, האריחים הופכים לרצועה מעל הדף שנגללת הצידה. טלפון מציג את אותה רצועה. - יעדים ומופעים הם אריחי הגדרות עם דפים משלהם. הצגה גם בסרגל הצד באריח שלהם מצמידה אותם לסרגל הצד.
לשום דבר אין כפתור שמירה ושום דבר לא נפתח בקיפול: לדברים נדירים יש כרטיס משלהם או חלון, והסברים נמצאים בבועות ה-(i). אחרי עדכון נפתח חלון מעצמו עם כרטיס לכל גרסה מאז הגרסה האחרונה שלך, ונקודות ירוקות מסמנות מה השתנה. לחיצה מסתירה נקודה. חדש בכרטיס הגרסה תחת הגדרות, מידע סופר מה עוד לא ראית ופותח את החלון הזה שוב, עם הערות כל גרסה והשינויים שלה עם מעבר לשם.
בנייה ממקור¶
BombVault היא קובץ הרצה סטטי יחיד ב-Go שמגיש API של JSON וממשק React מוטמע. בונים קודם את הממשק, ואז מריצים את הקובץ:
npm --prefix web ci
npm --prefix web run build # writes web/dist, which the binary embeds
export APP_KEY=$(openssl rand -hex 32)
go test ./... # unit and integration tests, with a real restic round trip
golangci-lint run ./...
go run ./cmd/bombvault # serves https://localhost:3443 with a self-signed certificate
בניית הממשק נחוצה גם ל-go run. המאגר עוקב רק אחרי סימון ריק תחת web/dist, ולכן בלי npm --prefix web run build הקובץ לא מטמיע כלום ועונה 500 SPA index not found, מה שמצופה. אי אפשר לבדוק Docker, libvirt ו-Unraid ב-CI, ולכן בודקים עיגונים, restic וקישור ה-SSH למכונות על מארח אמיתי עם הכרטיס שילוב מארח בסקירה (או GET /api/spike) לפני שפותחים pull request.
צעדים הבאים¶
- מוסיפים יעד אחד או יותר מחוץ למקום (כל תחום יכול להעתיק לכמה בבת אחת) ושומרים את ערכת השחזור שלך, כמתואר תחת מחוץ לאתר והתאוששות. דוגמת ה-S3 עוברת על אחד.
- דואגים שכשל יגיע אליך עם התראות.
- בודקים מתי דברים רצים תחת לוחות זמנים.
- מביאים לטלפון את כל שרתי הקבוצה שלך עם אפליקציית Android.
- מגבים VPS מכאן עם צומת.
- הדוגמאות המעשיות עוברות על המשימות הנפוצות, ותכונות מפרט את כל מה ש-BombVault עושה.
- משכפלים הגדרה או עוברים לתיבה חדשה? מעבירים את כל התצורה שלך עם הכרטיס ייצוא / ייבוא הגדרות. ראו הגדרות.
- נתקלת בבעיה? ראו פתרון בעיות.