From 017b6445f49bcb67492b3c3fd913eb5dae41c6d7 Mon Sep 17 00:00:00 2001 From: CaffeineFueled Date: Thu, 2 Oct 2025 19:53:03 +0200 Subject: [PATCH] init v0.1.0 --- .gitignore | 7 ++ Dockerfile | 19 ++++ LICENSE | 202 ++++++++++++++++++++++++++++++++++++++ README.md | 87 ++++++++++++++++ assets/favicon.ico | 0 assets/script.js | 0 assets/style.css | 153 +++++++++++++++++++++++++++++ build.sh | 63 ++++++++++++ images/.gitkeep | 0 output/.gitkeep | 0 templates/00_meta.tmpl | 12 +++ templates/10_header.tmpl | 3 + templates/20_gallery.tmpl | 3 + templates/90_footer.tmpl | 6 ++ 14 files changed, 555 insertions(+) create mode 100644 .gitignore create mode 100644 Dockerfile create mode 100644 LICENSE create mode 100644 README.md create mode 100644 assets/favicon.ico create mode 100644 assets/script.js create mode 100644 assets/style.css create mode 100755 build.sh create mode 100644 images/.gitkeep create mode 100644 output/.gitkeep create mode 100644 templates/00_meta.tmpl create mode 100644 templates/10_header.tmpl create mode 100644 templates/20_gallery.tmpl create mode 100644 templates/90_footer.tmpl diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..021d4a3 --- /dev/null +++ b/.gitignore @@ -0,0 +1,7 @@ +# Ignore content in output directory +output/* +!output/.gitkeep + +# Ignore content in images directory +images/* +!images/.gitkeep diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..78c237a --- /dev/null +++ b/Dockerfile @@ -0,0 +1,19 @@ +FROM docker.io/ubuntu:24.04 + +WORKDIR /app + +# Copy project files +COPY build.sh /app/ +COPY templates /app/templates +COPY assets /app/assets + +# Create directories +RUN mkdir -p /app/images /app/output + +# Make build script executable +RUN chmod +x /app/build.sh + +# Set volumes for images and output +VOLUME ["/app/images", "/app/output"] + +CMD ["./build.sh"] diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..2b146bc --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ +Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + diff --git a/README.md b/README.md new file mode 100644 index 0000000..0ba633a --- /dev/null +++ b/README.md @@ -0,0 +1,87 @@ +# Shellery + +Simple SSG to create dynamic gallery one-pagers in your shell! Shell+Gallery + +[Issue Tracker and Requests](https://git.uphillsecurity.com/cf7/shellery/issues) + +- Status: Beta +- Instance/ Demo: +- Inspired by + +--- + +## Features + +**Available**: +- Simple use without dependencies +- no Javascript +- Lightbox of image with anchor +- Order of images via filename +- Container available +- Simple to modify (Pictures and Templates) + +**Ideas**: +- check file formats +- remove exif data +- conf file for options +- anonymize file names +- sections via file names + +**Not planned**: + +--- + +## Usage + +### Docker / Podman + +```bash +mkdir -p images output + +podman run -v $(pwd)/images:/app/images -v $(pwd)/output:/app/output git.uphillsecurity.com/cf7/shellery:latest +``` + +### Local + +- Clone +- Put images into `./images/` +- `./build.sh` +- Check `./output/` + +Modify files accordingly. + +### Docker Build + +Build and run: +```bash +docker build -t localhost/shellery . +docker run -v $(pwd)/images:/app/images -v $(pwd)/output:/app/output localhost/shellery +``` + +The generated gallery will be in `./output/index.html` + +--- + +## Security + +For security concerns or reports, please contact via `hello a t uphillsecurity d o t com` [gpg](https://uphillsecurity.com/gpg). + +--- + +## License + +**Apache License** + +Version 2.0, January 2004 + +http://www.apache.org/licenses/ + +- ✅ Commercial use +- ✅ Modification +- ✅ Distribution +- ✅ Patent use +- ✅ Private use +- ✅ Limitations +- ❌Trademark use +- ❌Liability +- ❌Warranty diff --git a/assets/favicon.ico b/assets/favicon.ico new file mode 100644 index 0000000..e69de29 diff --git a/assets/script.js b/assets/script.js new file mode 100644 index 0000000..e69de29 diff --git a/assets/style.css b/assets/style.css new file mode 100644 index 0000000..bc2ea4f --- /dev/null +++ b/assets/style.css @@ -0,0 +1,153 @@ +* { + margin: 0; + padding: 0; + box-sizing: border-box; +} + +body { + font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Oxygen, Ubuntu, Cantarell, sans-serif; + background: #000; + color: #fff; + display: flex; + flex-direction: column; + min-height: 100vh; +} + +header { + position: fixed; + top: 0; + left: 0; + right: 0; + padding: 1.5rem 2rem; + background: rgba(0, 0, 0, 0.8); + backdrop-filter: blur(10px); + z-index: 100; +} + +header h1 { + font-size: 1.5rem; + font-weight: 600; + letter-spacing: -0.02em; +} + +.gallery { + columns: 4 300px; + column-gap: 0; + padding-top: 5rem; + flex: 1; +} + +.gallery-item { + position: relative; + overflow: hidden; + background: #111; + break-inside: avoid; + margin-bottom: 0; +} + +.gallery-item a { + display: block; + cursor: pointer; +} + +.gallery-item img { + width: 100%; + height: auto; + display: block; + transition: transform 0.3s ease; +} + +.gallery-item:hover img { + transform: scale(1.05); +} + +/* Lightbox */ +.lightbox { + display: none; + position: fixed; + top: 0; + left: 0; + width: 100%; + height: 100%; + background: rgba(0, 0, 0, 0.95); + z-index: 1000; + align-items: center; + justify-content: center; +} + +.lightbox:target { + display: flex; +} + +.lightbox img { + max-width: 90%; + max-height: 90vh; + object-fit: contain; +} + +.lightbox-close { + position: absolute; + top: 2rem; + right: 2rem; + color: #fff; + font-size: 3rem; + text-decoration: none; + line-height: 1; + font-weight: 300; + transition: opacity 0.2s; +} + +.lightbox-close:hover { + opacity: 0.7; +} + +footer { + padding: 2rem; + text-align: center; + background: #000; + margin-top: auto; +} + +footer p { + margin: 0; + font-size: 0.875rem; + color: #666; +} + +footer a { + color: #999; + text-decoration: none; + transition: color 0.2s; +} + +footer a:hover { + color: #fff; +} + +/* Responsive adjustments */ +@media (max-width: 1200px) { + .gallery { + columns: 3 250px; + } +} + +@media (max-width: 768px) { + .gallery { + columns: 2 200px; + padding-top: 4rem; + } + + header { + padding: 1rem 1.5rem; + } + + header h1 { + font-size: 1.25rem; + } +} + +@media (max-width: 480px) { + .gallery { + columns: 1; + } +} diff --git a/build.sh b/build.sh new file mode 100755 index 0000000..e56e7db --- /dev/null +++ b/build.sh @@ -0,0 +1,63 @@ +#!/bin/bash + +# Simple Static Gallery Generator +# Generates a single-page gallery from images in the images/ directory + +set -e + +IMAGES_DIR="images" +OUTPUT_DIR="output" +TEMPLATES_DIR="templates" +ASSETS_DIR="assets" + +# Create output directory +mkdir -p "$OUTPUT_DIR" + +# Start building the HTML file +OUTPUT_FILE="$OUTPUT_DIR/index.html" +> "$OUTPUT_FILE" + +# Assemble templates in order +for template in $(ls "$TEMPLATES_DIR"/*.tmpl | sort); do + # Process each template line by line to handle placeholders + while IFS= read -r line; do + if [[ "$line" == *""* ]]; then + # Generate gallery items (reversed order) + images=("$IMAGES_DIR"/*) + for ((i=${#images[@]}-1; i>=0; i--)); do + img="${images[$i]}" + if [[ -f "$img" ]]; then + img_name=$(basename "$img") + echo "
" >> "$OUTPUT_FILE" + echo " " >> "$OUTPUT_FILE" + echo " \"$img_name\"" >> "$OUTPUT_FILE" + echo " " >> "$OUTPUT_FILE" + echo "
" >> "$OUTPUT_FILE" + fi + done + elif [[ "$line" == *""* ]]; then + # Generate lightboxes outside the gallery grid (reversed order) + images=("$IMAGES_DIR"/*) + for ((i=${#images[@]}-1; i>=0; i--)); do + img="${images[$i]}" + if [[ -f "$img" ]]; then + img_name=$(basename "$img") + echo "
" >> "$OUTPUT_FILE" + echo " ×" >> "$OUTPUT_FILE" + echo " \"$img_name\"" >> "$OUTPUT_FILE" + echo "
" >> "$OUTPUT_FILE" + fi + done + else + echo "$line" >> "$OUTPUT_FILE" + fi + done < "$template" +done + +# Copy assets +cp -r "$ASSETS_DIR"/* "$OUTPUT_DIR/" + +# Copy images +cp -r "$IMAGES_DIR" "$OUTPUT_DIR/" + +echo "Gallery generated successfully in $OUTPUT_DIR/index.html" diff --git a/images/.gitkeep b/images/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/output/.gitkeep b/output/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/templates/00_meta.tmpl b/templates/00_meta.tmpl new file mode 100644 index 0000000..6503001 --- /dev/null +++ b/templates/00_meta.tmpl @@ -0,0 +1,12 @@ + + + + + + + + Gallery + + + + diff --git a/templates/10_header.tmpl b/templates/10_header.tmpl new file mode 100644 index 0000000..4f67869 --- /dev/null +++ b/templates/10_header.tmpl @@ -0,0 +1,3 @@ +
+

Gallery

+
diff --git a/templates/20_gallery.tmpl b/templates/20_gallery.tmpl new file mode 100644 index 0000000..46d1158 --- /dev/null +++ b/templates/20_gallery.tmpl @@ -0,0 +1,3 @@ +
+ +
diff --git a/templates/90_footer.tmpl b/templates/90_footer.tmpl new file mode 100644 index 0000000..a744170 --- /dev/null +++ b/templates/90_footer.tmpl @@ -0,0 +1,6 @@ + + + +