chitchatter

奇蹟

_{@ramyashreeshetty提供的徽標}

Chitchatter是一種免費的（在價格和自由中）的溝通工具。設計為與他人私下和安全建立聯繫的最簡單方法，是：

• 完全開源（根據GPL V2許可）
• 點對點
  • 只要有可能，否則使用轉向服務器來確保可靠
• 端到端加密（通過WEBRTC）
• 短暫
  • 消息內容永遠不會持續到客戶端或服務器上的磁盤
• 分散的
  • 沒有API服務器。 Chitchatter功能所需的只是GitHub用於靜態資產的可用性，以及用於建立點對點通信的公共Web Torrent和stun/turn繼電器服務器。
• 可嵌入
• 自主

Chitchatter使用Vite。沒有trystero，安全的網絡和流魔法是不可能的。文件傳輸功能由secure-file-transfer提供動力。

地位

如何使用它

打開https://chitchatter.im/並加入一個房間，開始與房間裡的其他人聊天。默認情況下，房間名稱是生成客戶端的隨機UUID。要與某人私下通信，建議加入這些隨機生成的房間之一，並共享網址（通過頁面頂部的“？”按鈕），以通過選擇的安全介質（例如燃燒器註釋或Yopass）與您進行通信的任何人。您的用戶名將向您展示，並且可以與您事先與您聊天的人分享，以便他們知道他們正在與您交談。

特徵

• 每個房間多個同行（僅受瀏覽器支持的同行連接數量的限制）。
• 公共和私人房間。
• 視頻和音頻聊天。
• 屏幕共享。
• 直接消息傳遞。
• 文件共享：
  • 無限的文件大小傳輸。
  • 在發送和解密的接收器之前對文件進行加密（密鑰是房間名稱）。
• 通過iframe嵌入其他Web應用程序。
• 通過react-markdown支持降級支持。
  • 包括對代碼的語法突出顯示的支持。
• 當新的參與者加入時，對話會從同齡人那裡進行回報。
• 多行消息支持（持有shift並按enter ）。
• 黑暗而輕的主題。
• 通過客戶端公開密碼學自動驗證。

抗功能

• 消息永遠不會持續到磁盤。當您離開同伴室時，將從內存中清除消息，無法檢索。
• Chitchatter是一個完全客戶端的通信應用程序。當無法建立直接的對等連接時，它使用公共Web Torrent服務器來建立對等連接並昏迷/轉向繼電器服務器，但是沒有Chitchatter API服務器。
• 沒有任何類型的分析，跟踪或遙測。
• 這是一個沒有賺錢的社區驅動和無資金的項目。用戶排在第一位，沒有公司的影響力或財務利益。

為什麼另一個聊天應用程序？

不乏可用的用戶友好聊天應用程序，但它們依靠中央服務來促進通信。很難信任這些中央服務，因為商業利益和政府壓力可以迫使服務運營商違反用戶的最大利益。即使服務運營商真誠地處理用戶數據，仍有可能根據用戶的意願解密剩餘的加密數據。

通過網網格體系結構圍繞這些風險進行設計。沒有中央服務運營商存儲或可能發生不當通信數據。需要一些服務來建立同行之間的初始連接，但是該應用程序對所有事物都使用直接的點對點通信。 Chitchatter使用的任何服務都與該項目沒有關聯，並且可以公開使用。

用例

Chitchatter提供了一個私人且安全的解決方案：

• 組織人群，例如工會或政治運動
• 方便地將文本或數據從一台設備轉到另一台設備
• 視頻跨操作系統與朋友和家人聊天（例如Android和iOS）
• 它通過屏幕共享進行故障排除
• 直播
• 共享敏感信息，例如密碼
• 更多！

---

開發人員的註釋

項目狀態

我認為Chitchatter功能完全完整，它可以完成我個人需要做的所有事情。我沒有具體的計劃來將來添加重大功能，但是如果當時對我來說似乎很有趣，我可能會這樣做。我致力於修復報告的任何重要錯誤，因此，如果您發現一個問題，請打開一個問題！除此之外，在可預見的將來，Chitchatter有效地處於維護模式。

