77 lines
1.6 KiB
Markdown
77 lines
1.6 KiB
Markdown
|
|
|
|
gitea-irc-bot
|
|
=============
|
|
|
|
  
|
|
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
### Webhook setup
|
|
|
|
You should setup the following webhooks on your Gitea instance:
|
|
|
|
1. `HOSTNAME:PORT/issue`
|
|
* MIME type: `application/json`
|
|
* Method: `POST`
|
|
* Enable "Custom Events":
|
|
* `Issues`
|
|
* `Issue Labeled`
|
|
* `Issue Comment`
|
|
* `Issue Milestoned`
|
|
* `Issue Assigned`
|
|
2. `HOSTNAME:PORT/commit`
|
|
* MIME type: `application/json`
|
|
* Method: `POST`
|
|
* Enable "Custom Events":
|
|
* `Push`
|
|
|
|
### Building
|
|
|
|
Simply clone the repository with:
|
|
|
|
```bash
|
|
git clone https://github.com/deavmi/gitea-irc-bot
|
|
```
|
|
|
|
Then run the following command to build the library:
|
|
|
|
```bash
|
|
cd gitea-irc-bot
|
|
dub build
|
|
```
|
|
|
|
### Configuring
|
|
|
|
You should have a `config.json` in the repository. You can now customize this to tweak settings for the bot.
|
|
|
|
An example configuration file can look as follows:
|
|
|
|
```json
|
|
{
|
|
"irc" : {
|
|
"host": "irc.freenode.net",
|
|
"port": 6667,
|
|
"nickname": "tlangbot",
|
|
"realname": "TLang Development Bot",
|
|
"channels": {
|
|
"tlang" : "#tlang",
|
|
"repoName" : "#destinationChannel"
|
|
}
|
|
},
|
|
"ntfy": {
|
|
"endpoint": "http://ntfy.sh",
|
|
"topic": "myTestFr"
|
|
}
|
|
}
|
|
```
|
|
|
|
You can run the program with `GIB_CONFIG=myConfig.json gitea-irc-bot` to specify a custom JSON configuration path other than the default.
|
|
|
|
## License
|
|
|
|
AGPL 3.0
|