https://github.com/2boom-ua/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.
https://github.com/2boom-ua/webntfy
docker docker-compose dockerfile flask javascript notification python3 requests self-hosted selfhosted selfhosting sqlite3 webntfy
Last synced: 2 months ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/2boom-ua/webntfy
- Owner: 2boom-ua
- Created: 2024-12-10T22:33:21.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-31T14:18:06.000Z (about 1 year ago)
- Last Synced: 2025-03-31T15:51:48.895Z (about 1 year ago)
- Topics: docker, docker-compose, dockerfile, flask, javascript, notification, python3, requests, self-hosted, selfhosted, selfhosting, sqlite3, webntfy
- Language: JavaScript
- Homepage:
- Size: 472 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## 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: Gunicorn, Flask, Requests
---
#### Docker Installation
### Dowload messages.db
```bash
curl -L -o ./messages.db https://raw.githubusercontent.com/2boom-ua/webntfy/main/messages.db
```
---
```bash
docker build -t webntfy .
```
or
```bash
docker pull ghcr.io/2boom-ua/webntfy:latest
```
### docker-cli
```bash
docker run -v ./messages.db:/webntfy/messages.db --name webntfy -p 5511:5511 -e TZ=UTC ghcr.io/2boom-ua/webntfy:latest
```
### docker-compose
```
services:
webntfy:
container_name: webntfy
image: ghcr.io/2boom-ua/webntfy:latest
environment:
- TZ=Etc/UTC
ports:
- 5511:5511
volumes:
- ./messages.db:/webntfy/messages.db
restart: unless-stopped
```
```bash
docker-compose up -d
```
---
### Running as a Linux Service
#### Clone the Repository
```bash
git clone https://github.com/2boom-ua/webntfy.git
cd webntfy
```
#### Install Required Python Packages
```bash
pip install -r requirements.txt
```
#### Create a systemd Service File
```bash
nano /etc/systemd/system/webntfy.service
```
Add the following content:
```ini
[Unit]
Description=WebNtfy
After=multi-user.target
[Service]
Type=simple
Restart=always
WorkingDirectory=/opt/webntfy
ExecStart=gunicorn -w 4 -b 0.0.0.0:5511 webntfy:app
[Install]
WantedBy=multi-user.target
```
#### Start and Enable the Service
```bash
systemctl daemon-reload
systemctl enable webntfy.service
systemctl start webntfy.service
```
---
### Start
**https://your_domain_name or http://server_ip:5511**
---
### [Usage examples for curl, wget, Python, PHP, JavaScript, JSON](usage.md)
---
### License
This project is licensed under the [MIT License](https://opensource.org/licenses/MIT).
---
### Author
- **2boom** - [GitHub](https://github.com/2boom-ua)