Skip to content

Commit 0ad0647

Browse files
kc1awvkc1awv
committed
refact, separate and merge
1 parent 107cea7 commit 0ad0647

14 files changed

+374
-1791
lines changed

‎.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
*.log
44
*.db
55
*.pem
6+
defunct/
67

78
# Byte-compiled / optimized / DLL files
89
__pycache__/

‎CODE_OF_CONDUCT.md

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Code of Conduct - RetiBBS
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
6+
7+
## Our Standards
8+
9+
Examples of behaviour that contributes to a positive environment for our community include:
10+
11+
* Demonstrating empathy and kindness toward other people
12+
* Being respectful of differing opinions, viewpoints, and experiences
13+
* Giving and gracefully accepting constructive feedback
14+
* Accepting responsibility and apologising to those affected by our mistakes, and learning from the experience
15+
* Focusing on what is best not just for us as individuals, but for the overall community
16+
17+
Examples of unacceptable behaviour include:
18+
19+
* The use of sexualised language or imagery, and sexual attention or advances
20+
* Trolling, insulting or derogatory comments, and personal or political attacks
21+
* Public or private harassment
22+
* Publishing others' private information, such as a physical or email address, without their explicit permission
23+
* Other conduct which could reasonably be considered inappropriate in a professional setting
24+
25+
## Our Responsibilities
26+
27+
Project maintainers are responsible for clarifying and enforcing our standards of acceptable behaviour and will take appropriate and fair corrective action in response to any instances of unacceptable behaviour.
28+
29+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviours that they deem inappropriate, threatening, offensive, or harmful.
30+
31+
## Scope
32+
33+
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
34+
35+
## Enforcement
36+
37+
Instances of abusive, harassing, or otherwise unacceptable behaviour may be reported to the community leaders responsible for enforcement at <yxahvdxf@4wrd.cc>. All complaints will be reviewed and investigated promptly and fairly.
38+
39+
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
40+
41+
## Attribution
42+
43+
This Code of Conduct is adapted from the [Contributor Covenant](https://contributor-covenant.org/), version
44+
[1.4](https://www.contributor-covenant.org/version/1/4/code-of-conduct/code_of_conduct.md) and
45+
[2.0](https://www.contributor-covenant.org/version/2/0/code_of_conduct/code_of_conduct.md),
46+
and was generated by [contributing-gen](https://github.com/bttger/contributing-gen).

‎CONTRIBUTING.md

+111
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
<!-- omit in toc -->
2+
# Contributing to RetiBBS
3+
4+
First off, thanks for taking the time to contribute! ❤️
5+
6+
All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉
7+
8+
> And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
9+
> - Star the project
10+
> - Tweet about it
11+
> - Refer this project in your project's readme
12+
> - Mention the project at local meetups and tell your friends/colleagues
13+
14+
<!-- omit in toc -->
15+
## Table of Contents
16+
17+
- [Code of Conduct](#code-of-conduct)
18+
- [I Have a Question](#i-have-a-question)
19+
- [I Want To Contribute](#i-want-to-contribute)
20+
- [Reporting Bugs](#reporting-bugs)
21+
- [Suggesting Enhancements](#suggesting-enhancements)
22+
23+
## Code of Conduct
24+
25+
This project and everyone participating in it is governed by the
26+
[RetiBBS Code of Conduct](https://github.com/kc1awv/RetiBBS/CODE_OF_CONDUCT.md).
27+
By participating, you are expected to uphold this code. Please report unacceptable behavior
28+
to <yxahvdxf@4wrd.cc>.
29+
30+
## I Have a Question
31+
32+
Before you ask a question, it is best to search for existing [Discussions](https://github.com/kc1awv/RetiBBS/discussions) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.
33+
34+
If you then still feel the need to ask a question and need clarification, we recommend the following:
35+
36+
- Start a [Discussion](https://github.com/kc1awv/RetiBBS/discussions/new/choose).
37+
- Provide as much context as you can about what you're running into.
38+
- Provide project and platform versions, depending on what seems relevant.
39+
40+
We will then take care of the issue as soon as possible.
41+
42+
## I Want To Contribute
43+
44+
> ### Legal Notice <!-- omit in toc -->
45+
> When contributing to this project, you must agree that you have soleley authored the content, that you have the necessary rights to the content, that the content you contribute will transfer copyright to the RetiBBS development team, and the contribution will be released under the project licence.
46+
47+
### Reporting Bugs
48+
49+
> Bug reports are submitted through GitHub Discussions and are not necessarily Issues until identified as such.
50+
51+
<!-- omit in toc -->
52+
#### Before Submitting a Bug Report
53+
54+
A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.
55+
56+
- Make sure that you are using the latest version.
57+
- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions. If you are looking for support, you might want to check [this section](#i-have-a-question)).
58+
- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already an existing or solved issue for your bug or error in [Issues](https://github.com/kc1awv/RetiBBS/issues?q=label%3Abug).
59+
- Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue.
60+
- Collect information about the bug:
61+
- Stack trace (Traceback)
62+
- OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
63+
- Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant.
64+
- Possibly your input and the output
65+
- Can you reliably reproduce the issue? And can you also reproduce it with older versions?
66+
67+
<!-- omit in toc -->
68+
#### How Do I Submit a Good Bug Report?
69+
70+
> You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to <>.
71+
72+
The developers of RetiBBS use GitHub issues to track bugs and errors. If you run into an issue with the project:
73+
74+
- Start a [Discussion](https://github.com/kc1awv/RetiBBS/issues/new). (Since we can't be sure at this point whether it is a bug, a suggestion, a feature or otherwise, we ask you not to create an Issue.)
75+
- Explain the behavior you would expect and the actual behavior.
76+
- Please provide as much context as possible and describe the *reproduction steps* that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
77+
- Provide the information you collected in the previous section.
78+
79+
Once it's filed:
80+
81+
- The project team will create and label an issue if applicable.
82+
- A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as `needs-repro`. Bugs with the `needs-repro` tag will not be addressed until they are reproduced.
83+
- If the team is able to reproduce the issue, it will be marked `needs-fix`, as well as possibly other tags (such as `critical`), and the issue will be left to be [implemented by someone](#your-first-code-contribution).
84+
85+
### Suggesting Enhancements
86+
87+
> Suggestions and Enhancements are submitted through [GitHub Discussions](https://github.com/kc1awv/RetiBBS/discussions) and are not Issues.
88+
89+
This section guides you through submitting an enhancement suggestion for RetiBBS, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.
90+
91+
<!-- omit in toc -->
92+
#### Before Submitting an Enhancement
93+
94+
- Make sure that you are using the latest version.
95+
- Perform a [search](https://github.com/kc1awv/RetiBBS/discussions) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
96+
- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library.
97+
98+
<!-- omit in toc -->
99+
#### How Do I Submit a Good Enhancement Suggestion?
100+
101+
Enhancement suggestions are tracked in [GitHub Discussions](https://github.com/kc1awv/RetiBBS/discussions).
102+
103+
- Use a **clear and descriptive title** for the issue to identify the suggestion.
104+
- Provide a **step-by-step description of the suggested enhancement** in as many details as possible.
105+
- **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you.
106+
- You may want to **include screenshots or screen recordings** which help you demonstrate the steps or point out the part which the suggestion is related to. You can use [LICEcap](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and the built-in [screen recorder in GNOME](https://help.gnome.org/users/gnome-help/stable/screen-shot-record.html.en) or [SimpleScreenRecorder](https://github.com/MaartenBaert/ssr) on Linux. <!-- this should only be included if the project has a GUI -->
107+
- **Explain why this enhancement would be useful** to most RetiBBS users. You may also want to point out the other projects that solved it better and which could serve as inspiration.
108+
109+
<!-- omit in toc -->
110+
## Attribution
111+
This guide is based on **contributing-gen**. [Make your own](https://github.com/bttger/contributing-gen)!

‎LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License, unless otherwise noted
2+
3+
Copyright (c) 2024-2025 Steve Miller KC1AWV | kc1awv.net
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md

+107
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
# RetiBBS
2+
3+
An ALPHA bulletin board system (BBS) implementation for Reticulum networks.
4+
5+
RetiBBS allows users to communicate through message boards in a secure manner.
6+
7+
## Features
8+
9+
- User authentication and authorization with Reticulum
10+
- Multiple message boards support
11+
- User display names
12+
- Admin privileges for board management
13+
- Simple text-based command interface
14+
15+
# Installation
16+
17+
It is strongly suggested to use this alpha software in its own Python virtual environment.
18+
```sh
19+
python -m venv .venv
20+
source .venv/bin/activate
21+
```
22+
23+
1. Install Textual and the Reticulum Network Stack:
24+
```sh
25+
pip install rns textual
26+
```
27+
28+
2. Clone this repository:
29+
```sh
30+
git clone https://github.com/kc1awv/RetiBBS.git
31+
cd RetiBBS
32+
```
33+
34+
## Usage
35+
36+
### Running the Server
37+
```sh
38+
cd server
39+
python retibbs_server.py [OPTIONS]
40+
```
41+
42+
#### Server options:
43+
- `--reticulum-config`: Path to alternative Reticulum config directory (optional)
44+
- `--identity-file`: Path to store/load server identity (default: server_identity.pem)
45+
- `--auth-file`: Path to store/load authorized users (default: authorized.json)
46+
- `--config-file`: Path to server config file (default: server_config.json)
47+
48+
### Running the Client
49+
```sh
50+
cd client
51+
python retibbs_textual.py [OPTIONS]
52+
```
53+
54+
#### Client options
55+
- `--server`: Hexadecimal hash of the RetiBBS server to connect to (optional)
56+
57+
#### Future client options
58+
- `--reticulum-config`: Path to alternative Reticulum config directory (optional)
59+
- `--identity-file`: Path to store/load server identity (default: client_identity.pem)
60+
61+
## Basic Commands
62+
63+
### Once connected:
64+
```
65+
? | help - Show help text and available commands
66+
h | hello - Check authorization status
67+
n | name <name> - Set your display name
68+
lb | listboards - List all available boards
69+
b | board <boardname> - Switch to a specific board
70+
p | post <text> - Post a message to current board
71+
l | list [boardname] - List messages in a board
72+
lo | logout - Log out from the system
73+
74+
### Admin Commands
75+
cb | createboard <name> - Create a new board
76+
db | deleteboard <boardname> - Delete an existing board
77+
a | admin <user_hash> - Grant admin rights to a user
78+
```
79+
80+
## Configuration
81+
82+
### Server Configuration (server_config.json)
83+
```json
84+
{
85+
"server_name": "My RetiBBS Server",
86+
"announce_interval": 300
87+
}
88+
```
89+
90+
### Client Address Book (address_book.json)
91+
Saved servers are stored in JSON format with server names and hashes.
92+
93+
## Development
94+
The codebase is organized into three main components:
95+
96+
- Server (server): Handles client connections, message boards, and user management
97+
- Client (client): Provides the user interface and server connection handling
98+
99+
## Security
100+
101+
RetiBBS utilizes Reticulum's built-in encryption and authentication mechanisms to ensure secure communication between clients and servers.
102+
103+
## Requirements
104+
105+
- Python 3.x
106+
- [Reticulum Network Stack](https://reticulum.network/)
107+
- [Textual](https://textual.textualize.io/)

0 commit comments

Comments
 (0)