如果您希望實施一項功能並願意支付開發費用以確保完成，請提交描述該功能的GitHub問題，並表明您願意賠償這項工作。如果您不願付款，請開一個GitHub問題。如果這樣做似乎很有趣，我可能會實現它，但是社區的其他成員也可以通過拉動請求加緊實施它。

我將始終從他人那裡提出時間支持請求。如果您願意進行改善居民的工作，我願意幫助牧羊人一起運行並運送它。

如果您不同意該項目的方向，歡迎您參加Fork Chitchatter並將其帶入另一個。

支持和自定義開發

我願意為您的需求進行付費安裝和定制案件。如果您想簽約我製作專為您構建的Chitchatter的版本，請給我發送電子郵件至[email protected]，讓我知道您想開始的想法。

---

真實性

Chitchatter安全模型的核心是它是完全開源的事實。您有空（並鼓勵）充分審核項目源代碼和基礎架構。不僅是GPL條款可用的源代碼，而且所有構建日誌都可以公開訪問。

如果您想驗證在https://chitchatter.im/上託管的應用程序是在GitHub上託管的應用程序，則可以使用dig ：

 $ dig chitchatter.im

; <<>> DiG 9.18.1-1ubuntu1.1-Ubuntu <<>> chitchatter.im
;; global options: +cmd
;; Got answer:
;; ->>HEADER<<- opcode: QUERY, status: NOERROR, id: 61332
;; flags: qr rd ra; QUERY: 1, ANSWER: 5, AUTHORITY: 0, ADDITIONAL: 1

;; OPT PSEUDOSECTION:
; EDNS: version: 0, flags:; udp: 65494
;; QUESTION SECTION:
;chitchatter.im.                        IN      A

;; ANSWER SECTION:
chitchatter.im.         231     IN      CNAME   jeremyckahn.github.io.
jeremyckahn.github.io.  231     IN      A       185.199.111.153
jeremyckahn.github.io.  231     IN      A       185.199.110.153
jeremyckahn.github.io.  231     IN      A       185.199.109.153
jeremyckahn.github.io.  231     IN      A       185.199.108.153

為了檢查用於最終用戶的靜態資產，您可以審核gh-pages分支。

項目路線圖

在此處查看完整的票務積壓。

環境

• 生產環境：https：//chitchatter.im/
  • 鏡子：https：//chitchatter.vercel.app/（請注意，同行無法跨域連接）
• 登台：https：//chitchatter-git-develop-jeremyckahn.vercel.app/

SDK

您可以使用官方的Chitchatter SDK將應用程序嵌入為Web組件，稱為<chat-room /> 。

 < script src =" https://chitchatter.im/sdk.js " > </ script >

< chat-room />

<chat-room />組件支持以下可選屬性：

• room ：用戶應加入的牢房室的名稱。默認值是嵌入頁面的URL。
• user-name ：用戶的友好名稱（他們可以更改）。
• user-id ：用戶的靜態ID。默認值是一個隨機的uuid。
• root-url ：要使用的Chitchater實例的URL。默認值是https://chitchatter.im/ 。
• color-mode ： light或dark 。默認值是dark 。
• play-message-sound ：當用戶在窗口不集中時收到消息時，是否播放聲音。默認值是false 。

以及以下標準<iframe />屬性：

• height
• width
• style
• referrerpolicy
• sandbox

發展居民

重要的

目前只能在諸如Linux和MacOS之類的 *NIX系統上開發Chitchatter。如果使用Windows，則可以使用WSL設置Linux環境。

為了更改Chitchatter，請從GitHub中克隆源代碼。確保您安裝了節點和NPM。然後在項目目錄中運行：

 npm install

這將安裝所有依賴關係。

可用腳本

在項目目錄中，您可以運行：

npm dev

在本地運行整個堆棧（客戶端 + WebTorrent跟踪器）。

npm start

在開發模式下運行前端應用程序。使用公共WebTorrent跟踪器。打開http：// localhost：3000在瀏覽器中查看。

