ghostnet-app

command module
v0.0.0-...-1e0eb2d Latest Latest
Warning

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

Go to latest
Published: Nov 15, 2024 License: MIT Imports: 19 Imported by: 0

README

Ghostnet-app

Ghostnet-app is a BBS door program for Linux that facilitates applications for GHOSTnet network nodes. It reads user details from the DOOR32.SYS file and applies configurations based on a settings.ini file. The primary audience for this tool is GHOSTnet network administrators who manage applications and approvals for network nodes on either FTN or WWIVnet-based networks.

Note: If you're not a GHOSTnet admin, this program likely won't be of much use to you.

Features

  • User Details Extraction: Reads user details from the DOOR32.SYS file, including alias, security level, and connection details.
  • Configurable Access: Uses settings.ini to set an admin security level and enable or disable FTN and WWIVnet applications.
  • Easy Application: Allows BBS users to apply for a GHOSTnet node with minimal setup, making it easier for admins to manage applications and approvals.
  • Easy Onboarding: Admins can send the details and instructions to a user via email right from the approval menu.
  • Optionally send notifications to a Discord channel.

Prerequisites

  • Go: Ensure you have Go installed (version 1.16 or later).
  • atomicgo.dev/keyboard: Used for keyboard input. Install it via go get.
  • gopkg.in/ini.v1: Used to read settings.ini. Install it via go get.

Installation

Clone the repository:
git clone https://github.com/yourusername/ghostnet-app.git
cd ghostnet-app
Install the required dependencies:
 go get atomicgo.dev/keyboard
 go get gopkg.in/ini.v1
Build the application:
go build -o ghostnet-app

Configuration

Before running the application, you’ll need to create a settings.ini file in the same directory. Here’s an example configuration:

[Settings]
AdminSecurityLevel = 255                           # Minimum security level for admin access
WWIVnet = true                                     # Enable or disable WWIVnet applications
FTN = false                                        # Enable or disable FTN applications
Discord = true                                     # Enable or disable Discord notifications
DiscordWebhookURL = "https://discord.com/api/..."  # Replace with your Webhook URL
DiscordTitle = "New Application Submitted"         # Title for Discord Message
DiscordUsername = "GHOSTbot"                       # User name to be post as

Usage

  1. Place the compiled ghostnet-app binary in the directory where it will be used.
  2. Ensure DOOR32.SYS is present in the directory specified by the -path flag (or in the same directory by default).
  3. Run the application, specifying the path to the directory containing DOOR32.SYS:
  ./ghostnet-app -path /path/to/door32sys_directory

Typical Workflow for GHOSTnet Admins

  • Configuration Check: Ensure settings.ini has the correct settings for admin access and network options.
  • Review User Applications
  • Approve/Reject Applications

Contributing

Contributions are welcome! Feel free to open issues or submit pull requests for feature requests, bug fixes, or improvements.

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
JackTT - Gopher 🇻🇳