Skip to content

TkTech/notifico

Repository files navigation

Notifico!

Notifico is a small open-source (MIT) replacement to the now-defunct (since 2012) cia.vc service. It relays webhooks from common services to IRC networks, such as GitHub, JIRA, Gitea, Jenkins, and Bitbucket.

Notifico is/has been used by CPython, FreeBSD, Godot, Qutebrowser, NASA, and thousands of other projects.

Development

Getting Started

The easiest way to get started with the codebase is with docker:

git clone https://github.com/TkTech/notifico.git
cd notifico
docker-compose up

This will start redis, postgres, IRC bots, and the frontend on port 5000. If you've never run Notifico before, also run:

docker-compose exec workers poetry run notifico tools bootstrap

This will populate the initial database. If you've run Notifico in the past, instead use:

docker-compose exec workers poetry run alembic upgrade head

And finally if you need a user to log in with, create your initial admin account with:

docker-compose exec workers poetry run notifico users create <username> <email>
docker-compose exec workers poetry run notifico users grant-role <username> admin

FAQ

Why doesn't this project use X?

Odds are X (like React or Typescript) didn't exist a decade ago when this project was created!

Is this project still maintained?

Yes! The project is currently going through modernization. It has remained largely unchanged for the last 8-9 years, as IRC and the services feeding into it are largely stable and unchanging themselves.