adrelanos / package_parser

An application for parsing Whonix and Kicksecure packages in to HTML

Description

A simple application that uses Ruby to generate markdown data for Whonix and Kicksecure HTML packages sites.

Markdown will be placed in ./docs

Setup

In order for it to work, Ruby 3 must be installed. Also, you must have the respective kicksecure or whonix package repository.

1. Install Ruby. You can use apt-get, rbenv, RVM, or asdf to do this. The repo author prefers rbenv.
2. Download the packages repository

ruby --version # verify this is >= 3.0.0
sudo apt install rsync
rsync-ssl --recursive --delete --times --perms rsync://whonix.org/whonix/developer-meta-files/internal/ ../whonix-repository

Usage

Generating Package Markdown

From the root of this repository:

# ruby runner.rb <os_type> <repository_path>
ruby runner.rb whonix ../whonix-repository

Generating an entire HTML site

From the root of this directory, ensure the following directory structure with tree -L 1 ..

./
├── kicksecure-packages
├── kicksecure-repository
├── package_parser
├── whonix-packages
└── whonix-repository

cd back in to the directory the following command

./build-site.sh <os_type> <desired_static_output_path>

example:

./build-site.sh whonix ../whonix-packages-html