diff --git a/.env b/.env index 650b487..1025754 100644 --- a/.env +++ b/.env @@ -1,2 +1,2 @@ REACT_APP_NAME=$npm_package_name -REACT_APP_GITHUB_REPO="https://github.com/jeremyckahn/chitchatter" +REACT_APP_GITHUB_REPO="https://githaven.org/shiloh/remnantchat" diff --git a/.github/ISSUE_TEMPLATE/room-request.yml b/.github/ISSUE_TEMPLATE/room-request.yml deleted file mode 100644 index e3a6d0a..0000000 --- a/.github/ISSUE_TEMPLATE/room-request.yml +++ /dev/null @@ -1,23 +0,0 @@ -name: Community Room Request -description: Request a new Community Room -title: '[Community Room Request]: ' -labels: ['room request'] -assignees: - - jeremyckahn -body: - - type: input - id: room-url - attributes: - label: Room URL - description: What is the Chitchatter URL for this room? - placeholder: ex. https://chitchatter.im/public/room-subject - validations: - required: true - - type: input - id: room-subject - attributes: - label: Room Subject - description: What should be discussed in this room? - placeholder: ex. Technology, video games, etc. - validations: - required: true diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml deleted file mode 100644 index 2e1e198..0000000 --- a/.github/workflows/ci.yml +++ /dev/null @@ -1,26 +0,0 @@ -name: CI - -on: - push: - branches: - - '**' - # - '!main' - -jobs: - test_and_build: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - - uses: actions/setup-node@v4 - with: - node-version: 18 - - run: npm ci - - run: npm test - - - name: 'Build web app artifacts' - run: npm run build - - - uses: actions/upload-artifact@v3 - with: - name: build-output - path: build diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml deleted file mode 100644 index 9876bef..0000000 --- a/.github/workflows/deploy.yml +++ /dev/null @@ -1,34 +0,0 @@ -name: Deploy to Github Pages - -on: - push: - branches: - - main - - workflow_dispatch: - -jobs: - deployment: - runs-on: ubuntu-latest - - steps: - - uses: actions/checkout@v4 - - - name: Setup Node - uses: actions/setup-node@v4 - with: - node-version: 18 - cache: 'npm' - - - name: Build - run: | - npm ci - npm run build - npm run analyze -- --html build/bundle-info.html - - - name: Deploy - uses: peaceiris/actions-gh-pages@v3 - with: - deploy_key: ${{ secrets.DEPLOY_KEY }} - publish_dir: ./build - force_orphan: true diff --git a/.github/workflows/security.yml b/.github/workflows/security.yml deleted file mode 100644 index dd10e5d..0000000 --- a/.github/workflows/security.yml +++ /dev/null @@ -1,34 +0,0 @@ -name: Perform Security Audit with ZAProxy -# Use ZAP Proxy to perform a full scan of the production site. - -on: - # manually trigger workflow - workflow_dispatch: - - # Listen for Production deployments - workflow_run: - workflows: [pages-build-deployment] - types: - - completed - -jobs: - zap_scan: - runs-on: ubuntu-latest - name: Scan Production Site - steps: - - name: Set Date (NOW) as Variable - id: set-now - run: | - echo "NOW=$(date +'%Y-%m-%d')" >> "$GITHUB_OUTPUT" - - - name: Checkout Repo for .zap/rules.tsv - uses: actions/checkout@v4 - - - name: ZAP Full Scan - # https://github.com/zaproxy/action-full-scan - uses: zaproxy/action-full-scan@v0.7.0 - with: - target: 'https://chitchatter.im/' - rules_file_name: '.zap/rules.tsv' - artifact_name: 'zap_scan_${{ steps.set-now.outputs.NOW }}' - allow_issue_writing: false diff --git a/README.md b/README.md index 0101716..6ad61b6 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,8 @@ -# Chitchatter +# RemnantChat -![Chitchatter logo](./public/logo/logo.svg) +![RemnantChat logo](./public/logo/logo.svg) -Logo provided by [@ramyashreeshetty](https://github.com/ramyashreeshetty) - -Chitchatter is a free (as in both price and freedom) communication tool. Designed to be the simplest way to connect with others privately and securely, it is: +RemnantChat is a free (as in both price and freedom) communication tool. Designed to be the simplest way to connect with others privately and securely, it is: - Fully open source (licensed under [GPL v2](./LICENSE)) - Peer-to-peer @@ -13,19 +11,19 @@ Chitchatter is a free (as in both price and freedom) communication tool. Designe - Ephemeral - Message content is never persisted to disk on either the client or server - Decentralized - - There is no API server. All that's required for Chitchatter to function is availability of GitHub for static assets, and public WebTorrent and STUN/TURN relay servers for establishing peer-to-peer communication. + - There is no API server. All that's required for RemnantChat to function is availability of GitHub for static assets, and public WebTorrent and STUN/TURN relay servers for establishing peer-to-peer communication. - Embeddable - [Self-hostable](#self-hosting) -Chitchatter uses the [Create React App](https://github.com/facebook/create-react-app) toolchain. The secure networking and streaming magic would not be possible without [Trystero](https://github.com/dmotz/trystero). File transfer functionality is powered by [`secure-file-transfer`](https://github.com/jeremyckahn/secure-file-transfer). +RemnantChat uses the [Create React App](https://github.com/facebook/create-react-app) toolchain. The secure networking and streaming magic would not be possible without [Trystero](https://github.com/dmotz/trystero). File transfer functionality is powered by [`secure-file-transfer`](https://github.com/jeremyckahn/secure-file-transfer). ## Status -- [![Known Vulnerabilities](https://snyk.io/test/github/jeremyckahn/chitchatter/badge.svg?targetFile=package.json)](https://snyk.io/test/github/jeremyckahn/chitchatter?targetFile=package.json) +- [![Known Vulnerabilities](https://snyk.io/test/github/jeremyckahn/RemnantChat/badge.svg?targetFile=package.json)](https://snyk.io/test/github/jeremyckahn/RemnantChat?targetFile=package.json) ## How to use it -Open https://chitchatter.im/ and join a room to start chatting with anyone else who is in the room. By default, room names are random [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier)s that are generated client-side. To privately communicate with someone, it is recommended to join one of these randomly-generated rooms and share the URL (via the "🔗" button at the top of the page) to whomever you wish to communicate with via a secure medium of your choosing (such as [Burner Note](https://burnernote.com/) or [Yopass](https://yopass.se/)). Your user name will be presented to you, and it would be good to share that with who you will be chatting with beforehand so they know they're talking to you. +Open https://RemnantChat.im/ and join a room to start chatting with anyone else who is in the room. By default, room names are random [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier)s that are generated client-side. To privately communicate with someone, it is recommended to join one of these randomly-generated rooms and share the URL (via the "🔗" button at the top of the page) to whomever you wish to communicate with via a secure medium of your choosing (such as [Burner Note](https://burnernote.com/) or [Yopass](https://yopass.se/)). Your user name will be presented to you, and it would be good to share that with who you will be chatting with beforehand so they know they're talking to you. ## Features @@ -47,7 +45,7 @@ Open https://chitchatter.im/ and join a room to start chatting with anyone else ## Anti-features - Messages are never persisted to disk. When you leave a peer room, messages are cleared from memory and cannot be retrieved. -- Chitchatter is an entirely client-side communication app. It uses public WebTorrent servers to establish peer connections and STUN/TURN relay servers when direct peer-to-peer connections cannot be established, but there is no Chitchatter API server. +- RemnantChat is an entirely client-side communication app. It uses public WebTorrent servers to establish peer connections and STUN/TURN relay servers when direct peer-to-peer connections cannot be established, but there is no RemnantChat API server. - No analytics, tracking, or telemetry of any kind. - This is a community-driven and unfunded project that makes no money. The users come first and there is no corporate influence or financial interest involved. @@ -55,11 +53,11 @@ Open https://chitchatter.im/ and join a room to start chatting with anyone else There is no shortage of user-friendly chat apps available, but they rely on a central service to facilitate communication. It is difficult to trust these central services, as commercial interests and [government pressure](https://www.npr.org/2022/08/12/1117092169/nebraska-cops-used-facebook-messages-to-investigate-an-alleged-illegal-abortion) can compel service operators to work against the best interest of the users. Even when user data is handled in good faith by service operators, the possibility remains that [encrypted data held at rest may be decrypted](https://www.cbsnews.com/news/fbi-may-have-found-way-to-unlock-san-bernardino-shooters-iphone/) against the user's will. -Chitchatter designs around these risks with a [web meshe architecture](https://dev.to/jeremyckahn/taking-the-power-back-with-web-meshes-omg). There is no central service operator that stores or potentially mishandles communication data. Some services are required to establish an initial connection between peers, but otherwise the app uses direct peer-to-peer communication for everything. Any services that are used by Chitchatter have no association with the project and are publicly available for all to use. +RemnantChat designs around these risks with a [web meshe architecture](https://dev.to/jeremyckahn/taking-the-power-back-with-web-meshes-omg). There is no central service operator that stores or potentially mishandles communication data. Some services are required to establish an initial connection between peers, but otherwise the app uses direct peer-to-peer communication for everything. Any services that are used by RemnantChat have no association with the project and are publicly available for all to use. ## Use cases -Chitchatter offers a private and secure solution for: +RemnantChat offers a private and secure solution for: - Organizing groups of people, such as unions or political movements - Conveniently moving text or data from one device to another @@ -75,30 +73,30 @@ Chitchatter offers a private and secure solution for: ### 💻️ Project status -I consider Chitchatter feature-complete inasmuch it does all the things I personally need it to do. I don't have specific plans to add significant functionality in the future, but I may do so if it seems fun to me at the time. **I am committed to fixing any significant bugs** that are reported, so please [open an issue](https://github.com/jeremyckahn/chitchatter/issues/new) if you discover one! Aside from that, Chitchatter is effectively in maintenance mode for the foreseeable future. +I consider RemnantChat feature-complete inasmuch it does all the things I personally need it to do. I don't have specific plans to add significant functionality in the future, but I may do so if it seems fun to me at the time. **I am committed to fixing any significant bugs** that are reported, so please [open an issue](https://github.com/jeremyckahn/RemnantChat/issues/new) if you discover one! Aside from that, RemnantChat is effectively in maintenance mode for the foreseeable future. If you would like a feature to be implemented and are willing to pay a development cost to ensure it gets done, please file a GitHub issue describing the feature and indicate that you are willing to compensate for the work. If you are not willing to pay, please open a GitHub issue regardless. I may implement it if it seems fun to do so, but other members of the community may also step up to implement it via Pull Requests. -I will always make time support Pull Requests from others. If you're willing to put in the work to improve Chitchatter, I am willing to help shepherd that work along and get it shipped. +I will always make time support Pull Requests from others. If you're willing to put in the work to improve RemnantChat, I am willing to help shepherd that work along and get it shipped. -If you don't agree with the direction of the project, you are welcome to fork Chitchatter and take it in another one. +If you don't agree with the direction of the project, you are welcome to fork RemnantChat and take it in another one. ### 🏗️ Support and custom development -I'm willing to do paid installations and customizations of Chitchatter for your needs. If you'd like to contract me to make a version of Chitchatter that is custom built for you, please email me at jeremyckahn@gmail.com and let me know what you have in mind to get started. +I'm willing to do paid installations and customizations of RemnantChat for your needs. If you'd like to contract me to make a version of RemnantChat that is custom built for you, please email me at jeremyckahn@gmail.com and let me know what you have in mind to get started. --- ## Veracity -The core of Chitchatter's security model is the fact that it is fully open source. You are free (and encouraged) to fully audit the project source code and infrastructure. Not only is the source code available under the terms of the [GPL](./LICENSE), but [all build logs are publicly accessible](https://github.com/jeremyckahn/chitchatter/actions/workflows/pages/pages-build-deployment) as well. +The core of RemnantChat's security model is the fact that it is fully open source. You are free (and encouraged) to fully audit the project source code and infrastructure. Not only is the source code available under the terms of the [GPL](./LICENSE), but [all build logs are publicly accessible](https://github.com/jeremyckahn/RemnantChat/actions/workflows/pages/pages-build-deployment) as well. -If you would like to verify that the app hosted at https://chitchatter.im/ is the one that is hosted on GitHub, you can use `dig`: +If you would like to verify that the app hosted at https://RemnantChat.im/ is the one that is hosted on GitHub, you can use `dig`: ``` -$ dig chitchatter.im +$ dig RemnantChat.im -; <<>> DiG 9.18.1-1ubuntu1.1-Ubuntu <<>> chitchatter.im +; <<>> DiG 9.18.1-1ubuntu1.1-Ubuntu <<>> RemnantChat.im ;; global options: +cmd ;; Got answer: ;; ->>HEADER<<- opcode: QUERY, status: NOERROR, id: 61332 @@ -107,17 +105,17 @@ $ dig chitchatter.im ;; OPT PSEUDOSECTION: ; EDNS: version: 0, flags:; udp: 65494 ;; QUESTION SECTION: -;chitchatter.im. IN A +;RemnantChat.im. IN A ;; ANSWER SECTION: -chitchatter.im. 231 IN CNAME jeremyckahn.github.io. +RemnantChat.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 ``` -To examine the static assets that are served to end users, you can audit the [`gh-pages` branch](https://github.com/jeremyckahn/chitchatter/tree/gh-pages). +To examine the static assets that are served to end users, you can audit the [`gh-pages` branch](https://github.com/jeremyckahn/RemnantChat/tree/gh-pages). ## Project roadmap @@ -125,26 +123,26 @@ See the full ticket backlog [here](https://github.com/users/jeremyckahn/projects ## Environments -- Production environment: https://chitchatter.im/ - - Mirror: https://chitchatter.vercel.app/ (note that peers cannot connect across domains) -- Staging: https://chitchatter-git-develop-jeremyckahn.vercel.app/ +- Production environment: https://RemnantChat.im/ + - Mirror: https://RemnantChat.vercel.app/ (note that peers cannot connect across domains) +- Staging: https://RemnantChat-git-develop-jeremyckahn.vercel.app/ ## SDK -You can use the official Chitchatter SDK to embed the app as a [Web Component](https://developer.mozilla.org/en-US/docs/Web/API/Web_components) called ``. +You can use the official RemnantChat SDK to embed the app as a [Web Component](https://developer.mozilla.org/en-US/docs/Web/API/Web_components) called ``. ```html - + ``` The `` component supports the following optional attributes: -- `room`: The name of the Chitchatter room the user should join. The default value is the URL of the embedding page. +- `room`: The name of the RemnantChat room the user should join. The default value is the URL of the embedding page. - `user-name`: The friendly name of the user (which they can change). - `user-id`: The static ID of the user. The default value is a random UUID. -- `root-url`: The URL of the Chitchatter instance to use. The default value is `https://chitchatter.im/`. +- `root-url`: The URL of the RemnantChat instance to use. The default value is `https://RemnantChat.im/`. - `color-mode`: `light` or `dark`. The default value is `dark`. - `play-message-sound`: Whether or not to play a sound when a user receives a message while the window is not in focus. The default value is `false`. @@ -183,18 +181,18 @@ The build is minified and the filenames include the hashes. ### Self-hosting -Chitchatter is designed to be forked and self-hosted. If you would like to change pairing or relay server configuration, or you simply prefer to control your own builds and versions, just [fork this repo](https://github.com/jeremyckahn/chitchatter/fork) and follow the steps below. +RemnantChat is designed to be forked and self-hosted. If you would like to change pairing or relay server configuration, or you simply prefer to control your own builds and versions, just [fork this repo](https://github.com/jeremyckahn/RemnantChat/fork) and follow the steps below. #### Caveats -Chitchatter peer connections are bound to the instance's domain. So, a user of Chitchatter at https://chitchatter.im/ would not be able to connect to a user of a Chitchatter instance on another domain (such as a personal GitHub Pages-hosted fork). +RemnantChat peer connections are bound to the instance's domain. So, a user of RemnantChat at https://RemnantChat.im/ would not be able to connect to a user of a RemnantChat instance on another domain (such as a personal GitHub Pages-hosted fork). #### Necessary steps after forking -Assuming you are hosting Chitchatter on [GitHub Pages](https://pages.github.com/): +Assuming you are hosting RemnantChat on [GitHub Pages](https://pages.github.com/): -1. Change the [`homepage` property in `package.json`](https://github.com/jeremyckahn/chitchatter/blob/1ea67e2c3a45115e054ebfe3457f2c3572c6213b/package.json#L4) to whatever URL your Chitchatter instance will be hosted from. This will be something like `https://github_user_or_org_name.github.io/chitchatter/`. -2. Define a [`DEPLOY_KEY` GitHub Action secret](https://github.com/jeremyckahn/chitchatter/blob/e2bac732cf1288f7b5d0bec151098f18e8b1d0d6/.github/workflows/deploy.yml#L28-L31) (at `https://github.com/github_user_or_org_name/chitchatter/settings/secrets/actions`). See the docs for [`peaceiris/actions-gh-pages`](https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-set-ssh-private-key-deploy_key) for more information. +1. Change the [`homepage` property in `package.json`](https://github.com/jeremyckahn/RemnantChat/blob/1ea67e2c3a45115e054ebfe3457f2c3572c6213b/package.json#L4) to whatever URL your RemnantChat instance will be hosted from. This will be something like `https://github_user_or_org_name.github.io/RemnantChat/`. +2. Define a [`DEPLOY_KEY` GitHub Action secret](https://github.com/jeremyckahn/RemnantChat/blob/e2bac732cf1288f7b5d0bec151098f18e8b1d0d6/.github/workflows/deploy.yml#L28-L31) (at `https://github.com/github_user_or_org_name/RemnantChat/settings/secrets/actions`). See the docs for [`peaceiris/actions-gh-pages`](https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-set-ssh-private-key-deploy_key) for more information. #### Deployment @@ -212,7 +210,7 @@ Explore the files in `src/config` to modify pairing and relay server configurati ### Troubleshooting -If you run into any issues with a custom Chitchatter installation, first ensure that you are using [the latest version of the code](https://github.com/jeremyckahn/chitchatter/tree/main). If you are hosting your installation with GitHub Pages, sync your `main` branch and _not_ your `gh-pages` branch. Updating your `main` branch will trigger a proper rebuild of your `gh-pages` branch. +If you run into any issues with a custom RemnantChat installation, first ensure that you are using [the latest version of the code](https://github.com/jeremyckahn/RemnantChat/tree/main). If you are hosting your installation with GitHub Pages, sync your `main` branch and _not_ your `gh-pages` branch. Updating your `main` branch will trigger a proper rebuild of your `gh-pages` branch. - https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork @@ -222,28 +220,28 @@ This could happen for a variety of reasons. The most likely of which is that one ##### Issues specific to browsers with ad blocking extensions -Some ad blockers (such as uBlock Origin) prevent connections to certain WebTorrent servers. This prevents Chitchatter peers from connecting. To work around this, you can either disable your ad blocker or [self-host your own Chitchatter instance](#self-hosting). +Some ad blockers (such as uBlock Origin) prevent connections to certain WebTorrent servers. This prevents RemnantChat peers from connecting. To work around this, you can either disable your ad blocker or [self-host your own RemnantChat instance](#self-hosting). ##### Issues specific to iOS Safari -Chitchatter works on iOS Safari, but browser-level bugs often prevent peers from rejoining the room when the browser is closed and later reopened (for instance, when switching applications). The suggested workaround for this issue is to refresh the page to rejoin the room. +RemnantChat works on iOS Safari, but browser-level bugs often prevent peers from rejoining the room when the browser is closed and later reopened (for instance, when switching applications). The suggested workaround for this issue is to refresh the page to rejoin the room. ##### Issues specific to Firefox -Per [#36](https://github.com/jeremyckahn/chitchatter/issues/36), check your `about:config` settings and ensure that `media.peerconnection.enabled` is **enabled**. +Per [#36](https://github.com/jeremyckahn/RemnantChat/issues/36), check your `about:config` settings and ensure that `media.peerconnection.enabled` is **enabled**. ##### Security -Chitchatter undergoes [weekly security audits](https://github.com/jeremyckahn/chitchatter/blob/develop/.github/workflows/security.yml) to identify and address potential vulnerabilities. Reports from all audits can be found in [**Issues**](https://github.com/jeremyckahn/chitchatter/issues?q=%22Security+Report+-+%22). +RemnantChat undergoes [weekly security audits](https://github.com/jeremyckahn/RemnantChat/blob/develop/.github/workflows/security.yml) to identify and address potential vulnerabilities. Reports from all audits can be found in [**Issues**](https://github.com/jeremyckahn/RemnantChat/issues?q=%22Security+Report+-+%22). ### Contributors

