Git Product home page Git Product logo

apindex-v2's Introduction

This repo is archived, use the new github actions

apindex - static file index generator/load reducer

Generate a file index for GitHub/GitLab Pages

enter image description here

Use with Github Actions

https://github.com/jayanta525/github-pages-directory-listing

workflow.yml

name: gh-pages
on: [push]

jobs:
  pages-directory-listing-index:
    runs-on: ubuntu-latest
    name: GH Pages Directory Listing
    steps:
      - name: Checkout Repository
        uses: actions/checkout@v3

      - name: Generate Directory Listings
        uses: jayanta525/[email protected]
        with:
          FOLDER: data

      - name: Deploy to Pages
        uses: JamesIves/[email protected]
        with:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          BRANCH: gh-pages
          FOLDER: data

Quick install

curl https://raw.githubusercontent.com/jayanta525/apindex-v2/master/sudo-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.

CI/CD Pipeline

The install script can be used with CI/CD with the required dependencies.

GitHub

deploy-to-gh-pages.yml

name: Build and Deploy
on:
  push:
    branches:
      - master
jobs:
  build-and-deploy:
    runs-on: ubuntu-18.04
    steps:
      - name: Checkout ๐Ÿ›Ž๏ธ
        uses: actions/[email protected]
        with:
          persist-credentials: false 

      - name: Install and Build ๐Ÿ”ง
        run: |
          sudo apt-get update
          sudo apt-get install curl git -y
          curl https://raw.githubusercontent.com/jayanta525/apindex-v2/master/sudo-install.sh | bash
          apindex .
      - name: Deploy ๐Ÿš€
        uses: JamesIves/[email protected]
        with:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          BRANCH: gh-pages
          FOLDER: .

Gitlab

gitlab-ci.yml

image: ubuntu:bionic
pages:
 script:
 - rm -rf .git*
 - apt-get update
 - apt-get install curl git -y
 - curl https://raw.githubusercontent.com/jayanta525/apindex-v2/master/sudo-install.sh | bash
 - apindex .
 - mkdir .public
 - cp -r * .public
 - mv .public public
 artifacts:
 paths:
 - public
 only:
 - master

Demo

This openwrt kmod download archive is hosted on GitHub/ GitLab Pages and its generated with apindex.

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 add/remove icons?

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

Original credits to:

apindex-v2's People

Contributors

jayanta525 avatar paperbenni avatar smclt30p avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.