Chat Vault は、API インポート、電子メール、ディレクトリ監視などのさまざまなソースから WhatsApp 会話のバックアップを保存し、WhatsApp などのチャット アプリケーションに似たフロントエンドを通じてこれらの会話に簡単にアクセスできるように設計された Kotlin Spring Boot アプリケーションです。
このプロジェクトはまだ開発中であり、一部の機能は完全には実装されていない可能性があります。
Whatsapp の公式 FAQ をお読みください。
インポートされたファイルを ChatVault に取り込むには、次のことができます。
このリポジトリは 2 つの主要モジュールに分かれています。それらはモジュールです: フロントエンド (javascript、vue、nuxt) とバックエンド (kotlin、java、spring boot、gradle)
フロントエンド モジュールは Vue/Nuxt アプリケーションであり、ブラウザによってレンダリングされるもの (html、css、javascript、静的アセット) を提供します。 npm コマンドを使用して従来の方法を実行するには、フロントエンド ディレクトリの Readme に従ってください。
npm で実行できます。
npm run dev
フロントエンド アプリケーションは、以前にバックエンド アプリケーションを実行した場合 (バックエンドは 8080 でリッスンする) を除き、デフォルトでポート 3000 でリッスンします。その場合、フロントエンドはランダムなポートを選択します。
IDE がなくてもバックエンド アプリケーションを実行できます。
./gradlew run
バックエンド アプリケーションは、デフォルトで 8080 ポートをリッスンします。
コンテナー イメージをダウンロードするには、ここで GitHub Container Registry の手順に対する認証が必要になる場合があることに注意してください。 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://データベースホスト:5432/データベース名 |
spring.datasource.ユーザー名 | 必須 | ユーザー |
spring.datasource.password | 必須 | 秘密 |
------------------------ | ------------------------ | --------- |
電子メールのインポート | 特技は必要ありません | |
chatvault.email.enabled | 必要ありません | 真実 |
chatvault.email.host | 偉業を達成するために必要な | imap.server.com |
chatvault.メール.パスワード | 偉業を達成するために必要な | 秘密 |
chatvault.email.port | 偉業を達成するために必要な | 993 |
chatvault.email.ユーザー名 | 偉業を達成するために必要な | 誰かのユーザー |
chatvault.email.debug | 必要ありません | 真実 |
------------------------ | ------------------------ | |
ファイルシステム | 必要ありません | |
chatvault.bucket.root | 必要ありません | /opt/chatvault/アーカイブ |
chatvault.bucket.import | 必要ありません | /opt/chatvault/import |
chatvault.bucket.export | 必要ありません | /opt/chatvault/エクスポート |
------------------------ | ------------------------ | |
chatvault.host | 必要ありません | https://somehost.com 、http://localhost:3000 |
spring.servlet.multipart.max-file-size | 必要ありません | 500MB |
spring.servlet.multipart.max-request-size | 必要ありません | 500MB |
chatvault.msgparser.dateformat | 必須ではありませんが推奨されます | dd/MM/yyyy HH:mm |