📄
REMnux Documentation
  • REMnux: A Linux Toolkit for Malware Analysis
  • Install the Distro
    • Get the Virtual Appliance
    • Install from Scratch
    • Add to an Existing System
    • Run REMnux as a Container
    • Keep the Distro Up to Date
  • Discover the Tools
    • Examine Static Properties
      • General
      • PE Files
      • ELF Files
      • .NET
      • Deobfuscation
    • Statically Analyze Code
      • General
      • Unpacking
      • PE Files
      • Python
      • Scripts
      • Java
      • .NET
      • Flash
      • Android
    • Dynamically Reverse-Engineer Code
      • General
      • Shellcode
      • Scripts
      • ELF Files
    • Perform Memory Forensics
    • Explore Network Interactions
      • Monitoring
      • Connecting
      • Services
    • Investigate System Interactions
    • Analyze Documents
      • General
      • PDF
      • Microsoft Office
      • Email Messages
    • Gather and Analyze Data
    • View or Edit Files
    • General Utilities
  • Run Tools in Containers
    • Docker Images of Malware Analysis Tools
  • Behind the Scenes
    • People
    • Technologies
      • SaltStack Management
      • REMnux Installer
      • State Files Without the REMnux Installer
      • Debian Packages
      • Website and Docs
    • License
  • Tips and More
    • REMnux Configuration Tips
    • REMnux Tool Tips
    • Malware Analysis Training
    • REMnux Website
  • Get Involved
    • Ask and Answer Questions
    • Write About the Tools
    • Add or Update Tools
      • Contribute a Salt State File
      • Contribute a Debian Package
      • Contribute a Dockerfile
    • Implement Enhancements
Powered by GitBook
On this page
  • The REMnux Website
  • The REMnux Documentation Site
  1. Behind the Scenes
  2. Technologies

Website and Docs

PreviousDebian PackagesNextLicense

Last updated 4 years ago

Several technologies work together generate and host the REMnux website and this documentation. Thank you to the people and companies behind these technologies for providing them as free resources to help make REMnux possible!

The REMnux Website

The REMnux website, accessible at , is a set of static pages and related asset files. It's hosted on GitHub using . These contents reside in the repository, which is configured to use Github Pages like this:

  • Adjusting these files to reflect the desired change

  • Using Hugo to generate the static website content

  • Placing the new content in the remnux/remnux.github.io repository

The REMnux Documentation Site

The contents of that repository are generated using , based on the source files that reside in the repository on GitHub. Updating the REMnux website involves:

The website contents are formatted using a customized version of the , which was created by .

The REMnux documentation site, which you're reading now and which resides at , is generated and hosted by . GitBook is configured to back up documentation contents to the repository on GitHub.

The listing of REMnux tools, available as part of REMnux documentation, is generated automatically using the , which was written by . The script parses the headers of , which comprise the REMnux distro, and updates the tool listing using .

Hugo
remnux/website-source
Raditian Free Hugo Theme
Radity
https://docs.remnux.org
GitBook
remnux/docs
header-parser.py script
Halil Burak Noyan
SaltStack state files
GitBook API
https://REMnux.org
GitHub Pages
remnux/remnux.github.io