NodehistJ

NodehistJ is a comprehensive system designed for managing and accessing historical FidoNet nodelist data. This platform simplifies the retrieval and processing of both current nodelist information and historical records, while also providing insights into node history variations over time.

Key Features:

• RESTful APIs: Easily query and fetch node information across different time periods and contexts, allowing for seamless integration with other tools and systems.
• Microservices Architecture:
  • Historic Nodelists Service (/historic): Efficiently stores and retrieves archival FidoNet nodelist data.
  • History Diff Service (/diff): Tracks and manages differences in node history, enhancing the data's usability and insight.

Technical Stack:

NodehistJ relies on a robust set of dependencies to ensure high performance and reliability:

• Any S3 storage: Utilized for storing nodelist archives.
• Redis: Provides caching mechanisms, improving data retrieval speed.
• Redpanda (Kafka): Facilitates message exchange for optimal data synchronization across services.
• PostgreSQL: Acts as the primary database for all nodelist information.

Getting Started:

To quickly set up NodehistJ, several Docker configurations are available:

• For a basic setup:

  docker compose -f compose.yml up -d
  

• For development using MinIO:

  docker compose -f compose-dev.yml up -d
  

• For production with Traefik:

  docker compose -f compose-traefik.yml up -d
  

Environment Variables:

NodehistJ requires specific environment variables for configuration, including:

Additional Commands:

• To stop all services:
  docker compose -f compose.yml down
• To view logs in real-time:
  docker compose -f compose.yml logs -f
• To rebuild Docker images:
  docker compose -f compose.yml build

Development Setup:

To run NodehistJ locally, ensure Docker, Java 25, and Gradle are installed. Then, follow these commands:

# Start dependencies
docker compose -f compose-dev.yml up -d

# Build and run services
./gradlew :nodehistj-historic-nodelists:bootRun
./gradlew :nodehistj-newest-nodelists:bootRun
./gradlew :nodehistj-history-diff:bootRun

NodehistJ transforms the complex task of handling FidoNet nodelist data into an efficient and manageable process, making it an essential tool for developers working with historical data.