English
→ חזרה לדף הראשי

להריץ את Markport בעצמך

אין מופע ציבורי, במכוון. הדף הזה הוא איך מריצים אחד משלך. גרסה אנגלית של הדף הזה נמצאת ב-docs/install.md.

יש שתי דרכים להריץ, ושתיהן חולקות את אותה ליבת-דפדפן. בחר את מה שמתאים:


לפני שתיהן

צריך Node 18 ומעלה, ועותק של המנוע של Obsidian.

git clone https://github.com/MusiCode1/markport
cd markport
node scripts/update-obsidian-mobile.js --version 1.12.7

הסקריפט הזה מוריד את ה-APK הרשמי של Obsidian לאנדרואיד ופורק את עץ assets/public/ שלו אל vendor/obsidian-mobile/. שום דבר לא משתנה: הבאנדל המחולץ זהה בייט-בייט לזה של Obsidian. הריפוזיטורי הזה אינו מכיל ואינו מפיץ אותו - ההורדה היא מ-Obsidian אל המחשב שלך.

חובה להעביר --version 1.12.7 במפורש. בלעדיו הסקריפט לוקח את הגרסה האחרונה, שהיא 1.13 ומעלה ולא תעלה. ראה “מה לא עובד” בדף הראשי.


אפשרות 1: שרת Node

cd src/runtime-server/server
npm install
npm start

פתח את http://127.0.0.1:3000.

npm run dev במקום npm start טוען מחדש בכל שינוי קובץ.

משתני סביבה

משתנה ברירת מחדל
PORT 3000
HOST 127.0.0.1 0.0.0.0 כדי לקבל חיבורים ממכונות אחרות
VAULT_PATH user-data/demo-vault תיקיית הכספת שתוגש

השרת מדבר HTTP רגיל ואין בו שום אימות. זה מכוון: TLS ואימות הם באחריות המפעיל, ו-reverse proxy לפניו (‏Caddy הוא בחירה טובה) עושה את שניהם בכמה שורות. אל תחשוף אותו ישירות.


אפשרות 2: הבנייה הסטטית

cd src/deployments/cloudflare
npm install
npm run build

התוצאה נוחתת ב-.tmp/deployments/cloudflare/public/ - תיקיית קבצים רגילה. הגש אותה מכל מקום: ‏Cloudflare Pages, ‏Vercel, ‏Netlify, ‏nginx, או שרת סטטי מקומי.

הבנייה מייצרת גם Worker קטן (_worker.js) שעושה שני דברים: מגיש את מעטפת האפליקציה ל-/starter ול-/vault/<id>, ומתווך הורדות של תוספים. על מארח בלי פונקציות serverless האפליקציה עדיין עולה, אבל התקנת תוספי קהילה מתוכה לא תעבוד, כי דפדפן לא יכול לפנות ל-github.com ישירות.


מה שצריך לדעת בשתי הדרכים

‏HTTPS אינו אופציונלי. אחסון הדפדפן (OPFS) אינו זמין בהקשר לא-מאובטח, ולכן על מארח http:// רגיל שאינו localhost, יצירת כספת נכשלת בשקט. ‏localhost בסדר לניסיון.

‏Chromium נותן את החוויה המלאה. כספות-תיקייה - פתיחת תיקייה אמיתית מהדיסק - ורענון אוטומטי בשינוי חיצוני קיימים ב-Chromium בלבד. ‏Firefox ו-Safari מקבלים כספות מקומיות בדפדפן; ב-Safari הכתיבה ל-OPFS הגיעה הרבה אחרי הקריאה, אז כדאי לבדוק את הגרסה.

‏Markport אינו מיוצר על-ידי Obsidian, אינו מסונף אליה ואינו מאושר על ידה. מה שאתה מריץ הוא מופע משלך, על המחשב שלך, מבאנדל שהורדת בעצמך.


כל השאר - הארכיטקטורה, שכבת השימים, הרציונל - נמצא בהערות הארכיטקטורה ובריפוזיטורי.