進行更改時，該頁面將重新加載。您可能還會在控制台中看到任何棉絨錯誤。

npm test

在交互式手錶模式下啟動測試跑者。

npm run build

將應用程序構建到dist文件夾中。它正確地捆綁了在生產模式下進行反應，並優化構建以獲得最佳性能。

構建被縮小，文件名包括哈希。

自我託管

Chitchatter設計為分叉和自主。如果您想更改配對或繼電器服務器配置，或者您希望控制自己的構建和版本，請訂購此存儲庫並按照以下步驟操作。

重要的

核心對等連接綁定到實例的域。因此，https://chitchatter.im/的Chitchatter的用戶將無法連接到另一個域上的chitchatter實例的用戶（例如個人github頁面託管）。

分叉後的必要步驟

假設您在Github頁面上託管了Chitchatter：

1. package.json中的homepage屬性更改為將託管您的Chitchatter實例的任何URL。這將是https://github_user_or_org_name.github.io/chitchatter/ 。
2. 定義DEPLOY_KEY Github Action Secret（在https://github.com/github_user_or_org_name/chitchatter/settings/secrets/actions ）。有關更多信息，請參見peaceiris/actions-gh-pages的文檔。
3. 如果您使用沒有自定義域的GitHub頁面，則需要將repo名稱定義為vite.config.ts中的base屬性。這是一個外觀的示例：

 const config = ( ) => {
   return defineConfig ( {
      base : '/chitchatter/' ,
      build : {
       ...
} 

部署

在github上

在GitHub頁面上託管並完成了上述配置時，在更新遠程main分支（一旦啟用GitHub操作），則更新生產環境。

在非github主機上

使用npm run build構建應用程序，然後服務dist目錄。任何靜態文件服務解決方案都應使用，只要它使用安全上下文。

運行時配置

探索src/config中的文件以修改配對和繼電器服務器配置。

主題自定義

Chitchatter利用可主題的MUI組件庫。您可以通過修改Shell主題定義來自定義Chitchatter的外觀和感覺。

故障排除

如果您遇到了自定義居民安裝的任何問題，請首先確保您使用的是最新版本的代碼。如果您使用GitHub頁面託管安裝，請同步您的main分支，而不是gh-pages分支。更新main分支將觸發您的gh-pages分支的適當重建。

• https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork

同伴不會連接

這可能出於多種原因而發生。其中最有可能的是一個或多個對等方無法直接連接，必須將配置的暈厥/轉向繼電器用作後備。標準繼電器是免費的，不能保證任何水平的服務，因此在一段時間內可能根本無法使用（或根本不適合某些用戶）。除了等到再次可用，或者可能從其他設備或位置嘗試，別無選擇。

特定於瀏覽器具有廣告阻塞擴展的問題

一些廣告阻滯劑（例如Ublock Origin）阻止了與某些WebTorrent服務器的連接。這樣可以防止居民對等。為了解決此問題，您可以禁用廣告阻滯劑或自助式居住者實例。

iOS Safari特定的問題

Chitchatter在iOS Safari上工作，但是瀏覽器級錯誤通常會阻止當瀏覽器關閉並隨後重新打開時（例如，在切換應用程序時）時，同伴無法重新加入房間。此問題的建議解決方法是刷新頁面以重新加入房間。

Firefox特定的問題

根據＃36，檢查您的about:config設置，並確保啟用了media.peerconnection.enabled 。

提供的文件不能從同行下載

Chitchatter使用StreamSaver.js來促進大型文件傳輸。已知下載經理（例如FDM）會干擾streamsaver.js，因此建議在嘗試接收文件時禁用此類下載經理。

安全

Chitchatter進行每週的安全審核，以識別和解決潛在的漏洞。所有審核的報告都可以在問題中找到。

貢獻者

配x免責聲明

通過使用Chitchatter，您同意對與其使用相關的行為承擔全部責任。此外，您同意不為您使用該項目的任何結果持有任何負責的居民項目的貢獻者。 Chitchatter的開發商不認可非法活動。