webtrees——在線協作家譜

內容

執照
編碼風格和標準
介紹
系統要求
互聯網瀏覽器兼容性
安裝
升級
建設與發展
Gedcom（家譜）文件
安全
備份
從備份還原

執照

webtrees：在線家譜
版權所有 2022 webtrees 開發團隊

該程序是免費軟件：您可以根據自由軟件基金會發布的 GNU 通用公共許可證的條款重新分發和/或修改它，無論是許可證的第 3 版，還是（根據您的選擇）任何更高版本。

本程序發布時，希望其能夠發揮作用，但不提供任何擔保；甚至不提供任何關于適銷性或特定用途適用性的默示擔保。更多詳情，請參閱 GNU 通用公共許可證。

您應該已隨本程序收到一份 GNU 通用公共許可證的副本。如果沒有，請參閱https://www.gnu.org/licenses/。

編碼風格和標準

webtrees 遵循PHP 標準建議。

PSR-1?- 基本編碼標準
PSR-2?- 編碼風格指南
PSR-4?- 自動加載標準
PSR-6?- 緩存
PSR-7?- HTTP 消息接口
PSR-11?- 容器接口
PSR-12?- 擴展編碼風格指南
PSR-15?- HTTP 處理程序
PSR-17?- HTTP 工廠

我們目前不使用PSR-3（日志記錄）?- 但我們計劃將來使用。

對于 JavaScript，我們使用半標準。

介紹

webtrees是網絡領先的在線協作家譜應用程序。

它基于標準 GEDCOM 文件運行，因此與每個主流桌面應用程序兼容。
它旨在通過正確組合使用第三方工具、設計技術和開放標準來實現高效和有效。

Webtrees允許您在您的網站上查看和編輯您的家譜。它擁有完整的編輯功能和隱私保護功能，并支持照片和文檔圖像等多媒體內容。作為一款在線程序，它簡化了與其他從事您家譜工作的人員的協作流程，從而促進大家庭的參與和良好的祖先記錄習慣。您的最新信息始終顯示在您的網站上，并可供其他人查看，具體方式由您設置的查看規則決定。如需了解更多信息和觀看演示，請訪問?webtrees.net。

webtrees是一款開源軟件，由來自世界各地的開發者免費貢獻時間和才華。所有服務、支持和未來開發都依賴于開發者為項目貢獻的時間，這些時間通常以犧牲工作、娛樂和家庭為代價。除了用戶提供的少量捐款外，開發者不會因其在項目上投入的時間而獲得任何報酬。該項目也沒有外部收入來源來支持。請在提交支持請求時考慮這些情況，并考慮自愿貢獻您自己的時間和技能，使項目更加強大和完善。

系統要求

要安裝webtrees，您需要：

Web 服務器。Apache、NGINX 和 IIS 是最常見的類型。要使用“Pretty URL”，您需要配置 URL 重寫功能。
數據庫。建議使用 MySQL，但 PostgreSQL、SQL-Server 和SQLite也可以使用。某些功能依賴 MySQL 進行排序。其他數據庫可能不會根據本地規則對名稱進行排序。webtrees?使用前綴作為其表名，因此您可以在同一個數據庫中安裝多個 webtrees 實例。
應用程序文件需要大約 100MB 的磁盤空間，另外還有媒體文件、GEDCOM 文件和數據庫所需的空間。
PHP 7.1 - 7.4。使用 PHP 5.3 - 7.0 的服務器可以使用webtrees?1.7。
- PHP 的配置應考慮到系統規模，允許足夠的服務器資源（內存和執行時間）。典型的要求如下：
  - 小型系統（500 個用戶）：16–32 MB，10–20 秒
  - 中型系統（5,000 個用戶）：32–64 MB，20–40 秒
  - 大型系統（50,000 個個體）：64–128 MB，40–80 秒

瀏覽器兼容性

webtrees已在 Edge、Firefox、Chrome 和 Safari 等熱門瀏覽器的最新版本上進行了測試。對其他瀏覽器和舊版本的支持將視具體情況而定。

安裝

從github.com下載最新穩定版本的 .ZIP 文件。
解壓縮文件，然后將其上傳到 Web 服務器上的空文件夾。
打開您的 Web 瀏覽器并輸入您的Webtrees站點的 URL?（例如，?https://www.yourserver.com/webtrees在地址欄中）。
webtrees安裝向導將自動啟動。

您的首要任務是創建家譜。

如果您有 GEDCOM 文件，可以將其導入家譜。如果沒有，請直接開始輸入您的家譜。

配置選項很多。您可能需要先查看隱私設置。其他選項無需過多擔心——默認設置對大多數人來說已經足夠了。如果您遇到問題，可以從幫助論壇獲得友好的幫助和建議。

升級

升級webtrees快捷方便。強烈建議您在新版本發布時立即升級。即使是?webtrees的小版本更新，通常也會包含大量的錯誤修復、界面改進和程序增強。

自動升級

webtrees具有自動升級功能。管理員登錄后會收到新版本發布的通知，并可以選擇啟動自動升級。如果自動升級因某種原因失敗，則需要手動升級。
手動升級
1. 現在是進行備份的好時機。
2. 從?webtrees.net下載最新版本的webtrees
3. 在您上傳新文件的過程中，網站訪問者可能會看到新舊文件混雜在一起。這可能會導致不可預測的行為或錯誤。為了避免這種情況，請創建data/offline.txt文件。當此文件存在時，訪問者將看到“網站不可用 - 請稍后再來”的消息。
4. 解壓縮 .ZIP 文件，然后將文件上傳到您的 Web 服務器，覆蓋現有文件。
5. 刪除文件data/offline.txt。