- - + +

-## ⚠️ [Disclaimer](https://chitchatter.im/disclaimer) +## ⚠️ [Disclaimer](https://RemnantChat.im/disclaimer) -By using Chitchatter, you agree to accept **full responsibility** for your actions related to its use. Additionally, you agree **not** to hold any contributors to the Chitchatter project responsible for any result of your use of it. The developers of Chitchatter do not endorse illegal activity. +By using RemnantChat, you agree to accept **full responsibility** for your actions related to its use. Additionally, you agree **not** to hold any contributors to the RemnantChat project responsible for any result of your use of it. The developers of RemnantChat do not endorse illegal activity. diff --git a/package-lock.json b/package-lock.json index 76c7e2a..a57d13f 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { - "name": "chitchatter", + "name": "remnantchat", "version": "0.0.0", "lockfileVersion": 2, "requires": true, "packages": { "": { - "name": "chitchatter", - "version": "0.0.0", + "name": "remnantchat", + "version": "0.0.1", "license": "GPL-2.0-or-later", "dependencies": { "@emotion/react": "^11.10.0", diff --git a/public/CNAME b/public/CNAME index f4eee0e..10ef9ad 100644 --- a/public/CNAME +++ b/public/CNAME @@ -1 +1 @@ -chitchatter.im +remnant.chat \ No newline at end of file diff --git a/public/favicon.ico b/public/favicon.ico index 6c848a8..57ef990 100644 Binary files a/public/favicon.ico and b/public/favicon.ico differ diff --git a/public/index.html b/public/index.html index 6a6743f..b781931 100644 --- a/public/index.html +++ b/public/index.html @@ -24,7 +24,7 @@ work correctly both with client-side routing and a non-root public URL. Learn how to configure a non-root public URL by running `npm run build`. --> - Chitchatter + RemnantChat