diff --git a/.github/workflows/beta-server-image.yml b/.github/workflows/beta-server-image.yml new file mode 100644 index 0000000..25ae743 --- /dev/null +++ b/.github/workflows/beta-server-image.yml @@ -0,0 +1,75 @@ +name: Beta Server Image + +# Publishes the relay server as a Docker image under NON-production tags so a +# feature branch can be deployed to a staging/backup server and used as a custom +# server, without ever touching the ':latest' tag the official relay tracks. +# +# Tags produced (on ghcr.io//): +# - beta moving channel pointer to the newest build +# - e.g. feature-host-control-mode +# - sha- immutable, pin to an exact build +# - only on manual run, e.g. hostcontrol01 +# Never ':latest' (flavor: latest=false). +# +# Remove this workflow once the feature is merged & released the normal way. + +on: + push: + branches: + - feature/host-control-mode + workflow_dispatch: + inputs: + tag: + description: 'Extra immutable tag for this build (e.g. hostcontrol01). Optional.' + required: false + default: '' + +concurrency: + group: beta-image-${{ github.ref }} + cancel-in-progress: true + +jobs: + build-beta-image: + runs-on: ubuntu-latest + permissions: + contents: read + packages: write + steps: + - name: Checkout code + uses: actions/checkout@v7 + + - name: Set up Docker Buildx + uses: docker/setup-buildx-action@v4 + + - name: Log in to GitHub Container Registry + uses: docker/login-action@v4 + with: + registry: ghcr.io + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + + - name: Extract Docker metadata + id: meta + uses: docker/metadata-action@v6 + with: + images: ghcr.io/${{ github.repository }} + # Never publish ':latest' from a beta build. + flavor: | + latest=false + tags: | + type=raw,value=beta + type=ref,event=branch + type=sha,prefix=sha- + type=raw,value=${{ github.event.inputs.tag }},enable=${{ github.event_name == 'workflow_dispatch' && github.event.inputs.tag != '' }} + + - name: Build and push Docker image + uses: docker/build-push-action@v7 + with: + context: . + file: server/Dockerfile + push: true + platforms: linux/amd64,linux/arm64 + tags: ${{ steps.meta.outputs.tags }} + labels: ${{ steps.meta.outputs.labels }} + cache-from: type=gha + cache-to: type=gha,mode=max diff --git a/.gitignore b/.gitignore index 65830fc..c0b6b82 100644 --- a/.gitignore +++ b/.gitignore @@ -27,6 +27,7 @@ Thumbs.db # IDEs .vscode/ .idea/ +.claude/ *.swp *.swo diff --git a/SECURITY.md b/SECURITY.md index 4db6145..2f0ef79 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -82,6 +82,12 @@ KoalaSync's security is grounded in its architecture: If you find a way to bypass any of these protections, we want to know about it. +> [!NOTE] +> Some frequently-reported "issues" are **intentional and out of scope** for our +> threat model (ephemeral, account-less rooms of invited participants) — e.g. an +> unauthenticated `peerId` or non-constant-time room-password compare. Before +> reporting, please read **[`docs/KNOWN_LIMITATIONS.md`](docs/KNOWN_LIMITATIONS.md)**. + --- ## Responsible Disclosure diff --git a/assets/MarketingCopy.md b/assets/MarketingCopy.md new file mode 100644 index 0000000..b7c2d5d --- /dev/null +++ b/assets/MarketingCopy.md @@ -0,0 +1,66 @@ +# KoalaSync — Marketing Copy Kit + +Ready-to-paste copy for product listings, launch pages, directory submissions, and anywhere else you keep re-typing the same pitch. Three lengths, one consistent message. Pick the one that fits the field limit. + +--- + +## 1. One-Sentence Pitch + +> KoalaSync is a privacy-first browser extension that synchronizes video playback across almost any website so you can watch with friends in real time — no accounts, no tracking, and your video never passes through anyone's server but the original site's. + +**Shorter alternative** (for tight tagline fields): + +> Private, universal watch parties on any website — no accounts, no tracking, no media proxying. + +--- + +## 2. Three-Sentence Overview + +> KoalaSync is a lightweight browser extension that keeps you and your friends perfectly in sync on YouTube, Netflix, Twitch, Prime Video, Jellyfin, Emby, and almost any other site with an HTML5 video player — press play once and everyone stays together. It's built privacy-first: no accounts, no telemetry, and the official relay server runs entirely in volatile RAM with zero persistence, so nothing about your sessions is ever stored. Open source under the MIT license and fully self-hostable with a single Docker command, KoalaSync is a transparent watch-party tool that works everywhere and respects your data sovereignty. + +--- + +## 3. Full Description + +### Watch together — on any site, on your terms. + +Counting down "3, 2, 1, play" over voice chat doesn't scale past two people. KoalaSync fixes that with a tiny browser extension that synchronizes play, pause, and seeking across everyone in the room, on almost any website with a `