Skip to content

A simple server for sending and receiving messages. It allows users to post new messages, view existing messages and delete messages as needed. This server can work in a local network without the need for an Internet connection and does not require registration.

Notifications You must be signed in to change notification settings

2boom-ua/webntfy

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

50 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

WebNtfy

A simple server for sending and receiving messages. It allows users to post new messages, view existing messages and delete messages as needed. This server can work in a local network without the need for an Internet connection and does not require registration.

Requirements

  • Python 3.X or higher
  • Dependencies: Flask, Requests

Installation

Clone the Repository

git clone https://github.com/2boom-ua/webntfy.git
cd webntfy

Docker

touch messages.db

docker-cli

docker build -t webntfy:latest .
docker run -d \
  --name webntfy \
  --env TZ=UTC \
  -p 5511:5511 \
  -v $(pwd)/messages.db:/webntfy/messages.db \
  --restart always \
  webntfy:latest

docker-compose

version: "3.8"
services:
  webntfy:
    build:
      context: .
      dockerfile: Dockerfile
    container_name: webntfy
    image: webntfy:latest
    environment:
      - TZ=UTC
    ports:
      - 5511:5511
    volumes:
      - ./messages.db:/webntfy/messages.db
    restart: always
    healthcheck:
      test: ["CMD", "curl", "--fail", "http://localhost:5511/health"]
      interval: 30s
      timeout: 5s
      retries: 3
docker-compose up -d

Running as a Linux Service

Install Required Python Packages

pip install -r requirements.txt

Create a systemd Service File

nano /etc/systemd/system/webntfy.service

Add the following content:

[Unit]
Description=WebNtfy
After=multi-user.target

[Service]
Type=simple
Restart=always
ExecStart=/usr/bin/python3 /opt/webntfy/webntfy.py

[Install]
WantedBy=multi-user.target

Start and Enable the Service

systemctl daemon-reload
systemctl enable webntfy.service
systemctl start webntfy.service

Start

https://your_domain_name or http://server_ip:5511



License

This project is licensed under the MIT License.


Author

About

A simple server for sending and receiving messages. It allows users to post new messages, view existing messages and delete messages as needed. This server can work in a local network without the need for an Internet connection and does not require registration.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published