{"id":15435811,"url":"https://github.com/spring-raining/pretty-autoindex","last_synced_at":"2025-04-19T18:22:00.358Z","repository":{"id":46870653,"uuid":"50073620","full_name":"spring-raining/pretty-autoindex","owner":"spring-raining","description":"Show nginx autoindex more pretty!","archived":false,"fork":false,"pushed_at":"2021-09-22T05:07:10.000Z","size":311,"stargazers_count":43,"open_issues_count":5,"forks_count":7,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-24T02:11:17.908Z","etag":null,"topics":["autoindex","nginx","nginx-configuration","vue"],"latest_commit_sha":null,"homepage":"","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/spring-raining.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-01-21T01:39:13.000Z","updated_at":"2025-01-05T10:07:51.000Z","dependencies_parsed_at":"2022-09-26T18:31:28.909Z","dependency_job_id":null,"html_url":"https://github.com/spring-raining/pretty-autoindex","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spring-raining%2Fpretty-autoindex","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spring-raining%2Fpretty-autoindex/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spring-raining%2Fpretty-autoindex/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spring-raining%2Fpretty-autoindex/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/spring-raining","download_url":"https://codeload.github.com/spring-raining/pretty-autoindex/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241552028,"owners_count":19981069,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["autoindex","nginx","nginx-configuration","vue"],"created_at":"2024-10-01T18:46:13.972Z","updated_at":"2025-03-02T18:32:27.681Z","avatar_url":"https://github.com/spring-raining.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# pretty-autoindex\n\nShow nginx autoindex more pretty!\n\n![demo.gif](https://raw.githubusercontent.com/spring-raining/pretty-autoindex/gh-pages/static/demo.gif)\n\n## Installation\n\nDownload files to your server.\n\n```sh-session\n$ git clone https://github.com/spring-raining/pretty-autoindex.git\nor\n$ npm install pretty-autoindex\n```\n\nBefore using it, you need to set some nginx configurations.\n(In this expamle, The IP address and the port represent as `192.168.10.108:10080`\nso you should replace them as necessary.)\n\n```nginx\n# pretty-autoindex try to access this address, and display indexes dynamically.\nserver {\n    listen  10080;\n\n    location / {\n        root    /path/to/you/want/to/show;\n        autoindex   on;\n        autoindex_format    json;\n\n        # Enable your browser to access here.\n        add_header  Access-Control-Allow-Origin \"http://192.168.10.108\";\n        add_header  Access-Control-Allow-Methods \"GET, POST, OPTIONS\";\n        add_header  Access-Control-Allow-Headers \"Origin, Authorization, Accept\";\n        add_header  Access-Control-Allow-Credentials true;\n    }\n}\n\n# This is an actual page.\nserver {\n    listen  80;\n\n    location / {\n        root    /path/to/pretty-autoindex/dist;\n    }\n}\n```\n\nAnd set a conf variable in index.html.\n\n```sh-session\n$ vim /path/to/pretty-autoindex/dist/config.js\n```\n\n```javascript\nvar conf = {\n      name: 'A wonderful name that you want',\n      address: 'http://192.168.10.108:10080',\n\n      visibilityOptions: {\n          size: {\n              use: true,\n              type: 'readable' //raw, readable, both\n          },\n          date: {\n              use: true,\n              type: 'moment' //raw, moment, both\n          }\n      }\n};\n```\n\nThen, restart nginx and access `http://192.168.10.108`.\n\n**CAUTION!**\nIf you intend to open your page in public network, beware your nginx configuration\nand exclude files that you wouldn't like to expose from the directory.\n\n## Development\n\nTo build pretty-autoindex,\n\n1.  Install [Node.js](https://nodejs.org)\n\n2.  Install dependent libraries\n\n    ```sh-session\n    $ npm install\n    ```\n\n3.  Run build\n\n    ```sh-session\n    $ npm run build\n    ```\n\n## License\n\nMIT\n\n## Author\n\n[spring-raining](https://github.com/spring-raining)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspring-raining%2Fpretty-autoindex","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fspring-raining%2Fpretty-autoindex","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspring-raining%2Fpretty-autoindex/lists"}