https://github.com/willtheorangeguy/nginx-file-directory
The basic Nginx file directory page, as a simple HTML page.
https://github.com/willtheorangeguy/nginx-file-directory
directory file hacktoberfest nginx server
Last synced: 5 months ago
JSON representation
The basic Nginx file directory page, as a simple HTML page.
- Host: GitHub
- URL: https://github.com/willtheorangeguy/nginx-file-directory
- Owner: willtheorangeguy
- License: bsd-2-clause
- Created: 2021-09-29T02:15:48.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-08-14T21:33:31.000Z (6 months ago)
- Last Synced: 2025-08-14T23:24:10.835Z (6 months ago)
- Topics: directory, file, hacktoberfest, nginx, server
- Language: HTML
- Homepage: https://willtheorangeguy.github.io/Nginx-File-Directory/
- Size: 271 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
Nginx File Directory
The basic Nginx file directory page, as a simple HTML page.
Key Features •
Download •
How To Use •
Support •
Contributing •
Changelog •
Credits & Contributors
## Key Features
- Basic file directory view.
- Name and upload date.
- Folder and file links.
- Compatible with all web servers and websites.
- Cross platform.
## Download
You can **[download](https://github.com/willtheorangeguy/Nginx-File-Directory/releases/latest) the source code** to modify the code and create your own file directory page.
You can also access the **production version the website**, available on all platforms, **[here](https://willtheorangeguy.github.io/Nginx-File-Directory/)**.
## How To Use
To clone and run this website, you'll need [Git](https://git-scm.com/downloads) installed on your computer. If you would rather not use Git, you can just download the code from GitHub above. From your command line:
```bash
# Clone this repository
$ git clone https://github.com/willtheorangeguy/Nginx-File-Directory.git
# Go into the repository
$ cd Nginx-File-Directory
# Run the webpage
$ index.html
```
You can also pull the [Docker](https://www.docker.com/) image from GitHub Packages. From your command line:
```bash
# Pull image
$ docker pull ghcr.io/willtheorangeguy/nginx-file-directory:main
# Run container
$ docker run -d -p 8000:80 ghcr.io/willtheorangeguy/nginx-file-directory:main
# Now, navigate to localhost in your browser to see the webpage
```
However, **to make this your own directory**, follow the steps below:
### Basics
1. _Line 8_: Update the `directory` placeholder text between the `...` tags with the actual directory name. This will be the title of the webpage.
```html
Index of /directory
```
2. _Line 10_: Update the `directory` placeholder text between the `
...
` tags with the actual directory path. This will be the title displayed on the page.
```html
Index of /directory
```
3. _Line 13_: If this is a directory inside of another directory, remove the `` to uncomment the link to the directory above the current directory.
```html
```
4. _Line 13_: If this is a directory inside of another directory, change the `../` between the `...` tags with the actual link to the folder above.
### For a File or Folder
```html
folder/ MM-DD-YYYY HH:MM -
```
- Replace the `folder/` or `file/` link (between the `href="..."` tag) with the actual link to the file or folder.
- Replace the `folder/` or `file/` placeholder name (between the `...` tags) with the real name of the file or folder.
- Replace the `MM-DD-YYYY HH:MM` placeholder date with the date the file or folder was uploaded.
- Add more of these rows as necessary.
## Support
Further customization options for different types of files and folder structures can be found in [`CUSTOMIZATION`](https://github.com/willtheorangeguy/Nginx-File-Directory/blob/main/docs/CUSTOMIZATION.md). More documentation is available in the **[Documentation](https://github.com/willtheorangeguy/Nginx-File-Directory/tree/main/docs)** and on the **[Wiki](https://github.com/willtheorangeguy/Nginx-File-Directory/wiki)**. If more support is required, please open a **[GitHub Discussion](https://github.com/willtheorangeguy/Nginx-File-Directory/discussions/new)** or join our **[Discord](https://discord.gg/uQR9AfwBxU)**.
## Contributing
Please contribute using [GitHub Flow](https://guides.github.com/introduction/flow). Create a branch, add commits, and [open a pull request](https://github.com/willtheorangeguy/Nginx-File-Directory/compare).
Please read [`CONTRIBUTING`](CONTRIBUTING.md) for details on our [`CODE OF CONDUCT`](CODE_OF_CONDUCT.md), and the process for submitting pull requests to us.
## Changelog
See the [`CHANGELOG`](CHANGELOG.md) file for details.
## Credits
This software uses the following open source packages, projects, services or websites:
GitHub
W3C
W3Schools
Nginx
Web - Plans
Web - Donate
Web - Pro
Web
## Contributors
- [@willtheorangeguy](https://github.com/willtheorangeguy) - Sponsor on [PayPal](https://paypal.me/wvdg44?country.x=CA&locale.x=en_US)
## You may also like...
- [Running Calculator](https://github.com/willtheorangeguy/Running-Calculator) - A running speed calculator for any unit of distance.
- [PyWorkout](https://github.com/willtheorangeguy/PyWorkout) - A minimal CLI to keep you inspired during your workout! Easily used and customized, with support for multiple workout plans, different muscle groups and video workouts.
- [PyAvatar](https://github.com/willtheorangeguy/PyAvatar) - Easily display all of your creative avatars to keep them consistent across websites.
## License
**The website code in this repository is created by the [Nginx Development Team](https://nginx.org/) and maintained by the Nginx Authors. The server is released under the BSD 3-Clause License, and this project follows those licensing guidelines.**
This project is licensed under the [BSD 2-Clause “Simplified” License](https://choosealicense.com/licenses/bsd-2-clause/) - see the [`LICENSE`](LICENSE.md) file for details. See the [Privacy Policy](https://github.com/willtheorangeguy/Nginx-File-Directory/blob/main/docs/legal/PRIVACY.md) and [Terms and Conditions](https://github.com/willtheorangeguy/Nginx-File-Directory/blob/main/docs/legal/TERMS.md) for legal information.