{"id":21625491,"url":"https://github.com/horgh/catbox","last_synced_at":"2025-04-11T12:37:41.443Z","repository":{"id":57516877,"uuid":"70290172","full_name":"horgh/catbox","owner":"horgh","description":"🐈📦 A small IRC server","archived":false,"fork":false,"pushed_at":"2019-10-27T22:06:54.000Z","size":718,"stargazers_count":31,"open_issues_count":0,"forks_count":3,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-03-25T08:51:24.521Z","etag":null,"topics":["chat","daemon","distributed-systems","irc","irc-server","ircd","server","tls"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/horgh.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"COPYING","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-10-07T23:37:27.000Z","updated_at":"2025-02-23T06:42:49.000Z","dependencies_parsed_at":"2022-09-12T23:21:41.975Z","dependency_job_id":null,"html_url":"https://github.com/horgh/catbox","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/horgh%2Fcatbox","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/horgh%2Fcatbox/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/horgh%2Fcatbox/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/horgh%2Fcatbox/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/horgh","download_url":"https://codeload.github.com/horgh/catbox/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248402430,"owners_count":21097331,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["chat","daemon","distributed-systems","irc","irc-server","ircd","server","tls"],"created_at":"2024-11-25T01:09:30.458Z","updated_at":"2025-04-11T12:37:41.411Z","avatar_url":"https://github.com/horgh.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"![catbox](doc/catbox-with-text.png)\n\n[![Build\nStatus](https://travis-ci.org/horgh/catbox.svg)](https://travis-ci.org/horgh/catbox)\n[![Go Report\nCard](https://goreportcard.com/badge/github.com/horgh/catbox)](https://goreportcard.com/report/github.com/horgh/catbox)\n\ncatbox is an IRC server with a focus on being small and understandable. The\ngoal is security.\n\n\n# Features\n* Server to server linking\n* IRC operators\n* Private (WHOIS shows no channels, LIST isn't supported)\n* Flood protection\n* K: line style connection banning\n* TLS\n\ncatbox implements enough of [RFC 1459](https://tools.ietf.org/html/rfc1459)\nto be recognisable as IRC and be minimally functional. I likely won't add\nmuch more and don't intend it to be complete. If I don't think something is\nrequired it likely won't be here.\n\n\n# Installation\n1. Download catbox from the Releases tab on GitHub, or build from source\n   (`go build`).\n2. Configure catbox through config files. There are example configs in the\n   `conf` directory. All settings are optional and have defaults.\n3. Run it, e.g. `./catbox -conf catbox.conf`. You might run it via systemd\n   via a service such as:\n\n```\n[Service]\nExecStart=/home/ircd/catbox/catbox -conf /home/ircd/catbox/catbox.conf\nRestart=always\n\n[Install]\nWantedBy=default.target\n```\n\n\n# Configuration\n\n## catbox.conf\nGlobal server settings.\n\n\n## opers.conf\nIRC operators.\n\n\n## servers.conf\nThe servers to link with.\n\n\n## users.conf\nPrivileges and hostname spoofs for users.\n\nThe only privilege right now is flood exemption.\n\n\n## TLS\nA setup for a network might look like this:\n\n* Give each server a certificate with 2 SANs: Its own hostname, e.g.\n  server1.example.com, and the network hostname, e.g. irc.example.com.\n* Set up irc.example.com with DNS round-robin listing each server's IP.\n* List each server by its own hostname in servers.conf.\n\nClients connect to the network hostname and verify against it. Servers\nconnect to each other by server hostname and verify against it.\n\n\n# Why the name?\nMy domain name is summercat.com, cats love boxes, and a tribute to\nircd-ratbox, the IRC daemon I used in the past.\n\n\n# Logo\ncatbox logo (c) 2017 Bee\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhorgh%2Fcatbox","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhorgh%2Fcatbox","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhorgh%2Fcatbox/lists"}