{"id":18525695,"url":"https://github.com/hakobe/homura","last_synced_at":"2025-06-19T10:37:31.196Z","repository":{"id":8988623,"uuid":"10736582","full_name":"hakobe/homura","owner":"hakobe","description":"an IRC bouncer written in JavaScript for Node.js","archived":false,"fork":false,"pushed_at":"2014-09-19T12:28:50.000Z","size":515,"stargazers_count":54,"open_issues_count":3,"forks_count":7,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-06-11T15:21:08.030Z","etag":null,"topics":["irc","javascript"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/hakobe.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}},"created_at":"2013-06-17T12:13:30.000Z","updated_at":"2020-06-05T07:36:21.000Z","dependencies_parsed_at":"2022-09-11T02:50:35.012Z","dependency_job_id":null,"html_url":"https://github.com/hakobe/homura","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/hakobe/homura","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hakobe%2Fhomura","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hakobe%2Fhomura/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hakobe%2Fhomura/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hakobe%2Fhomura/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hakobe","download_url":"https://codeload.github.com/hakobe/homura/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hakobe%2Fhomura/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260733885,"owners_count":23054356,"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":["irc","javascript"],"created_at":"2024-11-06T17:46:43.552Z","updated_at":"2025-06-19T10:37:26.180Z","avatar_url":"https://github.com/hakobe.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Build Status](https://travis-ci.org/hakobe/homura.png?branch=master)](https://travis-ci.org/hakobe/homura)\n\n# homura\n\nThis is a IRC bouncer written in JavaScript for Node.js. The name \"homura\" is from [madoka](http://www.madoka.org/) which is the IRC bouncer I used first ;)\n\nThis project is under *DEVELOPMENT*. APIs are unstable and some features have not implemented yet.\n\n## Synopsis\n\n```sh\n$ cd homura_workingdir\n$ npm install homura\n$ vim config.json # see Configuration section\n$ ./node_modules/.bin/homura -v\n```\n\nTo connect to homura with your IRC client, use the host and the port configured in `config.json`.\nYou have to set the IRC user name like `USERNAME@BOUNCERNAME`. (e.g. `akemi@freenode` or `akemi@ircnet` )\n\n`USERNAME` is an actual user name for IRC networks, \nand `BOUNCERNAME` is a name that homura uses to decide which IRC network connect to.\n\n\n## Install\n\n```sh\n$ npm install -g homura\n```\n\n## Configuration\n\nhomura uses a JSON format configuration file.\n\nThe default path of the configuration file is `config.json` of current directry \nthat homur is running on, and you can also specify `config.json` by using \n`--config` option.\n\n```sh\n$ homura --config /path/to/your_config.json\n```\n\n`config.json` defines options below:\n\n- `host` (required) : Host the client should connect to homura\n- `port` (required) : Port the client should connect to homura\n- `password` (optional) : Password that is required to connect to homura\n- `tls` (optional) : With this option, the client should connect to homura using TLS. The passed Object \n                     should be used for `tls.createServer` options directry.\n                     For `key`, `cert`, `ca` and `pfx` options, you can pass the file path by appending\n                    `_file` to the option name like `key_path`.\n- `bouncers` (required) : An Array of IRC bouncer settings.\n    - `name` (required) : name to identify network. You can connect this network with `USERNAME@{name}`\n    - `host` (required) : IRC server host\n    - `port` (required) : IRC server port\n    - `nick` (required) : IRC nick\n    - `user` (optional) : IRC user. Default is the same as the nick\n    - `real` (optional) : IRC real name. Default is the same as the nick\n    - `encoding` (optional) : The character encoding used on this IRC network. Default is `UTF-8`\n    - `tls` (optional) : With this option, homura makes the connection to IRC network using TLS.\n                         The passed Object should be used for `tls.connect` options directry.\n                         For `key`, `cert`, `ca` and `pfx` options, you can pass the file path by appending\n                         `_file` to the option name like `key_path`.\n\n\n\n### config.json (sample)\n```javascript\n{\n    \"host\" : \"localhost\",\n    \"port\" : 6667,\n    \"password\" : \"YOURPASSWORD\",\n    \"tls\" : {\n        \"key_file\"  : \"/absolute/path/to/your/privatekey.pem\",\n        \"cert_file\" : \"/absolute/path/to/your/cetificate.pem\",\n        // and you can put tls.createServer options here.\n    },\n    \"bouncers\" : [\n        {\n            \"name\"     : \"freenode\",\n            \"host\"     : \"hubbard.freenode.net\",\n            \"port\"     : 7000,\n            \"nick\"     : \"YOURNICK\",\n            \"user\"     : \"YOURUSER\",\n            \"real\"     : \"YOURNAME\",\n            \"encoding\" : \"UTF-8\",\n            \"tls\"      : {\n              \"ca_file\"  : \"/absolute/path/to/your/ca.pem\",\n              // and you can put tls.connect options here.\n            }\n        },\n        {\n            \"name\"     : \"ircnet\",\n            \"encoding\" : \"ISO-2022-JP\",\n            \"host\"     : \"irc.media.kyoto-u.ac.jp\",\n            \"port\"     : 6667,\n            \"nick\"     : \"YOURNICK\",\n            \"user\"     : \"YOURUSER\",\n            \"real\"     : \"YOURNAME\",\n        }\n    ],\n    \"modules\" : [\n        {\n            \"name\" : \"log\",\n            \"dir\"  : \"/path/to/logs\"\n        },\n        {\n            \"name\" : \"log-buffer\",\n            \"size\" : 100\n        },\n        {\n            \"name\" : \"auto-join\",\n            \"channels\" : {\n                \"freenode\" : [ \"#autojoinchan1 passwordchan1\", \"#autojoinchan2\" ],\n                \"ircnet\"   : [ \"#autojoinchan3\" ]\n            }\n        },\n        {\n            \"name\" : \"auto-reply\"\n        },\n        {\n            \"name\" : \"auto-away\",\n            \"message\" : \"oh I'm away from a keyborad\"\n        },\n        {\n            \"name\" : \"away-nick\",\n            \"awayNick\" : \"YOURNICK_AWAY\"\n        },\n        {\n            \"name\"     : \"auto-nickserve-identify\",\n            \"passwords\" : {\n                \"freenode\" : \"PASSWORD\"\n            }\n        }\n    ]\n}\n```\n\n## Run\n\nStart the homura with `config.json` in current directory.\n\n```sh\n$ homura\n```\n\nor specify `config.json` by `--config` option.\n\n```sh\n$ homura --config /path/to/your_config.json\n```\n\nPlease specify `-v` or `--verbose` options to see what the homura is doing.\n`--debug` may be too noisy (prints the same IRC messages 4 times...) .\n\n```sh\n$ homura -v\n$ homura --debug\n```\n\n## Modules\n\nModules are placed under `modules` directory. You can enable modules and can pass options to modules in `config.json`. Please see Configuration section.\n\n### log \nWrites out logs to files.\n\n#### Options\n- dir : Directory to save log files in\n- format : Format of the log filename (e.g. `{bouncer}-{channel}-{year}{month}{date}.log` )\n\n### log-buffer\nBuffres conversation logs for each target (channel or user), and sends logs as notice when you connect to homura.\n\n#### Options\n- size : Buffer size of logs\n\n### auto-join\nJoins to specified channels when homura has connected to network.\n\n#### Options\n- channels : Object that maps network-name-key to Array of channel name to join.\n\n### auto-reply\nReplies a message automatically while you are not connected to homura.\n\n#### Options\n- message : Message to reply\n\n### auto-away\nSends AWAY message automatically when all clients disconnected.\n\n#### Options\n- message : AWAY message\n\n### away-nick\nChanges nick automatically when you AWAY\n\n#### Options\n- awayNick : Nick name when you are AWAY\n\n### auto-nickserve-identify\nSend NickServe Identify command automatically at start of connection\n\n#### Options\n- passwords : Object that contains bouncer name and password pairs.\n\n## Author\n- @hakobe\n\n## License\n\nLicensed under the MIT License\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhakobe%2Fhomura","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhakobe%2Fhomura","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhakobe%2Fhomura/lists"}