Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dannixon/matrix-dapnet-bot

Matrix bot that allows you to send pages over DAPNET
https://github.com/dannixon/matrix-dapnet-bot

amateur-radio chatbot dapnet ham-radio matrix-chat pocsag

Last synced: 7 days ago
JSON representation

Matrix bot that allows you to send pages over DAPNET

Host: GitHub
URL: https://github.com/dannixon/matrix-dapnet-bot
Owner: DanNixon
License: mit
Created: 2022-03-01T20:30:15.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2024-07-23T08:56:49.000Z (4 months ago)
Last Synced: 2024-07-23T10:58:59.881Z (4 months ago)
Topics: amateur-radio, chatbot, dapnet, ham-radio, matrix-chat, pocsag
Language: Rust
Homepage:
Size: 310 KB
Stars: 2
Watchers: 3
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE.txt

Awesome Lists containing this project

README

        # matrix-dapnet-bot

[![CI](https://github.com/DanNixon/matrix-dapnet-bot/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/DanNixon/matrix-dapnet-bot/actions/workflows/ci.yml)

[![dependency status](https://deps.rs/repo/github/dannixon/matrix-dapnet-bot/status.svg)](https://deps.rs/repo/github/dannixon/matrix-dapnet-bot)

Matrix bot that allows you to send pages over [DAPNET](https://www.hampager.de/).

## Usage

See `matrix-dapnet-bot --help`.

An example configuration file is provided [here](./examples/config.toml).

## Deployment

A container image is published.

Use it however you like.

e.g. via Podman:

```sh

podman run \

  --rm -it \

  -e RUST_LOG=debug \

  -e DAPNET_USERNAME="" \

  -e DAPNET_PASSWORD="" \

  -e MATRIX_USERNAME="@:matrix.org" \

  -e MATRIX_PASSWORD="" \

  -v ./examples:/config \

  ghcr.io/DanNixon/matrix-dapnet-bot:latest

```

## Permissions/Authentication

For sending private pages/messages/calls the bot ensures that the sender holds a valid amateur radio license.

This is done by checking the configuration file.

For sending news to a rubric the bot checks that both the sender and bot operator are owners of the rubric.

This preserves the expected access control of only rubric owners being able to publish to them.

This does, however, mean that only rubrics that the bot operator owns can be published to, regardless of the rubrics any other user of the bot owns.

All in all, it is a bit of a hack, but good enough for what it was developed for and better than having to handle credentials for all bot users.

In all cases the owner (sender) of any private messages and rubric news messages will be shown to be the bot operator.