Git-Mirrors/lxmf_messageboard
1
0
Fork 0
mirror of https://github.com/markqvist/lxmf_messageboard.git synced 2024-10-01 02:25:36 -04:00
Code Issues Actions Packages Projects Releases Wiki Activity
Simple message board that can be hosted on a NomadNet node, messages can be posted by 'conversing' with a unique peer, all messages are then forwarded to the message board.
16 Commits 1 Branch 0 Tags 1.3 MiB
Python 86.7%
mupad 13.3%
36102e53f3
Go to file
chengtripp 36102e53f3
Simple Script to add user addresses to the allowed list
2023-02-06 21:39:49 +00:00
admin Simple Script to add user addresses to the allowed list 2023-02-06 21:39:49 +00:00
docs/images Add files via upload 2023-02-01 11:00:24 +00:00
pages removed redis dependency, now uses umsgpack 2023-02-03 21:06:52 +00:00
license Create license 2023-01-31 22:59:25 +00:00
messageboard.py Added allow list (default off) 2023-02-06 21:37:32 +00:00
README.md Update README.md 2023-02-03 21:18:03 +00:00

README.md

lxmf_messageboard

Simple message board that can be hosted on a NomadNet node, messages can be posted by 'conversing' with a unique peer, all messages are then forwarded to the message board.

How Do I Use It?

A user can submit messages to the message board by initiating a chat with the message board peer, they are assigned a username (based on the first 5 characters of their address) and their messages are added directly to the message board. The message board can be viewed on a page hosted by a NomadNet node.

An example message board can be found on the reticulum testnet hosted on the SolarExpress Node <d16df67bff870a8eaa2af6957c5a2d7d> and the message board peer <ad713cd3fedf36cc190f0cb89c4be1ff>

Screenshot

How Does It Work?

The message board page itself is hosted on a NomadNet node, you can place the message_board.mu into the pages directory. You can then run the message_board.py script which provides the peer that the users can send messages to. The two parts are joined together using umsgpack and a flat file system similar to NomadNet and Reticulum and runs in the background.

How Do I Set It Up?

  • Turn on node hosting in NomadNet
  • Put the message_board.mu file into pages directory in the config file for NomadNet. Edit the file to customise from the default page.
  • Run the message_board.py script (python3 message_board.py either in a screen or as a system service), this script uses NomadNet and RNS libraries and has no additional libraries that need to be installed. Take a note of the message boards address, it is printed on starting the board, you can then place this address in message_board.mu file to make it easier for users to interact the board.

Credits

  • The send and receive functions in message_board.py are based on examples posted on the Reticulum Matrix channel by Mark