https://github.com/ioistired/dirserver

Web directory indexer suited to my needs
https://github.com/ioistired/dirserver

flask hacktoberfest python

Last synced: 4 days ago
JSON representation

Web directory indexer suited to my needs

• Host: GitHub
• URL: https://github.com/ioistired/dirserver
• Owner: ioistired
• License: other
• Created: 2019-11-08T18:20:43.000Z (about 5 years ago)
• Default Branch: trunk
• Last Pushed: 2022-07-16T04:48:30.000Z (over 2 years ago)
• Last Synced: 2025-01-10T12:50:25.027Z (7 days ago)
• Topics: flask, hacktoberfest, python
• Language: Python
• Size: 116 KB
• Stars: 4
• Watchers: 1
• Forks: 1
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# dirserver

Simple directory indexing web server suited to my needs.

- Lists out all files for the given request path, which is relative to `DIRSERVER_BASE_PATH`.

- Intentionally does not serve static files. This should be handled by your webserver.

- Tries not to list directories outside of the web root.

- Produces a tar archive of any directory (except /, due to routing issues)

  - Symlinks are added as symlinks, not dereferenced.

## Configuration

All configuration is done via environment variables. There are three:

- `DIRSERVER_BASE_PATH`: the path to the root of all files to serve. Required.

- `DIRSERVER_EXCLUDE_HIDDEN`: whether to hide files whose name starts with a dot. Optional, defaults to `1`.

- `DIRSERVER_PLUS_AS_SPACE`: whether to use `+` instead of `%20` to represent space characters in URLs. Requires gunicorn. Defaults to `0`.

## License

- My code: BlueOak v1.0.0. See LICENSE.md for details.

- `tarfile_stream.py`: MIT. See that file's header for details.

- `templates/list.html`: Apache-2.0. See that file's header for more details.