Self-hosted ntfy server, delivering notifications to KGPians
Website
·
Request Feature / Report Bug
Narada (Sanskrit: नारद, IAST: Nārada), or Narada Muni, is a sage-divinity, famous in Hindu traditions as a travelling musician and storyteller, who carries news and enlightening wisdom (source). Our naarad serves news (notices) to the KGP community. It is a self-hosted ntfy.sh instance with custom configuration. It is protected by heimdall, allowing access only to KGPians.
Following are the features enabled in this ntfy instance (refer server.yml):
To make the user registration process as seamless as possible we have implemented a custom logic (frontend & backend). The frontend is hosted via github pages with the url - https://naarad-signup.metakgp.org, mapped to https://naarad.metakgp.org/signup. The logic is as follows:
username
: Taken from their institute emailpassword
: Auto generated[!Tip] To understand the full process of accessing the service, refer Subscription Instruction guide.
To set up a local instance of the application, follow the steps below.
The following dependencies are required to be installed for the project to function properly:
Now that the environment has been set up and configured to properly compile and run the project, the next step is to install and configure the project locally on your system.
git clone https://github.com/metakgp/naarad.git
.env.example
as .env
and fill in the required valuessudo docker compose build
sudo docker compose up -d
http://localhost:8000/
The currently active maintainer(s) of this project.
Honoring the original creator(s) and ideator(s) of this project.