Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
joshbeard committed Feb 22, 2024
1 parent 8b5b25a commit 9e9c85c
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 10 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Changelog

## 0.3.1 (2024-02-21)

* Add package tests

## 0.3.0 (2024-02-21)

* Sign artifacts with GPG
Expand Down
22 changes: 12 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,28 @@

Quick and simple program to generate basic directory index pages from a local
file directory or S3 bucket, such as a file listing page.
Nothing revolutionary, but I needed something like this for a project or two.
It's generic enough to possibly be useful for others. S3 doesn't provide
file list indexes natively.

<p align="center">
<img width="420" height="236" alt="screenshot" src=".github/readme/screenshot.png" />
</p>

This isn't a good solution for a dynamic listing of an S3 bucket (maybe try
Lambda), but it's simple and works for content that remains static between
deployments. If you're using Nginx, [fancyindex](https://www.nginx.com/resources/wiki/modules/fancy_index/)
does this dynamically with full customization. If you're using Apache,
[mod_autoindex](https://httpd.apache.org/docs/2.4/mod/mod_autoindex.html) is
deployments. This is particularly helpful for hosting static artifacts on S3,
since S3 doesn't natively offer content indexes.

If you're using Nginx, [fancy_index](https://www.nginx.com/resources/wiki/modules/fancy_index/)
is the right tool for the job and does this dynamically with full customization.
If you're using Apache, [mod_autoindex](https://httpd.apache.org/docs/2.4/mod/mod_autoindex.html) is
what you're looking for, maybe with something like [Apaxy](https://oupala.github.io/apaxy/).

## Usage

Download from the [releases](https://github.com/joshbeard/web-indexer/releases)
or use the [`joshbeard/web-indexer`](https://hub.docker.com/r/joshbeard/web-indexer)
Docker image.
Download packages from the [releases](https://github.com/joshbeard/web-indexer/releases),
use the Docker image from
[`ghcr.io/joshbeard/web-indexer/web-indexer`](https://github.com/joshbeard/web-indexer/pkgs/container/web-indexer%2Fweb-indexer)
or [`joshbeard/web-indexer`](https://hub.docker.com/r/joshbeard/web-indexer) on
the Docker Hub, use the [GitHub Action](#github-action) or a [GitLab job](#gitlab-ci).

```plain
Usage:
Expand Down Expand Up @@ -139,7 +141,7 @@ jobs:
-e AWS_SECRET_ACCESS_KEY=${{ secrets.AWS_SECRET_ACCESS_KEY }} \
-e AWS_REGION='us-east-1' \
-e CONFIG=.web-indexer.yml \
joshbeard/web-indexer:latest
ghcr.io/joshbeard/web-indexer/web-indexer:0.3.0
```

Refer to the [`action.yml`](action.yml) for all available inputs, which
Expand Down

0 comments on commit 9e9c85c

Please sign in to comment.