Macintosh 用戶須知

步驟 4 假設您使用的復制工具會合并目錄而不是替換目錄。（合并是 Windows 和 Linux 上的標準操作。）如果您使用 Macintosh Finder 或其他類似工具執行步驟 3，它會將您的配置、媒體和其他目錄替換?為安裝中的空/默認目錄。這會非常糟糕（但您在步驟 1 中確實備份了，不是嗎！）。您可以通過搜索google.com找到更多詳細信息和合適工具的推薦。

建設與發展

如果您想從源代碼構建 Webtree，或修改代碼，則需要先安裝一些工具。

你需要使用Composer安裝 PHP 依賴項。然后運行以下命令：

php composer.phar 安裝

你需要npm來安裝 Javascript 依賴項。然后運行以下命令：

npm 安裝
npm 運行生產環境

每次修改文件時都需要重新運行第二個webtrees.js。

Gedcom（家譜）文件

當您在webtrees中導入家譜 (GEDCOM) 文件時，文件中的數據將傳輸到數據庫表中。該文件本身仍保留在webtrees/data文件夾中，并且不再被webtrees使用或需要。任何后續對webtrees數據的編輯都不會更改此文件。

如果您在webtrees之外更改了家譜數據，則無需從webtrees中刪除 GEDCOM 文件或數據庫并重新開始。請按照以下步驟更新已導入的 GEDCOM：

轉到Control panel->Manage family trees在與此特定家譜（GEDCOM）文件（或新文件）相關的行上選擇導入。
仔細注意媒體項目選項（ “如果您已經在webtrees中創建了媒體對象，并且已經使用刪除媒體對象的軟件離線編輯了數據，那么勾選此框可以將當前媒體對象與新的 GEDCOM 合并。”）在大多數情況下，您應該取消選中此框。
點擊“保存”。webtrees會在導入前再次驗證 GEDCOM 文件。在此過程中，webtrees會將您的整個家譜（GEDCOM 文件）復制到您數據庫中的“塊”表中。根據文件的編碼、文件大小以及服務器和支持軟件的功能，此過程可能需要一些時間。復制數據時不會顯示進度條，如果您離開此頁面，復制過程將暫停。當您返回家譜管理頁面時，復制過程將重新啟動。

安全

Webtrees的安全性意味著確保您的網站免受不必要的入侵、黑客攻擊或數據和配置文件的訪問。Webtrees 的開發人員將安全性視為其開發過程中極其重要的部分，并竭盡全力確保您的數據安全。

最容易受到入侵的區域是/data文件夾，其中包含您的 config.ini.php 文件以及各種臨時文件。如果您擔心存在風險，可以進行一個非常簡單的測試：嘗試url_to_your_server/data/config.ini.php在 Web 瀏覽器中輸入 config.ini.php 文件。

最可能的結果是出現如下“訪問被拒絕”消息：

<span style="background-color:#f6f8fa"><span style="color:#1f2328"><span style="color:#1f2328"><span style="background-color:#f6f8fa"><code>ForbiddenYou don't have permission to access /data/config.ini.php on this server.
</code></span></span></span></span>

這表明webtrees內置的保護正在發揮作用，無需采取進一步措施。

萬一您確實獲取了該文件（您只會看到一個分號），那么該保護就不會在您的網站上起作用，您應該采取進一步的措施。

如果您的服務器以 CGI 模式運行 PHP，則將/data文件夾的權限更改?為 700 而不是 777。這將阻止對 httpd 進程的訪問，同時仍然允許訪問 PHP 腳本。

這可能適用于 99% 的用戶。只有剩下的 1% 的用戶才應該考慮最復雜的解決方案，將/data文件夾移出可訪問的 Web 空間。（注意：在許多共享主機環境中，這根本不是一個選項。）

如果您確實認為有必要，以下是所需流程的示例：

如果您的主文件夾類似于/home/username，并且您的網站的根文件夾是/home/username/public_html，并且您已在public_html/webtrees文件夾中安裝了webtrees，那么您將在主文件夾中創建一個與 public_html 文件夾同一級別的新數據文件夾，例如/home/username/private/data，并將您的 GEDCOM（家譜）文件放在那里。

然后將->?->頁面上的數據文件夾設置從默認的data/更改為新位置/home/username/private/dataControl panelWebsiteWebsite preferences

您將有兩個數據目錄：

[webtrees 路徑]/data - 只需包含 config.ini.php
/home/username/private/data - 包含其他所有內容

備份

備份很重要。無論遇到什么問題，一個好的備份總能幫你解決。

要備份webtrees，您需要復制以下內容

webtrees/data文件夾中的文件。
數據庫中的表。使用phpMyAdmin等免費工具，?您只需單擊一下即可完成此操作。或者，您也可以運行 mysqldump 命令進行備份（只需將[localhost]、[username]、[password]和[databasename]替換為您自己的值）：

mysqldump --host=[localhost] -u [username] -p[password] --databases [databasename] > dump_file.sql

請注意，“?-p[password]?”之間沒有空格。

請記住，大多數網絡托管服務不會備份您的數據，這是您的責任。

從備份還原

要在新服務器上還原備份：

按照安裝中的步驟進行操作以獲得全新安裝。
用備份副本替換數據文件夾。
使用 phpmyadmin 恢復您的 mysql 數據庫或使用您的 mysqldumpfile 在數據庫服務器上運行以下命令行（只需將[username]、[password]和[databasename]替換為您自己的）：

mysql -u [username] -p[password] [database_name] < [dump_file.sql]
確認文件data/config.ini.php包含正確的信息以連接到數據庫并在需要時進行更新。