Skip to content

Latest commit

 

History

History
50 lines (40 loc) · 1.61 KB

README.md

File metadata and controls

50 lines (40 loc) · 1.61 KB
Raw

apindex - static file index generator/load reducer

Generate a file index for Github Pages

img

Quick install

curl https://github.com/paperbenni/apindex/master/install.sh | bash

What is this?

This is a program that generates index.html files in each directory on your server that render the file tree. This is useful for static web servers that need support for file listing. One example of this is Github Pages.

It can also be used to reduce the server load for servers that serve static content, as the server does not need to generate the index each time it is accessed. Basically permanent cache.

The file icons are also embedded into the index.html file so there is no need for aditional HTTP requests.

Demo

The FTP archive of thinkpads.org is hosted on Github Pages and its generated with apindex. Check it out: https://thinkpads.org/ftp/

How do I use it?

Just run:

apindex <path-to-directory>

The index header server path is based on your current working directory. So if you run the script from /home/parent on the directory /home/parent/child like this:

cd /home/parent
apindex child/.

The index is generated as Index of /child. If you want it to be absolute to the child directory, then you run apindex from there.

cd /home/parent/child
apindex .

This renders Index of /.

How do I install it?

git clone https://github.com/paperbenni/apindex
cd apindex
cmake . -DCMAKE_INSTALL_PREFIX=/usr
sudo make install

How do I add/remove icons?

See share/icons.xml and the files under share/img/*.