# Froggi

Froggi is a self-hosted, portable overlay that displays live game graphics and information as a scoreboard for sports broadcasting. It is open source and self-hosted, installable on Docker Hub and Unraid.

Canonical page: https://ourlocalhost.com/app/2467/froggi

## Description

Froggi is a self-hosted, portable overlay that displays live game graphics and information as a scoreboard for sports broadcasting. It supports optical character recognition (OCR) score capture, API key authentication for HTTP integrations such as Bitfocus Companion, transferable team presets, and an optional sponsor logo slideshow. It suits streamers and hobby broadcasters who want a simple, intuitive scoreboard for their live sports coverage.

## Platform availability

Available on 1 of 10 platforms: Unraid.

## Health score

30/100 (Low), based on 5 of 5 factors.
- Maintained: 11 (last commit 618 days ago)
- Popular: 22 (12 GitHub stars)
- Easy to install: 35 (1 install platform, install notes, Docker image)
- Light to run: 50 (2 GB minimum RAM)
- Security check: 60 (no serious findings, 6 minor, CI)

## Links

- Docker Hub: https://hub.docker.com/r/obfedder/froggi
- Unraid: https://ca.unraid.net/apps/froggi-06ng3q30c8hftr?q=Froggi

## Common questions

### How do I map ports when running Froggi in Docker?

Define the port with -p external:internal and change only the external value. The example binds external port 80 to internal port 3000, and Froggi is reachable on the external port you chose.

### Which executable should I start for a standalone Froggi install?

Run the froggi binary, not the froggi-worker binary. If using Docker, start the container instead.

### How can I authenticate API requests to Froggi?

Froggi supports authentication through an API key sent in an HTTP header. This is intended for use with Bitfocus Companion and other HTTP use cases.

### Which Docker image should I use for stable versus latest builds?

Docker images are built for every stable release. The latest image always contains the latest commit on the main branch.

### How do I apply changes to Froggi’s specialized configuration?

Modify config.json, which is generated automatically after the first run. Changes are applied after restarting Froggi, and the Settings page includes program controls for restart and stop.

---
Source: Our Local Host (https://ourlocalhost.com/app/2467/froggi), the self-hosted and open-source app directory.
