NotifyPub

Setup

Requires

• Docker

Instructions

• git clone https://github.com/imbev/NotifyPub.git
• Build Docker Image

  docker build -t notifypub .

• Run Docker Container

  docker run \
    --name notifypub \
    -d \
    -it \
    -p 8080:8080 \
    -e HOST='notifypub.example.com' \
    -e TITLE='NotifyPub' \
    -e ADMIN_PASSWORD='password' \
    -e SECRET_KEY='d5fb8c4fa8bd46638dadc4e751e0d68b' \
    -e DATABASE='sqlite:////data/notifypub.sqlite' \
    notifypub
  
  # Data isn't persistent unless volumes are used or the database is located elsewhere.

Non-Docker Setup

Requires

• python ^3.8
• make

Instructions

• git clone https://github.com/imbev/NotifyPub.git

• cd NotifyPub && make setup

• Create .env file or set environment variables to the following:

  • HOST
    • Base url of website
  • TITLE
    • Title for website
  • ADMIN_PASSWORD
    • Password for Admin to login to website
  • SECRET_KEY
    • Randomly generated secret key for security
  • DATABASE
    • Database connection url

  # .env
  HOST=notifypub.example.com
  TITLE=NotifyPub
  
  ADMIN_PASSWORD=password
  SECRET_KEY=d5fb8c4fa8bd46638dadc4e751e0d68b
  DATABASE=sqlite:////tmp/notifypub.sqlite
  

  • Run development server
    • make dev
  • Run production server
    • make prod

Copyright (c) Isaac Beverly 2022, AGPL-3.0-only