Chat Vault 是一個Kotlin Spring Boot 應用程序,旨在儲存來自各種來源(例如API 導入、電子郵件和目錄監控)的WhatsApp 對話的備份,並透過類似於聊天應用程式(如WhatsApp)的前端提供對這些對話的輕鬆存取。
該專案仍在開發中,某些功能可能尚未完全實現。
請閱讀官方 Whatsapp 常見問題。
使用匯入的文件,要將其提取到 ChatVault 中,您可以:
此存儲庫分為兩個主要模組。它們是模組:前端(javascript、vue、nuxt)和後端(kotlin、java、spring boot、gradle)
前端模組是一個 Vue/Nuxt 應用程序,它提供瀏覽器渲染的內容:html、css、javascript 和靜態資源。若要使用 npm 命令以傳統方式運行,請按照前端目錄中的自述文件進行操作。
您可以使用 npm 運行它:
npm run dev
預設情況下,前端應用程式將偵聽連接埠 3000,除非您之前執行過後端應用程式(後端偵聽 8080),在這種情況下,前端將選擇一個隨機連接埠。
您可以在沒有 IDE 的情況下運行後端應用程式:
./gradlew run
後端應用程式預設監聽8080埠。
請注意,下載容器映像可能需要您透過此處的 GitHub 容器登錄步驟進行驗證。您可以使用 compose.yml 在本地建立資料庫並建立前後端專案。
docker-compose -f compose.yml
github上有docker映像包。您可以透過以下方式下載最新的圖像:
docker pull ghcr.io/vitormarcal/chatvault:latest
該應用程式需要在檔案系統中儲存聊天檔案。 Docker的使用請參考環境變數部分。
chatvault.bucket.root
:這是用來儲存檔案的磁碟區。不要刪除這個!chatvault.bucket.import
:此磁碟區暫時用於儲存將由應用程式解析然後移至bucket.root的聊天檔案。chatvault.bucket.export
:此卷暫時用於儲存要下載的聊天內容。對於docker來說,變數必須是大寫,其中“.”它必須是“_”: some.environment.variable
就像docker中的SOME_ENVIRONMENT_VARIABLE
環境變數 | 觀測值 | 例子 |
---|---|---|
資料庫 | 必需的 | |
spring.datasource.url | 必需的 | jdbc:postgresql://database_host:5432/database_name |
spring.datasource.用戶名 | 必需的 | 使用者 |
spring.datasource.password | 必需的 | 秘密 |
-------------------------- | -------------------------- | --------- |
郵件導入 | 不需要壯舉 | |
chatvault.email.啟用 | 不需要 | 真的 |
chatvault.email.host | 需要壯舉 | imap.server.com |
聊天庫.電子郵件.密碼 | 需要壯舉 | 秘密 |
chatvault.email.port | 需要壯舉 | 993 |
chatvault.email.用戶名 | 需要壯舉 | 某個用戶 |
聊天庫.電子郵件.調試 | 不需要 | 真的 |
-------------------------- | -------------------------- | |
檔案系統 | 不需要 | |
chatvault.bucket.root | 不需要 | /opt/chatvault/存檔 |
chatvault.bucket.import | 不需要 | /opt/chatvault/導入 |
chatvault.bucket.export | 不需要 | /opt/chatvault/導出 |
-------------------------- | -------------------------- | |
聊天庫主機 | 不需要 | https://somehost.com ,http://localhost:3000 |
spring.servlet.multipart.max-檔案大小 | 不需要 | 500MB |
spring.servlet.multipart.最大請求大小 | 不需要 | 500MB |
chatvault.msgparser.dateformat | 不是必需的,但建議 | 日/月/年 時:分 |