Giter VIP home page Giter VIP logo

notifypub's Introduction

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

notifypub's People

Contributors

imbev avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.