Major repository cleanup and enhancement
- Reorganize documentation: moved old docs to docs/ directory - Add comprehensive README.md with build options and usage guide - Add detailed CONTRIBUTING.md with help content management guide - Create Makefile for automated building and testing - Add Dockerfile.scratch for building from Ubuntu 20.04 base - Enhance all Dockerfiles with PowerShell + PSScriptAnalyzer - Add modern shells: zsh (with plugins) and fish (with config) - Add modern CLI tools: fd-find, ripgrep, fzf - Create comprehensive help system with cheat/TLDR/fish completions - Add helper scripts for help content management and coverage checking - Fix Dockerfile.remnux script references - Support three build variants: upstream (REMnux), scratch (Ubuntu), kali Build options: - make build-upstream: Fast, uses REMnux upstream (recommended) - make build-scratch: Full control, builds from Ubuntu 20.04 - make build-kali: Legacy Kali Linux base Features: - PowerShell with PSScriptAnalyzer module - Modern shells (zsh, fish) with custom configurations - Enhanced help system (cheat sheets, TLDR pages, fish completions) - Help coverage checking and bulk import tools - Comprehensive documentation for users and contributors
This commit is contained in:
@@ -10,10 +10,16 @@ RUN apt-get update && apt-get install -y \
|
||||
busybox \
|
||||
catdoc \
|
||||
docx2txt \
|
||||
fd-find \
|
||||
fish \
|
||||
fzf \
|
||||
mc \
|
||||
pipx \
|
||||
ripgrep \
|
||||
unrtf \
|
||||
zsh \
|
||||
zsh-autosuggestions \
|
||||
zsh-syntax-highlighting \
|
||||
&& rm -rf /var/lib/apt/lists/*
|
||||
|
||||
# Configure pip
|
||||
@@ -38,38 +44,42 @@ RUN PIPX_HOME=/opt/pipx PIPX_BIN_DIR=/usr/local/bin pipx install --include-deps
|
||||
RUN PIPX_HOME=/opt/pipx PIPX_BIN_DIR=/usr/local/bin pipx install --include-deps cheat \
|
||||
&& PIPX_HOME=/opt/pipx PIPX_BIN_DIR=/usr/local/bin pipx install --include-deps tldr
|
||||
|
||||
# Install navi for interactive cheat sheets
|
||||
RUN wget https://github.com/denisidoro/navi/releases/download/v2.23.0/navi-v2.23.0-x86_64-unknown-linux-musl.tar.gz -O /tmp/navi.tar.gz \
|
||||
&& tar -xzf /tmp/navi.tar.gz -C /usr/local/bin \
|
||||
&& chmod +x /usr/local/bin/navi \
|
||||
&& rm /tmp/navi.tar.gz
|
||||
# Removed navi - focus on tldr and cheat for reliable help system
|
||||
|
||||
# Create data directory and set permissions
|
||||
RUN mkdir -p /data \
|
||||
&& chown remnux:remnux /data
|
||||
|
||||
# Add documentation and search tools
|
||||
# Add documentation and streamlined help system
|
||||
ADD files/README /opt/README
|
||||
ADD files/command_help /opt/command_help
|
||||
ADD scripts/download-docs.sh /usr/local/bin/download-docs.sh
|
||||
ADD files/zshrc /etc/zsh/zshrc
|
||||
ADD files/fish_config.fish /etc/fish/conf.d/remnux.fish
|
||||
ADD scripts/create-offline-help-system.sh /usr/local/bin/create-offline-help-system.sh
|
||||
ADD scripts/find-tool /usr/local/bin/find-tool
|
||||
ADD scripts/help /usr/local/bin/help
|
||||
ADD cheatsheets/ /opt/cheatsheets/
|
||||
ADD scripts/fhelp /usr/local/bin/fhelp
|
||||
ADD scripts/import-remnux-cheatsheets.sh /usr/local/bin/import-remnux-cheatsheets.sh
|
||||
ADD scripts/convert-remnux-cheats.py /usr/local/bin/convert-remnux-cheats.py
|
||||
ADD scripts/add-tool-cheats.sh /usr/local/bin/add-tool-cheats.sh
|
||||
|
||||
# Download REMnux documentation and create searchable database
|
||||
RUN chmod +x /usr/local/bin/download-docs.sh /usr/local/bin/find-tool /usr/local/bin/help \
|
||||
&& /usr/local/bin/download-docs.sh
|
||||
# Create streamlined offline help system (tldr + cheat)
|
||||
RUN chmod +x /usr/local/bin/create-offline-help-system.sh /usr/local/bin/find-tool /usr/local/bin/fhelp /usr/local/bin/import-remnux-cheatsheets.sh \
|
||||
&& chmod +x /usr/local/bin/convert-remnux-cheats.py /usr/local/bin/add-tool-cheats.sh \
|
||||
&& /usr/local/bin/create-offline-help-system.sh \
|
||||
&& /usr/local/bin/add-tool-cheats.sh
|
||||
|
||||
# Update bashrc with welcome message and comprehensive help info
|
||||
RUN echo 'cat /opt/README' >> /etc/bash.bashrc \
|
||||
&& echo 'echo ""' >> /etc/bash.bashrc \
|
||||
&& echo 'echo "📚 Comprehensive Help System:"' >> /etc/bash.bashrc \
|
||||
&& echo 'echo " help - Complete help system"' >> /etc/bash.bashrc \
|
||||
&& echo 'echo " help tools pdf - Find PDF analysis tools"' >> /etc/bash.bashrc \
|
||||
&& echo 'echo " help cheat pdfid.py - Show command examples"' >> /etc/bash.bashrc \
|
||||
&& echo 'echo " help examples - Browse all examples (navi)"' >> /etc/bash.bashrc \
|
||||
&& echo 'echo " help pdf - PDF analysis workflow"' >> /etc/bash.bashrc \
|
||||
&& echo 'echo ""' >> /etc/bash.bashrc
|
||||
&& echo 'echo " fhelp - Complete file analysis help"' >> /etc/bash.bashrc \
|
||||
&& echo 'echo " fhelp tools pdf - Find PDF analysis tools"' >> /etc/bash.bashrc \
|
||||
&& echo 'echo " fhelp cheat pdfid.py - Show command examples"' >> /etc/bash.bashrc \
|
||||
&& echo 'echo " fhelp examples - Browse all examples"' >> /etc/bash.bashrc \
|
||||
&& echo 'echo " fhelp pdf - PDF analysis workflow"' >> /etc/bash.bashrc \
|
||||
&& echo 'echo ""' >> /etc/bash.bashrc \
|
||||
&& echo 'alias analyse="fhelp"' >> /etc/bash.bashrc \
|
||||
&& echo 'alias ?="fhelp"' >> /etc/bash.bashrc
|
||||
|
||||
# Switch to remnux user (REMnux default user)
|
||||
USER remnux
|
||||
|
||||
Reference in New Issue
Block a user