Compare commits
5 Commits
f1ee4722c2
...
main
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
12e91032a1 | ||
|
|
fc62cd39be | ||
|
|
6d680ea2e8 | ||
|
|
bd0201b6d3 | ||
|
|
579920bbfc |
1
.gitignore
vendored
1
.gitignore
vendored
@@ -2,6 +2,7 @@
|
||||
|
||||
# Generated index files
|
||||
**/index.html
|
||||
coverage.*
|
||||
|
||||
# Debian packaging artifacts
|
||||
debian/.debhelper/
|
||||
|
||||
301
LICENSE
301
LICENSE
@@ -1,165 +1,202 @@
|
||||
GNU LESSER GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
This version of the GNU Lesser General Public License incorporates
|
||||
the terms and conditions of version 3 of the GNU General Public
|
||||
License, supplemented by the additional permissions listed below.
|
||||
1. Definitions.
|
||||
|
||||
0. Additional Definitions.
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
As used herein, "this License" refers to version 3 of the GNU Lesser
|
||||
General Public License, and the "GNU GPL" refers to version 3 of the GNU
|
||||
General Public License.
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"The Library" refers to a covered work governed by this License,
|
||||
other than an Application or a Combined Work as defined below.
|
||||
"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.
|
||||
|
||||
An "Application" is any work that makes use of an interface provided
|
||||
by the Library, but which is not otherwise based on the Library.
|
||||
Defining a subclass of a class defined by the Library is deemed a mode
|
||||
of using an interface provided by the Library.
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
A "Combined Work" is a work produced by combining or linking an
|
||||
Application with the Library. The particular version of the Library
|
||||
with which the Combined Work was made is also called the "Linked
|
||||
Version".
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
The "Minimal Corresponding Source" for a Combined Work means the
|
||||
Corresponding Source for the Combined Work, excluding any source code
|
||||
for portions of the Combined Work that, considered in isolation, are
|
||||
based on the Application, and not on the Linked Version.
|
||||
"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.
|
||||
|
||||
The "Corresponding Application Code" for a Combined Work means the
|
||||
object code and/or source code for the Application, including any data
|
||||
and utility programs needed for reproducing the Combined Work from the
|
||||
Application, but excluding the System Libraries of the Combined Work.
|
||||
"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).
|
||||
|
||||
1. Exception to Section 3 of the GNU GPL.
|
||||
"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.
|
||||
|
||||
You may convey a covered work under sections 3 and 4 of this License
|
||||
without being bound by section 3 of the GNU GPL.
|
||||
"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."
|
||||
|
||||
2. Conveying Modified Versions.
|
||||
"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.
|
||||
|
||||
If you modify a copy of the Library, and, in your modifications, a
|
||||
facility refers to a function or data to be supplied by an Application
|
||||
that uses the facility (other than as an argument passed when the
|
||||
facility is invoked), then you may convey a copy of the modified
|
||||
version:
|
||||
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.
|
||||
|
||||
a) under this License, provided that you make a good faith effort to
|
||||
ensure that, in the event an Application does not supply the
|
||||
function or data, the facility still operates, and performs
|
||||
whatever part of its purpose remains meaningful, or
|
||||
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.
|
||||
|
||||
b) under the GNU GPL, with none of the additional permissions of
|
||||
this License applicable to that copy.
|
||||
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:
|
||||
|
||||
3. Object Code Incorporating Material from Library Header Files.
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
The object code form of an Application may incorporate material from
|
||||
a header file that is part of the Library. You may convey such object
|
||||
code under terms of your choice, provided that, if the incorporated
|
||||
material is not limited to numerical parameters, data structure
|
||||
layouts and accessors, or small macros, inline functions and templates
|
||||
(ten or fewer lines in length), you do both of the following:
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
a) Give prominent notice with each copy of the object code that the
|
||||
Library is used in it and that the Library and its use are
|
||||
covered by this License.
|
||||
(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
|
||||
|
||||
b) Accompany the object code with a copy of the GNU GPL and this license
|
||||
document.
|
||||
(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.
|
||||
|
||||
4. Combined Works.
|
||||
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.
|
||||
|
||||
You may convey a Combined Work under terms of your choice that,
|
||||
taken together, effectively do not restrict modification of the
|
||||
portions of the Library contained in the Combined Work and reverse
|
||||
engineering for debugging such modifications, if you also do each of
|
||||
the following:
|
||||
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.
|
||||
|
||||
a) Give prominent notice with each copy of the Combined Work that
|
||||
the Library is used in it and that the Library and its use are
|
||||
covered by this License.
|
||||
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.
|
||||
|
||||
b) Accompany the Combined Work with a copy of the GNU GPL and this license
|
||||
document.
|
||||
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.
|
||||
|
||||
c) For a Combined Work that displays copyright notices during
|
||||
execution, include the copyright notice for the Library among
|
||||
these notices, as well as a reference directing the user to the
|
||||
copies of the GNU GPL and this license document.
|
||||
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.
|
||||
|
||||
d) Do one of the following:
|
||||
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.
|
||||
|
||||
0) Convey the Minimal Corresponding Source under the terms of this
|
||||
License, and the Corresponding Application Code in a form
|
||||
suitable for, and under terms that permit, the user to
|
||||
recombine or relink the Application with a modified version of
|
||||
the Linked Version to produce a modified Combined Work, in the
|
||||
manner specified by section 6 of the GNU GPL for conveying
|
||||
Corresponding Source.
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
1) Use a suitable shared library mechanism for linking with the
|
||||
Library. A suitable mechanism is one that (a) uses at run time
|
||||
a copy of the Library already present on the user's computer
|
||||
system, and (b) will operate properly with a modified version
|
||||
of the Library that is interface-compatible with the Linked
|
||||
Version.
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
e) Provide Installation Information, but only if you would otherwise
|
||||
be required to provide such information under section 6 of the
|
||||
GNU GPL, and only to the extent that such information is
|
||||
necessary to install and execute a modified version of the
|
||||
Combined Work produced by recombining or relinking the
|
||||
Application with a modified version of the Linked Version. (If
|
||||
you use option 4d0, the Installation Information must accompany
|
||||
the Minimal Corresponding Source and Corresponding Application
|
||||
Code. If you use option 4d1, you must provide the Installation
|
||||
Information in the manner specified by section 6 of the GNU GPL
|
||||
for conveying Corresponding Source.)
|
||||
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.
|
||||
|
||||
5. Combined Libraries.
|
||||
Copyright 2025, IPng Networks GmbH, Pim van Pelt <pim@ipng.ch>
|
||||
|
||||
You may place library facilities that are a work based on the
|
||||
Library side by side in a single library together with other library
|
||||
facilities that are not Applications and are not covered by this
|
||||
License, and convey such a combined library under terms of your
|
||||
choice, if you do both of the following:
|
||||
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
|
||||
|
||||
a) Accompany the combined library with a copy of the same work based
|
||||
on the Library, uncombined with any other library facilities,
|
||||
conveyed under the terms of this License.
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
b) Give prominent notice with the combined library that part of it
|
||||
is a work based on the Library, and explaining where to find the
|
||||
accompanying uncombined form of the same work.
|
||||
|
||||
6. Revised Versions of the GNU Lesser General Public License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions
|
||||
of the GNU Lesser General Public License from time to time. Such new
|
||||
versions will be similar in spirit to the present version, but may
|
||||
differ in detail to address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Library as you received it specifies that a certain numbered version
|
||||
of the GNU Lesser General Public License "or any later version"
|
||||
applies to it, you have the option of following the terms and
|
||||
conditions either of that published version or of any later version
|
||||
published by the Free Software Foundation. If the Library as you
|
||||
received it does not specify a version number of the GNU Lesser
|
||||
General Public License, you may choose any version of the GNU Lesser
|
||||
General Public License ever published by the Free Software Foundation.
|
||||
|
||||
If the Library as you received it specifies that a proxy can decide
|
||||
whether future versions of the GNU Lesser General Public License shall
|
||||
apply, that proxy's public statement of acceptance of any version is
|
||||
permanent authorization for you to choose that version for the
|
||||
Library.
|
||||
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.
|
||||
|
||||
20
Makefile
20
Makefile
@@ -1,4 +1,4 @@
|
||||
.PHONY: build clean wipe test help
|
||||
.PHONY: build clean wipe test help sync-version pkg-deb
|
||||
|
||||
# Default target
|
||||
all: build
|
||||
@@ -27,6 +27,9 @@ clean:
|
||||
@echo "Cleaning build artifacts..."
|
||||
rm -f s3-genindex
|
||||
rm -f coverage.out coverage.html
|
||||
rm -rf debian/s3-genindex debian/files debian/*.substvars debian/debhelper-build-stamp
|
||||
[ -d debian/go ] && chmod -R +w debian/go || true
|
||||
rm -rf debian/.gocache debian/go
|
||||
find . -name index.html -delete
|
||||
@echo "Clean complete"
|
||||
|
||||
@@ -73,6 +76,19 @@ bench:
|
||||
@echo "Running benchmarks..."
|
||||
go test -bench=. ./...
|
||||
|
||||
# Sync version from debian/changelog to source code
|
||||
sync-version:
|
||||
@echo "Syncing version..."
|
||||
@version=$$(head -1 debian/changelog | sed -n 's/.*(\([^)]*\)).*/\1/p'); \
|
||||
sed -i "s/const Version = .*/const Version = \"$$version\"/" cmd/s3-genindex/main.go; \
|
||||
echo "Updated version to $$version"
|
||||
|
||||
# Build Debian package
|
||||
pkg-deb: sync-version
|
||||
@echo "Building Debian package..."
|
||||
DEB_BUILD_OPTIONS=noautodbgsym fakeroot dpkg-buildpackage -us -uc -b
|
||||
@echo "Debian package build complete"
|
||||
|
||||
# Show help
|
||||
help:
|
||||
@echo "Available targets:"
|
||||
@@ -87,4 +103,6 @@ help:
|
||||
@echo " lint - Lint code (requires golangci-lint)"
|
||||
@echo " check - Run fmt, vet, lint, and test"
|
||||
@echo " bench - Run benchmarks"
|
||||
@echo " sync-version - Sync version from debian/changelog to source"
|
||||
@echo " pkg-deb - Build Debian package"
|
||||
@echo " help - Show this help message"
|
||||
|
||||
11
README.md
11
README.md
@@ -24,17 +24,14 @@ go install git.ipng.ch/ipng/s3-genindex/cmd/s3-genindex@latest
|
||||
## Quick Start
|
||||
|
||||
```bash
|
||||
# Dry run to see what would be generated
|
||||
s3-genindex -d /path/to/dir -n
|
||||
|
||||
# Local directory
|
||||
s3-genindex -d /path/to/dir
|
||||
|
||||
# S3 bucket (requires AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY)
|
||||
s3-genindex -s3 http://minio.example.com:9000/bucket
|
||||
|
||||
# Dry run to see what would be generated
|
||||
s3-genindex -d /path/to/dir -n
|
||||
|
||||
# Show index.html files in listings
|
||||
s3-genindex -d /path/to/dir -i
|
||||
s3-genindex -s3 https://minio.example.com/bucket
|
||||
```
|
||||
|
||||
## Build
|
||||
|
||||
@@ -20,6 +20,9 @@ import (
|
||||
"git.ipng.ch/ipng/s3-genindex/internal/indexgen"
|
||||
)
|
||||
|
||||
// Version is the application version (sync'd from debian/changelog)
|
||||
const Version = "1.0.0-1"
|
||||
|
||||
// S3Config holds S3 connection configuration
|
||||
type S3Config struct {
|
||||
Endpoint string
|
||||
@@ -348,6 +351,7 @@ func main() {
|
||||
var dryRun bool
|
||||
var showIndexFiles bool
|
||||
var watermarkURL string
|
||||
var showVersion bool
|
||||
|
||||
// Set defaults
|
||||
opts.DirAppend = true
|
||||
@@ -363,6 +367,7 @@ func main() {
|
||||
flag.BoolVar(&opts.Verbose, "v", false, "verbosely list every processed file")
|
||||
flag.BoolVar(&showIndexFiles, "i", false, "show index.html files in directory listings")
|
||||
flag.StringVar(&watermarkURL, "wm", "", "watermark logo URL to display in top left corner")
|
||||
flag.BoolVar(&showVersion, "version", false, "show version information")
|
||||
|
||||
flag.Usage = func() {
|
||||
fmt.Fprintf(os.Stderr, "Generate directory index files (recursive is ON, hidden files included by default).\n")
|
||||
@@ -381,6 +386,12 @@ func main() {
|
||||
|
||||
flag.Parse()
|
||||
|
||||
// Handle version flag
|
||||
if showVersion {
|
||||
fmt.Printf("s3-genindex version %s\n", Version)
|
||||
os.Exit(0)
|
||||
}
|
||||
|
||||
// Check mutual exclusion and that exactly one option is provided
|
||||
if directory == "" && s3URL == "" {
|
||||
fmt.Fprintf(os.Stderr, "Error: Either -d <directory> or -s3 <url> must be specified.\n\n")
|
||||
|
||||
8
debian/changelog
vendored
Normal file
8
debian/changelog
vendored
Normal file
@@ -0,0 +1,8 @@
|
||||
s3-genindex (1.0.0-1) unstable; urgency=medium
|
||||
|
||||
* Initial release
|
||||
* HTML directory index generator for local and S3 storage
|
||||
* Support for file type icons and responsive design
|
||||
* Watermark support and hierarchical S3 navigation
|
||||
|
||||
-- Pim van Pelt <pim@ipng.ch> Tue, 03 Dec 2025 14:30:00 +0100
|
||||
1
debian/compat
vendored
Normal file
1
debian/compat
vendored
Normal file
@@ -0,0 +1 @@
|
||||
10
|
||||
21
debian/control
vendored
Normal file
21
debian/control
vendored
Normal file
@@ -0,0 +1,21 @@
|
||||
Source: s3-genindex
|
||||
Section: utils
|
||||
Priority: optional
|
||||
Maintainer: Pim van Pelt <pim@ipng.ch>
|
||||
Build-Depends: debhelper (>= 10), golang-go
|
||||
Standards-Version: 4.1.2
|
||||
Homepage: https://git.ipng.ch/ipng/s3-genindex
|
||||
|
||||
Package: s3-genindex
|
||||
Architecture: any
|
||||
Depends: ${shlibs:Depends}, ${misc:Depends}
|
||||
Description: HTML directory index generator for local and S3 storage
|
||||
Generate HTML directory indexes with file type icons and responsive design
|
||||
for local directories and S3-compatible storage. This is particularly useful
|
||||
for S3 buckets that are publicly readable.
|
||||
.
|
||||
Features include local directory indexing with recursive traversal,
|
||||
S3-compatible storage support (MinIO, AWS S3, etc.), hierarchical directory
|
||||
structure for S3 buckets, responsive HTML design with file type icons,
|
||||
dry run mode for testing, flexible filtering with glob patterns and regex
|
||||
exclusion, and hidden file control.
|
||||
2
debian/install
vendored
Normal file
2
debian/install
vendored
Normal file
@@ -0,0 +1,2 @@
|
||||
s3-genindex usr/bin
|
||||
docs/s3-genindex.1 usr/share/man/man1
|
||||
20
debian/rules
vendored
Executable file
20
debian/rules
vendored
Executable file
@@ -0,0 +1,20 @@
|
||||
#!/usr/bin/make -f
|
||||
|
||||
export GO111MODULE=on
|
||||
export GOPROXY=direct
|
||||
export GOSUMDB=off
|
||||
export GOCACHE=$(CURDIR)/debian/.gocache
|
||||
export GOPATH=$(CURDIR)/debian/go
|
||||
|
||||
%:
|
||||
dh $@
|
||||
|
||||
override_dh_auto_build:
|
||||
go build -o s3-genindex ./cmd/s3-genindex
|
||||
|
||||
override_dh_auto_test:
|
||||
go test ./...
|
||||
|
||||
override_dh_auto_install:
|
||||
mkdir -p debian/s3-genindex/usr/bin
|
||||
cp s3-genindex debian/s3-genindex/usr/bin/
|
||||
126
docs/s3-genindex.1
Normal file
126
docs/s3-genindex.1
Normal file
@@ -0,0 +1,126 @@
|
||||
.TH S3-GENINDEX 1 "December 2025" "s3-genindex 1.0.0" "User Commands"
|
||||
.SH NAME
|
||||
s3-genindex \- Generate HTML directory indexes for local directories and S3 storage
|
||||
.SH SYNOPSIS
|
||||
.B s3-genindex
|
||||
[\fIOPTIONS\fR]
|
||||
.SH DESCRIPTION
|
||||
.B s3-genindex
|
||||
generates HTML directory indexes with file type icons and responsive design for local directories and S3-compatible storage. This is particularly useful for S3 buckets that are publicly readable.
|
||||
|
||||
The tool creates hierarchical directory structures with responsive HTML pages that include file type icons, sorting capabilities, and optional watermark branding.
|
||||
|
||||
By default, recursive processing is enabled, hidden files are included, and the output file is named 'index.html' with directory href appending enabled.
|
||||
|
||||
.SH OPTIONS
|
||||
.TP
|
||||
.BR \-d " \fIDIRECTORY\fR"
|
||||
Process local directory. Mutually exclusive with \-s3.
|
||||
|
||||
.TP
|
||||
.BR \-s3 " \fIURL\fR"
|
||||
Process S3-compatible storage. URL format: http://host:port/bucket or https://host/bucket.
|
||||
Mutually exclusive with \-d.
|
||||
|
||||
.TP
|
||||
.BR \-f " \fIGLOB\fR"
|
||||
Only include files matching glob pattern (default: "*").
|
||||
Example: "*.py" to include only Python files.
|
||||
|
||||
.TP
|
||||
.BR \-n
|
||||
Dry run mode. Show what would be written without actually creating files.
|
||||
|
||||
.TP
|
||||
.BR \-x " \fIREGEX\fR"
|
||||
Exclude files matching regular expression pattern.
|
||||
|
||||
.TP
|
||||
.BR \-v
|
||||
Verbose mode. List every processed file during operation.
|
||||
|
||||
.TP
|
||||
.BR \-i
|
||||
Show index.html files in directory listings (normally hidden).
|
||||
|
||||
.TP
|
||||
.BR \-wm " \fIURL\fR"
|
||||
Watermark logo URL to display in top left corner of generated pages.
|
||||
|
||||
.TP
|
||||
.BR \-\-version
|
||||
Show version information and exit.
|
||||
|
||||
.SH ENVIRONMENT
|
||||
For S3 operations, the following environment variables must be set:
|
||||
|
||||
.TP
|
||||
.B AWS_ACCESS_KEY_ID
|
||||
S3 access key ID for authentication.
|
||||
|
||||
.TP
|
||||
.B AWS_SECRET_ACCESS_KEY
|
||||
S3 secret access key for authentication.
|
||||
|
||||
.SH EXAMPLES
|
||||
.TP
|
||||
Process a local directory:
|
||||
.B s3-genindex -d /var/www/html
|
||||
|
||||
.TP
|
||||
Process an S3 bucket with verbose output:
|
||||
.B s3-genindex -v -s3 http://minio.example.com:9000/my-bucket
|
||||
|
||||
.TP
|
||||
Dry run with file filtering:
|
||||
.B s3-genindex -n -f "*.log" -d /var/log
|
||||
|
||||
.TP
|
||||
S3 processing with watermark and filtering:
|
||||
.B s3-genindex -v -f "*.jpg" -wm https://example.com/logo.svg -s3 https://s3.amazonaws.com/photos
|
||||
|
||||
.TP
|
||||
Show version information:
|
||||
.B s3-genindex --version
|
||||
|
||||
.SH FILES
|
||||
.TP
|
||||
.B index.html
|
||||
Default output filename for generated directory indexes.
|
||||
|
||||
.SH EXIT STATUS
|
||||
.TP
|
||||
.B 0
|
||||
Success
|
||||
.TP
|
||||
.B 1
|
||||
Error (invalid arguments, missing credentials, file system errors, etc.)
|
||||
|
||||
.SH FEATURES
|
||||
.IP \(bu 2
|
||||
Local directory indexing with recursive traversal
|
||||
.IP \(bu 2
|
||||
S3-compatible storage support (MinIO, AWS S3, etc.)
|
||||
.IP \(bu 2
|
||||
Hierarchical directory structure for S3 buckets
|
||||
.IP \(bu 2
|
||||
Responsive HTML design with file type icons
|
||||
.IP \(bu 2
|
||||
Dry run mode for testing
|
||||
.IP \(bu 2
|
||||
Flexible filtering with glob patterns and regex exclusion
|
||||
.IP \(bu 2
|
||||
Hidden file control and index.html visibility options
|
||||
.IP \(bu 2
|
||||
Watermark support for branding
|
||||
|
||||
.SH SEE ALSO
|
||||
.BR ls (1),
|
||||
.BR find (1),
|
||||
.BR tree (1)
|
||||
|
||||
.SH AUTHOR
|
||||
Pim van Pelt <pim@ipng.ch>
|
||||
|
||||
.SH COPYRIGHT
|
||||
Copyright \(co 2025 Pim van Pelt. Licensed under the APACHE-2.0 License.
|
||||
@@ -322,12 +322,16 @@ func ReadDirEntries(dirPath string, opts *Options) ([]FileEntry, error) {
|
||||
entry.Size = -1
|
||||
entry.SizePretty = "—"
|
||||
entry.IconType = "folder-symlink"
|
||||
fmt.Printf("dir-symlink %s\n", fullPath)
|
||||
if opts.Verbose {
|
||||
fmt.Printf("dir-symlink %s\n", fullPath)
|
||||
}
|
||||
} else if !file.IsDir() && entry.IsSymlink {
|
||||
entry.Size = info.Size()
|
||||
entry.SizePretty = PrettySize(entry.Size)
|
||||
entry.IconType = "symlink"
|
||||
fmt.Printf("file-symlink %s\n", fullPath)
|
||||
if opts.Verbose {
|
||||
fmt.Printf("file-symlink %s\n", fullPath)
|
||||
}
|
||||
} else {
|
||||
entry.Size = info.Size()
|
||||
entry.SizePretty = PrettySize(entry.Size)
|
||||
|
||||
Reference in New Issue
Block a user