echo-pulse

command module
v0.0.0-...-f6d2827 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 12, 2023 License: GPL-2.0 Imports: 5 Imported by: 0

README

Echo Pulse - UDP Echo Server

echo-pulse is a simple UDP echo server that logs incoming messages and echoes them back to the client. It comes with unique IP tracking and string blacklist features. Easily configurable and set up with systemd for auto-start on system boot.

Features

  • UDP Echoing: Reflects incoming UDP messages back to the client.
  • Unique IP Logging: Logs unique IPs that connect to the server.
  • String Blacklist: Blocks and doesn't echo back specific blacklisted strings.
  • Easy Configuration: Uses a TOML config for easy setup.

Prerequisites

  • Go 1.16+ or newer
  • Systemd (for auto-start on boot)
  • Proper permissions (for installing to /usr/bin and managing systemd services)

Installation

  1. Clone the Repository:

    git clone https://github.com/SiirRandall/echo-pulse.git
    cd echo-pulse
    
  2. Run the Installation Script:

    sudo ./install.sh
    
  3. Configure the Service:

    • Edit the configuration file located at /etc/echopulse/config.conf to your needs.
    • The default configuration should work for most setups.
  4. Start the Service

    sudo systemctl start echo-pulse.service
    
  5. Optional) Enable Auto-Start at Boot:

    sudo systemctl enable echo-pulse.service
    

Uninstallation

To remove echo-pulse, simply run the provided uninstall script:

sudo ./uninstall.sh

Logging

You can access the logs in the default location /var/logs/echopuls/ This can be changed in /etc/echopulse/config.conf

Contributing

Interested in contributing? Please fork the repository and use a feature branch. All pull requests are welcome!

Licensing

This project is licensed under the GNU General Public License, version 2 License. See the LICENSE file for more details.

Documentation

Overview

This is the main package

Directories

Path Synopsis
The config package holds configuration-related operations and structures
The config package holds configuration-related operations and structures
Logger package facilitates logging operations
Logger package facilitates logging operations
This is the server package
This is the server package

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL