{"id":37386672,"url":"https://github.com/morria/fox","last_synced_at":"2026-01-16T05:21:55.319Z","repository":{"id":323696708,"uuid":"1094312197","full_name":"morria/fox","owner":"morria","description":null,"archived":false,"fork":false,"pushed_at":"2025-11-11T15:29:37.000Z","size":14,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-11-11T17:23:39.142Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/morria.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-11-11T14:44:29.000Z","updated_at":"2025-11-11T15:29:41.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/morria/fox","commit_stats":null,"previous_names":["morria/fox"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/morria/fox","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/morria%2Ffox","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/morria%2Ffox/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/morria%2Ffox/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/morria%2Ffox/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/morria","download_url":"https://codeload.github.com/morria/fox/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/morria%2Ffox/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28477236,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-16T03:13:13.607Z","status":"ssl_error","status_checked_at":"2026-01-16T03:11:47.863Z","response_time":107,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-01-16T05:21:54.655Z","updated_at":"2026-01-16T05:21:55.310Z","avatar_url":"https://github.com/morria.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Fox BBS\n\nA Python-based BBS (Bulletin Board System) for amateur radio \"fox hunting\" that connects to Direwolf TNC via the AGWPE protocol.\n\n## What is Fox BBS?\n\nFox BBS provides a real-time group chat system for amateur radio operators. Multiple stations can connect simultaneously via AX.25 and participate in a shared conversation. When users connect, they receive recent message history and can immediately start chatting with other connected stations.\n\n## Features\n\n- Real-time group chat for multiple amateur radio stations\n- Message history shown on connection (last 15 messages from 24 hours)\n- AGWPE protocol support for Direwolf TNC integration\n- Demo mode for testing without radio hardware\n- Thread-safe for concurrent connections\n- Fully type-hinted and well-tested codebase\n\n## Quick Start\n\n### Prerequisites\n\n- Python 3.7 or higher\n- Direwolf TNC with AGWPE enabled (or use demo mode)\n\n### Installation\n\n1. **Clone and navigate to the project:**\n```bash\ncd fox\n```\n\n2. **Create a virtual environment:**\n```bash\npython3 -m venv venv\nsource venv/bin/activate  # On Windows: venv\\Scripts\\activate\n```\n\n3. **Install dependencies:**\n```bash\npip install -r requirements.txt\n```\n\n4. **Generate Direwolf configuration (recommended):**\nFox BBS includes an automatic configuration wizard:\n```bash\n./generate_direwolf_config.py\n```\n\nThis wizard will:\n- Prompt for your callsign/SSID\n- Auto-detect your sound card\n- Generate `config/direwolf.conf` automatically\n\nAlternatively, you can create `config/direwolf.conf` manually (see docs/setup.md).\n\n5. **Configure the BBS:**\nEdit `config/fox.yaml` with your callsign (should match your Direwolf MYCALL):\n```yaml\nserver:\n  ssid: \"W2ASM-10\"                 # Your BBS callsign/SSID\n  direwolf_host: \"localhost\"       # Direwolf host\n  direwolf_port: 8000              # Direwolf AGWPE port\n  radio_port: 0                    # Radio port number\n```\n\n6. **Run the BBS:**\n\nFor demo mode (no hardware required):\n```bash\npython fox_bbs.py --demo\n```\n\nFor normal operation (Direwolf starts automatically):\n```bash\npython fox_bbs.py\n```\n\nFox BBS will automatically:\n- Check if Direwolf is running\n- Start Direwolf if needed\n- Monitor both processes\n- Shutdown gracefully if either process fails\n\nAlternatively, you can manually start Direwolf first:\n```bash\n# Terminal 1: Start Direwolf\n./direwolf\n\n# Terminal 2: Start Fox BBS\npython fox_bbs.py --no-auto-direwolf\n```\n\n## Usage\n\n### Command Line Options\n\n```bash\npython fox_bbs.py [OPTIONS]\n\nOptions:\n  --demo        Run in demo mode (no Direwolf required)\n  --config PATH Configuration file path (default: config/fox.yaml)\n  --debug       Enable debug logging\n  --help        Show help message\n```\n\n### What Users See\n\nWhen a station connects to the BBS:\n\n1. Welcome banner with the BBS SSID\n2. Recent message history (last 15 messages from 24 hours)\n3. A prompt (`W2ASM-10\u003e `) to type messages\n4. Real-time messages from other connected users\n\n## Running as a System Service\n\nFor production use on Linux systems, Fox BBS can run as a systemd service that starts automatically at boot and restarts on failures.\n\n**Supported platforms:**\n- Debian Trixie (13)\n- Raspbian OS (Debian Trixie variant)\n\n**Quick installation:**\n```bash\ncd systemd\nsudo ./install-service.sh\n```\n\n**Service management:**\n```bash\nsudo systemctl start fox-bbs    # Start the service\nsudo systemctl stop fox-bbs     # Stop the service\nsudo systemctl status fox-bbs   # Check status\nsudo journalctl -u fox-bbs -f   # View logs\n```\n\nSee **[systemd/README.md](systemd/README.md)** for complete documentation on:\n- Installation and configuration\n- Service management commands\n- Log viewing and troubleshooting\n- Failure handling\n- Security features\n\n## Documentation\n\n- **[Setup Guide](docs/setup.md)** - Detailed setup instructions for Direwolf and Fox BBS\n- **[Configuration](docs/configuration.md)** - Complete configuration reference\n- **[Development](docs/development.md)** - Development setup, testing, and contributing\n- **[Architecture](docs/architecture.md)** - Technical architecture and design\n- **[Troubleshooting](docs/troubleshooting.md)** - Common issues and solutions\n\n## Requirements\n\n- Python 3.7+\n- PyYAML 6.0+\n- pyham-pe 0.4.0+ (AGWPE protocol library)\n- Direwolf TNC with AGWPE enabled (for production use)\n\n## Project Structure\n\n```\nfox/\n├── fox_bbs.py              # Main entry point\n├── config/fox.yaml         # Configuration file\n├── src/                    # Source code\n│   ├── config.py           # Configuration management\n│   ├── message_store.py    # Message storage\n│   ├── agwpe_handler.py    # AGWPE protocol handler\n│   ├── ax25_client.py      # Client connection handler\n│   └── bbs_server.py       # Main server logic\n├── systemd/                # systemd service files\n│   ├── fox-bbs.service     # Service template\n│   ├── install-service.sh  # Installation script\n│   ├── uninstall-service.sh# Uninstallation script\n│   └── README.md           # Service documentation\n├── tests/                  # Test suite\n└── docs/                   # Documentation\n```\n\n## License\n\nThis software is provided as-is for amateur radio use.\n\n## Resources\n\n- [Direwolf Documentation](https://github.com/wb2osz/direwolf)\n- [AGWPE Protocol](http://www.elcom.gr/developer/agwpe.htm)\n- [AX.25 Protocol](https://www.tapr.org/pdf/AX25.2.2.pdf)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmorria%2Ffox","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmorria%2Ffox","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmorria%2Ffox/lists"}