1
0
mirror of https://github.com/pinpox/gitea-matrix-bot synced 2024-11-22 19:31:58 +01:00

added readme config info

This commit is contained in:
Pablo Ovelleiro Corral 2019-04-13 22:17:51 +02:00
parent b26d171522
commit e8171d206c
No known key found for this signature in database
GPG Key ID: F7C1D57C8464E825
2 changed files with 45 additions and 0 deletions

@ -1,3 +1,48 @@
# gitea-matrix-bot
A bot to listen for gitea webhooks and post to a matrix channel
# Usage
## Configuration
Copy config.ini.example to config.ini or creat a file called config.ini with the
following options:
```
[http]
# The path the listener will expect the post data
http_uri = "/post"
# The port the listener will listen on
http_port = "9000"
[matrix]
# The matrix server to connect to
matrix_host = "http://matrix.org"
# The matrix room to post to
matrix_room = "#my-awesome-room:matrix.org"
# User credentions of the bot for posting to the room
matrix_pass = "supersecretpass"
matrix_user = "my-awesome-bot"
```
Then start the bot. It will listen on the configured URI for incoming gitea
hooks.
## Create gitea hook
Create a new webhook in gitea. You an add a webhook to a single repository or
add a default webhook that will apply to all you repos (recommended)
- Choose the Webhook type `Gitea` for you Webhook
- Configure which events you want to send. You can also select `All Events`
- Set the Target URL to your host + the value you configured in the `config.ini` file. (e.g. `http://myserver:9000/post`)
- Make sure that port is reachable/forwarded if you are behind a router and
check your firewall
- Set `POST Content Type` to `applicatino/json`
- Add a secret (passphrase, password)
It will probably like this:
![gitea scrot](./gitea-scrot.png "Gitea Screenshot")

BIN
gitea-scrot.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 46 KiB