PlingDing

This is a Rust application that sends push notifications via multiple providers, including Pushover and ntfy. It can be used from the command line to send messages with optional priority and image attachments.

Prerequisites

1. Rust and Cargo installed on your system (for building from source)
2. Accounts with supported push notification services (e.g., Pushover, ntfy)

Setup

1. Clone this repository
2. Navigate to the project directory
3. Set up your configuration file (see Configuration section below)

Configuration

PlingDing uses a YAML configuration file. You can place your configuration file in one of the following locations:

• ~/.plingding.yaml
• ~/.config/plingding/plingding.yaml
• ./plingding.yaml (in the current working directory)

Create a file named plingding.yaml in one of these locations with the following content:

providers:
  - name: "pushover_personal"
    provider_type: "pushover"
    api_key: "your_pushover_api_key_here"
    user_key: "your_pushover_user_key_here"
    default: true

  - name: "ntfy_work"
    provider_type: "ntfy"
    api_key: "your_ntfy_api_key_here"
    base_url: "https://ntfy.sh/your_topic"
    default: true

  # Add more providers as needed

Replace the placeholder values with your actual API keys and other required information.

Provider Types

1. Pushover:

   • Required fields: name, provider_type (set to "pushover"), api_key, user_key
   • Optional fields: default (set to true if you want this provider to be used by default)

2. ntfy:

   • Required fields: name, provider_type (set to "ntfy"), api_key, base_url
   • Optional fields: default (set to true if you want this provider to be used by default)

You can add multiple providers of the same type with different configurations.

Building from Source

To build the application for your current platform, run:

cargo build --release

The compiled binary will be available in target/release/plingding.

For an optimized and smaller binary, you can use the strip command after building:

strip target/release/plingding

This will remove debug symbols from the binary, significantly reducing its size.

Cross-Platform Compilation

PlingDing supports cross-platform compilation for Linux and Windows from a Linux host. To build for these platforms, follow these steps:

1. Install the cross tool:

   cargo install cross
   

2. Install the required target:

   rustup target add x86_64-pc-windows-gnu
   

3. Run the build script:

   chmod +x build.sh
   ./build.sh
   

This will create binaries for Linux and Windows in the releases directory.

Creating Releases

Follow these steps:

1. Update the version number in Cargo.toml and PKGBUILD.
2. Commit all changes and push to the repository.
3. Create a new git tag for the release:

   git tag -a v0.x.x -m "Release v0.x.x"
   

4. Push the tag:

   git push origin v0.x.x
   

5. Run the build script on a Linux system to create binaries for Linux and Windows:

   ./build.sh
   

6. Build the macOS version on a macOS system as described in the "Building for macOS" section.
7. Create a new release on GitHub, upload the binaries for all three platforms, and publish the release.

Installing from AUR (Arch User Repository)

If you're using an Arch-based Linux distribution, you can install PlingDing from the AUR using one of the following methods:

Using an AUR Helper

1. Make sure you have an AUR helper installed (e.g., yay, paru)

2. Run the following command:

   yay -S plingding
   

   Replace yay with your preferred AUR helper if different.

3. Follow the prompts to install the package

Manual Installation

If you prefer not to use an AUR helper, you can manually install plingding from the AUR:

1. Make sure you have the necessary tools installed:

   sudo pacman -S --needed base-devel git
   

2. Clone the AUR package repository:

   git clone https://aur.archlinux.org/plingding.git
   cd plingding
   

3. Build and install the package:

   makepkg -si
   

   This command will download the source, build the package, and install it. The -si flags mean it will install any needed dependencies and then install the built package.

4. If you want to review the PKGBUILD before building, you can open it in a text editor and then run makepkg -si when you're ready to proceed.

After installation using either method, the plingding command will be available system-wide.

Usage

plingding [OPTIONS] --message <MESSAGE>

Options:

• -m, --message <MESSAGE>: The message to send (required)
• -p, --priority <PRIORITY>: The priority of the message (-2 to 2, default: 0)
• -i, --image <IMAGE>: The path to an image to attach (optional)
• --providers <PROVIDERS>: Comma-separated list of provider names to use (optional, uses default providers if not specified)

Examples

1. Send a simple message using default providers:

   plingding -m "Hello, World!"
   

2. Send a message with high priority to specific providers:

   plingding -m "Urgent message" -p 2 --providers pushover_personal,ntfy_work
   

3. Send a message with an attached image:

   plingding -m "Check out this image" -i /path/to/image.jpg
   

Note

Make sure to set up your configuration file as described in the Configuration section before running the application. If the configuration file is not found or is invalid, the application will return an error message.

Platform-Specific Notes

• Linux: The application should work out of the box on most Linux distributions.
• Windows: When using the Windows binary, make sure to place your configuration file in one of the specified locations.
• macOS: The macOS binary should work similarly to the Linux version. Ensure you've built it on a macOS system as described in the "Building for macOS" section.