Repository: AdamWhitcroft/apaxy
Branch: develop
Commit: 5b76e32d662f
Files: 30
Total size: 105.0 KB
Directory structure:
gitextract_l1p5zjri/
├── .github/
│ ├── ISSUE_TEMPLATE/
│ │ ├── bug_report.md
│ │ └── feature_request.md
│ └── PULL_REQUEST_TEMPLATE.md
├── .gitignore
├── CHANGELOG.md
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── COPYING.md
├── Dockerfile
├── README.md
├── apaxy/
│ ├── htaccess.txt
│ └── theme/
│ ├── .htaccess
│ ├── 400.html
│ ├── 403.html
│ ├── 404.html
│ ├── 408.html
│ ├── 500.html
│ ├── 502.html
│ ├── apaxy-lightgallery.js
│ ├── apaxy.js
│ ├── footer-lightgallery.html
│ ├── footer.html
│ ├── header-lightgallery.html
│ ├── header.html
│ └── style.css
├── apaxy-configure.sh
├── apaxy.config
├── docker-compose.yml
├── package.json
└── share/
└── PLACE_YOUR_FILES_HERE.txt
================================================
FILE CONTENTS
================================================
================================================
FILE: .github/ISSUE_TEMPLATE/bug_report.md
================================================
---
name: Bug report
about: Create a report to help us improve
---
**Describe the bug**
A clear and concise description of what the bug is.
**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
**Expected behavior**
A clear and concise description of what you expected to happen.
**Screenshots**
If applicable, add screenshots to help explain your problem.
**Desktop (please complete the following information):**
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]
**Smartphone (please complete the following information):**
- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]
**Additional context**
Add any other context about the problem here.
================================================
FILE: .github/ISSUE_TEMPLATE/feature_request.md
================================================
---
name: Feature request
about: Suggest an idea for this project
---
**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
**Describe the solution you'd like**
A clear and concise description of what you want to happen.
**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.
**Additional context**
Add any other context or screenshots about the feature request here.
================================================
FILE: .github/PULL_REQUEST_TEMPLATE.md
================================================
fixes #
## proposed changes
-
-
-
================================================
FILE: .gitignore
================================================
node_modules
.DS_Store
================================================
FILE: CHANGELOG.md
================================================
## [2.5.1](https://github.com/oupala/apaxy/compare/2.5.0...2.5.1) (2024-10-09)
### Bug Fixes
* lightgallery feature ([c7a1221](https://github.com/oupala/apaxy/commit/c7a1221bc7d92f6611a2d80255b3634e7f42d945)), closes [#160](https://github.com/oupala/apaxy/issues/160)
# [2.5.0](https://github.com/oupala/apaxy/compare/2.4.0...2.5.0) (2024-09-15)
### Bug Fixes
* Fixed typo in header ([cd741bc](https://github.com/oupala/apaxy/commit/cd741bcfc625b6120ff34c4d0b0147846aefb5d6))
* remove useless code for fixing hrefs ([b7d7d2a](https://github.com/oupala/apaxy/commit/b7d7d2aeb861e2b553546d089271d80b32b8e9c3))
* rendering on small (mobile) screens ([95ad6b9](https://github.com/oupala/apaxy/commit/95ad6b92be4eaa7b18394390bcc0a121d1342a88))
* update the required Apache version in README ([9ed650a](https://github.com/oupala/apaxy/commit/9ed650a4effc47c1696530f2f4baed130340aa86))
### Features
* HEIC files and uppercase filenames for LightGallery ([b76dc3b](https://github.com/oupala/apaxy/commit/b76dc3be4aa596e6313c063d15124eb65fcdedaf))
# [2.4.0](https://github.com/oupala/apaxy/compare/2.3.0...2.4.0) (2022-05-04)
### Bug Fixes
* update styles ([ab93a07](https://github.com/oupala/apaxy/commit/ab93a07b3e01032f8cbce5d266f5b49815edab1a))
### Features
* filter auto select on key down ([9debee6](https://github.com/oupala/apaxy/commit/9debee6005ab648d57da017c4f29c7fa507da6a8))
* prevent from suppressing HTML preamble ([bbe754b](https://github.com/oupala/apaxy/commit/bbe754bf34aa16bdfcac1a9c4cdcefbadbeacad8)), closes [#149](https://github.com/oupala/apaxy/issues/149)
# [2.3.0](https://github.com/oupala/apaxy/compare/2.2.0...2.3.0) (2021-04-23)
### Bug Fixes
* fix the doctype in the error pages ([0c75e64](https://github.com/oupala/apaxy/commit/0c75e64761939b1b1f02ae08a74bb64772bc4ac0))
* improve the way Faenza icons are embedded ([060d547](https://github.com/oupala/apaxy/commit/060d5478e46864fdc185e4c29db8d2cfe99eae93)), closes [#143](https://github.com/oupala/apaxy/issues/143)
* use <div class="center"> instead of <center> ([3bba904](https://github.com/oupala/apaxy/commit/3bba904d33fd4139b2e31f721612484590063cfa))
### Features
* switch to GPLv3 licence ([86fc8ee](https://github.com/oupala/apaxy/commit/86fc8ee74db4542f62bc342d960344838bfaf6b2)), closes [#148](https://github.com/oupala/apaxy/issues/148)
# [2.2.0](https://github.com/oupala/apaxy/compare/2.1.3...2.2.0) (2020-03-19)
### Bug Fixes
* **doc:** fix links in table of content ([cc02ee5](https://github.com/oupala/apaxy/commit/cc02ee5e65359a95315d7d848589d4f4b05b8e14))
* favicon not being loaded when using Apaxy in a subdirectory ([b9c2521](https://github.com/oupala/apaxy/commit/b9c25218f177b22ba0590706692d47f54986cd0d))
### Features
* optimize icons ([49289c4](https://github.com/oupala/apaxy/commit/49289c439cd032a95a4be93e1eb74f0fc7e821ef))
* **theme:** add a proper dark mode (and globally improve CSS styles) ([301c932](https://github.com/oupala/apaxy/commit/301c9329af1ceea467b786ce287ae5557a08002b))
## [2.1.3](https://github.com/oupala/apaxy/compare/2.1.2...2.1.3) (2019-07-18)
### Bug Fixes
* remove useless js ([afa2e51](https://github.com/oupala/apaxy/commit/afa2e51)), closes [#132](https://github.com/oupala/apaxy/issues/132)
## [2.1.2](https://github.com/oupala/apaxy/compare/2.1.1...2.1.2) (2019-06-04)
### Bug Fixes
* add gif extension to image gallery viewer ([5668b92](https://github.com/oupala/apaxy/commit/5668b92))
## [2.1.1](https://github.com/oupala/apaxy/compare/2.1.0...2.1.1) (2019-06-03)
### Bug Fixes
* improve cli parameters management ([8ca6129](https://github.com/oupala/apaxy/commit/8ca6129))
# [2.1.0](https://github.com/oupala/apaxy/compare/2.0.1...2.1.0) (2019-05-30)
### Features
* install script can set a header and a footer message ([8f85f2c](https://github.com/oupala/apaxy/commit/8f85f2c))
## [2.0.1](https://github.com/oupala/apaxy/compare/2.0.0...2.0.1) (2019-05-30)
### Bug Fixes
* make the script apaxy-configure.sh more robust ([367722a](https://github.com/oupala/apaxy/commit/367722a))
# [2.0.0](https://github.com/oupala/apaxy/compare/1.0.0...2.0.0) (2019-05-29)
### Bug Fixes
* filter content works again ([f8670f0](https://github.com/oupala/apaxy/commit/f8670f0)), closes [#125](https://github.com/oupala/apaxy/issues/125)
* invalid links from the root folder ([04b185d](https://github.com/oupala/apaxy/commit/04b185d))
* remove a minor typo in the Dockerfile ([08446fb](https://github.com/oupala/apaxy/commit/08446fb))
* remove dependency to font Open Sans ([bb8503b](https://github.com/oupala/apaxy/commit/bb8503b)), closes [#59](https://github.com/oupala/apaxy/issues/59) [#59](https://github.com/oupala/apaxy/issues/59)
* remove the leading slash before {FOLDERNAME} ([17475e1](https://github.com/oupala/apaxy/commit/17475e1))
* rename htaccess.txt in theme directory ([05ba73c](https://github.com/oupala/apaxy/commit/05ba73c))
* title and paths in error pages ([2eeb079](https://github.com/oupala/apaxy/commit/2eeb079))
### Features
* **css:** responsive design for small screen ([4471ec1](https://github.com/oupala/apaxy/commit/4471ec1)), closes [#29](https://github.com/oupala/apaxy/issues/29)
* add a breadcrumb ([33d4777](https://github.com/oupala/apaxy/commit/33d4777))
* add a favicon ([b393699](https://github.com/oupala/apaxy/commit/b393699)), closes [#128](https://github.com/oupala/apaxy/issues/128)
* add ebooks to supported filetypes ([1164a1b](https://github.com/oupala/apaxy/commit/1164a1b))
* add install script with instructions ([23f3b8e](https://github.com/oupala/apaxy/commit/23f3b8e))
* add lightgallery as lightbox gallery ([cc36486](https://github.com/oupala/apaxy/commit/cc36486)), closes [#89](https://github.com/oupala/apaxy/issues/89)
* Add styled error pages ([0e69f5d](https://github.com/oupala/apaxy/commit/0e69f5d))
* css styling for breadcrumb ([4d61aab](https://github.com/oupala/apaxy/commit/4d61aab))
* docker image ([f2a8144](https://github.com/oupala/apaxy/commit/f2a8144))
* replace lightGallery by lightgallery.js ([a1cfdd3](https://github.com/oupala/apaxy/commit/a1cfdd3))
<a name="1.0.0"></a>
# 1.0.0 (2018-02-21)
### Features
* Although it is a quite old piece of software (2012), here is the first release of apaxy.
================================================
FILE: CODE_OF_CONDUCT.md
================================================
# Contributor Covenant Code of Conduct
## Our Pledge
In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, sex characteristics, gender identity and expression,
level of experience, education, socio-economic status, nationality, personal
appearance, race, religion, or sexual identity and orientation.
## Our Standards
Examples of behavior that contributes to creating a positive environment
include:
* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members
Examples of unacceptable behavior by participants include:
* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
## Our Responsibilities
Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.
Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.
## Scope
This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at <contact@apaxy.33mail.com>. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.
Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
[homepage]: https://www.contributor-covenant.org
For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq
================================================
FILE: CONTRIBUTING.md
================================================
# Contributing to apaxy
First and foremost, thank you! We appreciate that you want to contribute
to apaxy, your time is valuable, and your contributions mean a lot to us.
## Important!
By contributing to this project, you:
- Agree that you have authored 100% of the content
- Agree that you have the necessary rights to the content
- Agree that you have received the necessary permissions from your
employer to make the contributions (if applicable)
- Agree that the content you contribute may be provided under the
Project license(s)
## Getting started
**What does "contributing" mean?**
Creating an issue is the simplest form of contributing to a project. Creating a
merge reques is more efficient form of contributing. But there are many ways to
contribute, including the following:
- Updating or correcting documentation
- Feature requests
- Bug reports
If you'd like to learn more about contributing in general, the [Guide to
Idiomatic
Contributing](https://github.com/jonschlinkert/idiomatic-contributing)
has a lot of useful information.
**Showing support for apaxy**
Please keep in mind that open source software is built by people like
you, who spend their free time creating things the rest the community
can use.
Don't have time to contribute? No worries, here are some other ways to
show your support for apaxy:
- star the [project](https://github.com/oupala/apaxy)
- tweet your support for apaxy
## Issues
### Before creating an issue
Please try to determine if the issue is caused by an underlying library,
and if so, create the issue there. Sometimes this is difficult to know.
We only ask that you attempt to give a reasonable attempt to find out.
Oftentimes the readme will have advice about where to go to create issues.
Try to follow these guidelines
- **Investigate the issue**:
- **Check the readme** - oftentimes you will find notes about creating
issues, and where to go depending on the type of issue
- Create the issue in the appropriate repository
### Creating an issue
Please be as descriptive as possible when creating an issue. Give us the
information we need to successfully answer your question or address your
issue by answering the following in your issue:
- **version**: please note the version of apaxy are you using
- **extensions, plugins, helpers, etc** (if applicable): please list any
extensions you're using
- **error messages**: please paste any error messages into the issue, or
a [gist](https://gist.github.com/)
### Closing issues
The original poster or the maintainer's of apaxy may close an issue at
any time. Typically, but not exclusively, issues are closed when:
- The issue is resolved
- The project's maintainers have determined the issue is out of scope
- An issue is clearly a duplicate of another issue, in which case the
duplicate issue will be linked
- A discussion has clearly run its course
## Pull requests
### Before creating a merge request
Please try to determine if the issue is caused by an underlying library,
and if so, create the merge request there. Sometimes this is difficult to know.
We only ask that you attempt to give a reasonable attempt to find out.
Oftentimes the readme will have advice about where to go to create merge
requests.
Try to follow these guidelines
- **Investigate the issue**:
- **Check the readme** - oftentimes you will find notes about creating
issues, and where to go depending on the type of issue
- Create the merge request in the appropriate repository
### Creating a merge request
Please be as descriptive as possible when creating a merge request. Give us the
information we need to successfully understand what you want to change or to add
to apaxy. Create the merge request as soon as possible so that the discussion
around your changes can start at the beginning of your work, not when it's over
and you don't time anymore to discuss it.
### Closing merge requests
The original poster or the maintainer's of apaxy may close a merge request at
any time. Typically, but not exclusively, issues are closed when:
- The merge request has conflict with the develop branch that makes it difficult
to merge without a hard work
- The commit message of each commit of the merge request does not follow the
[conventional commits](https://www.conventionalcommits.org/) standard
- The project's maintainers have determined the merge request is out of scope
- A merge request is clearly a duplicate of another merge request, in which case
the duplicate merge request will be linked
- A discussion has clearly run its course
## Next steps
**Tips for creating idiomatic issues**
Spending just a little extra time to review best practices and brush up
on your contributing skills will, at minimum, make your issue easier to
read, easier to resolve, and more likely to be found by others who have
the same or similar issue in the future. At best, it will open up doors
and potential career opportunities by helping you be at your best.
The following resources were hand-picked to help you be the most
effective contributor you can be:
- The [Guide to Idiomatic
Contributing](https://github.com/jonschlinkert/idiomatic-contributing)
is a great place for newcomers to start, but there is also information
for experienced contributors there
- Take some time to learn basic markdown. We can't stress this enough.
Don't start pasting code into GitHub issues before you've taken a moment
to review this [markdown
cheatsheet](https://gist.github.com/jonschlinkert/5854601)
- The GitHub guide to [basic
markdown](https://help.github.com/articles/markdown-basics/) is another
great markdown resource
- Learn about [GitHub Flavored
Markdown](https://help.github.com/articles/github-flavored-markdown/).
And if you want to really go above and beyond, read [mastering
markdown](https://guides.github.com/features/mastering-markdown/)
At the very least, please try to:
- Use backticks to wrap code. This ensures that it retains its
formatting and isn't modified when it's rendered by GitHub, and makes
the code more readable to others
- When applicable, use syntax highlighting by adding the correct
language name after the first "code fence"
================================================
FILE: COPYING.md
================================================
### GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc.
<https://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.
### Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom
to share and change all versions of a program--to make sure it remains
free software for all its users. We, the Free Software Foundation, use
the GNU General Public License for most of our software; it applies
also to any other work released this way by its authors. You can apply
it to your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you
have certain responsibilities if you distribute copies of the
software, or if you modify it: responsibilities to respect the freedom
of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the
manufacturer can do so. This is fundamentally incompatible with the
aim of protecting users' freedom to change the software. The
systematic pattern of such abuse occurs in the area of products for
individuals to use, which is precisely where it is most unacceptable.
Therefore, we have designed this version of the GPL to prohibit the
practice for those products. If such problems arise substantially in
other domains, we stand ready to extend this provision to those
domains in future versions of the GPL, as needed to protect the
freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish
to avoid the special danger that patents applied to a free program
could make it effectively proprietary. To prevent this, the GPL
assures that patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
### TERMS AND CONDITIONS
#### 0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds
of works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of
an exact copy. The resulting work is called a "modified version" of
the earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user
through a computer network, with no transfer of a copy, is not
conveying.
An interactive user interface displays "Appropriate Legal Notices" to
the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
#### 1. Source Code.
The "source code" for a work means the preferred form of the work for
making modifications to it. "Object code" means any non-source form of
a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users can
regenerate automatically from other parts of the Corresponding Source.
The Corresponding Source for a work in source code form is that same
work.
#### 2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not convey,
without conditions so long as your license otherwise remains in force.
You may convey covered works to others for the sole purpose of having
them make modifications exclusively for you, or provide you with
facilities for running those works, provided that you comply with the
terms of this License in conveying all material for which you do not
control copyright. Those thus making or running the covered works for
you must do so exclusively on your behalf, under your direction and
control, on terms that prohibit them from making any copies of your
copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under the
conditions stated below. Sublicensing is not allowed; section 10 makes
it unnecessary.
#### 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such
circumvention is effected by exercising rights under this License with
respect to the covered work, and you disclaim any intention to limit
operation or modification of the work as a means of enforcing, against
the work's users, your or third parties' legal rights to forbid
circumvention of technological measures.
#### 4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
#### 5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these
conditions:
- a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
- b) The work must carry prominent notices stating that it is
released under this License and any conditions added under
section 7. This requirement modifies the requirement in section 4
to "keep intact all notices".
- c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
- d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
#### 6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms of
sections 4 and 5, provided that you also convey the machine-readable
Corresponding Source under the terms of this License, in one of these
ways:
- a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
- b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the Corresponding
Source from a network server at no charge.
- c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
- d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
- e) Convey the object code using peer-to-peer transmission,
provided you inform other peers where the object code and
Corresponding Source of the work are being offered to the general
public at no charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal,
family, or household purposes, or (2) anything designed or sold for
incorporation into a dwelling. In determining whether a product is a
consumer product, doubtful cases shall be resolved in favor of
coverage. For a particular product received by a particular user,
"normally used" refers to a typical or common use of that class of
product, regardless of the status of the particular user or of the way
in which the particular user actually uses, or expects or is expected
to use, the product. A product is a consumer product regardless of
whether the product has substantial commercial, industrial or
non-consumer uses, unless such uses represent the only significant
mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to
install and execute modified versions of a covered work in that User
Product from a modified version of its Corresponding Source. The
information must suffice to ensure that the continued functioning of
the modified object code is in no case prevented or interfered with
solely because modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or
updates for a work that has been modified or installed by the
recipient, or for the User Product in which it has been modified or
installed. Access to a network may be denied when the modification
itself materially and adversely affects the operation of the network
or violates the rules and protocols for communication across the
network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
#### 7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders
of that material) supplement the terms of this License with terms:
- a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
- b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
- c) Prohibiting misrepresentation of the origin of that material,
or requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
- d) Limiting the use for publicity purposes of names of licensors
or authors of the material; or
- e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
- f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions
of it) with contractual assumptions of liability to the recipient,
for any liability that these contractual assumptions directly
impose on those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions; the
above requirements apply either way.
#### 8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your license
from a particular copyright holder is reinstated (a) provisionally,
unless and until the copyright holder explicitly and finally
terminates your license, and (b) permanently, if the copyright holder
fails to notify you of the violation by some reasonable means prior to
60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
#### 9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or run
a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
#### 10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
#### 11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims owned
or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within the
scope of its coverage, prohibits the exercise of, or is conditioned on
the non-exercise of one or more of the rights that are specifically
granted under this License. You may not convey a covered work if you
are a party to an arrangement with a third party that is in the
business of distributing software, under which you make payment to the
third party based on the extent of your activity of conveying the
work, and under which the third party grants, to any of the parties
who would receive the covered work from you, a discriminatory patent
license (a) in connection with copies of the covered work conveyed by
you (or copies made from those copies), or (b) primarily for and in
connection with specific products or compilations that contain the
covered work, unless you entered into that arrangement, or that patent
license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
#### 12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under
this License and any other pertinent obligations, then as a
consequence you may not convey it at all. For example, if you agree to
terms that obligate you to collect a royalty for further conveying
from those to whom you convey the Program, the only way you could
satisfy both those terms and this License would be to refrain entirely
from conveying the Program.
#### 13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
#### 14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions
of the GNU General Public License from time to time. Such new versions
will be similar in spirit to the present version, but may differ in
detail to address new problems or concerns.
Each version is given a distinguishing version number. If the Program
specifies that a certain numbered version of the GNU General Public
License "or any later version" applies to it, you have the option of
following the terms and conditions either of that numbered version or
of any later version published by the Free Software Foundation. If the
Program does not specify a version number of the GNU General Public
License, you may choose any version ever published by the Free
Software Foundation.
If the Program specifies that a proxy can decide which future versions
of the GNU General Public License can be used, that proxy's public
statement of acceptance of a version permanently authorizes you to
choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
#### 15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT
WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND
PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE
DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR
CORRECTION.
#### 16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR
CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES
ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT
NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR
LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM
TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER
PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
#### 17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
### How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these
terms.
To do so, attach the following notices to the program. It is safest to
attach them to the start of each source file to most effectively state
the exclusion of warranty; and each file should have at least the
"copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper
mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
<program> Copyright (C) <year> <name of author>
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands \`show w' and \`show c' should show the
appropriate parts of the General Public License. Of course, your
program's commands might be different; for a GUI interface, you would
use an "about box".
You should also get your employer (if you work as a programmer) or
school, if any, to sign a "copyright disclaimer" for the program, if
necessary. For more information on this, and how to apply and follow
the GNU GPL, see <https://www.gnu.org/licenses/>.
The GNU General Public License does not permit incorporating your
program into proprietary programs. If your program is a subroutine
library, you may consider it more useful to permit linking proprietary
applications with the library. If this is what you want to do, use the
GNU Lesser General Public License instead of this License. But first,
please read <https://www.gnu.org/licenses/why-not-lgpl.html>.
================================================
FILE: Dockerfile
================================================
# bash docker image will be used for configuring apaxy
FROM bash
# set apaxyPath to the path where you want apaxy to be installed
# by default, apaxy will be available at "/" (web root)
ARG apaxyPath=""
# copy apaxy and proceed to configuration
WORKDIR /
COPY . /
RUN bash apaxy-configure.sh -w "${apaxyPath}"
# httpd docker image will be used for running apaxy
FROM httpd:2.4
# set apaxyPath to the path where you want apaxy to be installed
# by default, apaxy will be available at "/" (web root)
ARG apaxyPath=""
# image labels and description
LABEL name="apaxy" \
description="Apaxy is a customisable theme built to enhance the experience of browsing web directories. It uses the mod_autoindex Apache module — and some CSS — to override the default style of a directory listing" \
maintainer="Ploc" \
url="https://oupala.github.io/apaxy/"
# remove index.html file from original httpd image
RUN rm /usr/local/apache2/htdocs/index.html
# enable apache config to be overridden by .htaccess files
RUN sed -i '/<Directory "\/usr\/local\/apache2\/htdocs">/,/<\/Directory>/ s/AllowOverride None/AllowOverride Options Indexes FileInfo/' /usr/local/apache2/conf/httpd.conf
# define apache listen port on a port greater than 1024 to allow a non-root user to start apache
RUN sed -i 's/Listen\ 80/Listen\ 8080/g' /usr/local/apache2/conf/httpd.conf
EXPOSE 8080
# create 'me' group whith gid 1000 and 'me' user in this group with uid 1000
# see https://docs.openshift.com/enterprise/3.2/creating_images/guidelines.html#use-uid
RUN groupadd -f -g 1000 me && \
useradd -u 1000 -g me me
# copy apaxy directory
COPY --from=0 /var/www/html${apaxyPath} /usr/local/apache2/htdocs${apaxyPath}
WORKDIR /usr/local/apache2/htdocs${apaxyPath}
RUN for file_extension in 3dml 3ds 3g2 3gp 7z aac adp ai aif aifc aiff apk appcache asf asm asx atom au avi azw bat bin bmp bpk btif bz bz2 c cab caf cb7 cba cbr cbt cbz cc cgm class cmx com conf cpp css csv curl cxx dcurl deb def deploy dic diff dist distz djv djvu dll dmg dms doc docx dot dra dsc dtd dts dtshd dump dvb dwg dxf ecelp4800 ecelp7470 ecelp9600 elc eol eps epub etx exe f f4v f77 f90 fbs fh fh4 fh5 fh7 fhc flac fli flv flx fly for fpx fst fvt g3 gif gv gz gzip h h261 h263 h264 hh hpp htm html ico ics ief ifb in iso jad jar java jpe jpeg jpg jpgm jpgv jpm js json kar ktx latex list log lrf lvp m1v m2a m2v m3a m3u m3u8 m4a m4u m4v Makefile man mar markdown mcurl md mdb mdi me mid midi mj2 mjp2 mk3d mka mks mkv mmr mng mobi mov movie mp2 mp2a mp3 mp4 mp4a mp4v mpe mpeg mpg mpg4 mpga mpkg ms msi mxu n3 nfo npx odb odc odf odft odg odi odm odp ods odt oga ogg ogv opml otc otf otg oth oti otp ots ott p pas patch pbm pct pcx pdf pgm php phtml pic pkg pls png pnm pot ppm pps ppsx ppt pptx prc ps psd py pya pyv qt ra ram rar ras rb README rgb rip rlc rmi rmp roff rpm rss rtf rtx s s3m sass scss scurl sfv sgi sgm sgml sh sid sil smv snd so spot spx sql sub svg svgz t tar tex text tga tif tiff torrent tr tsv ttc ttf ttl txt udeb uri uris urls uu uva uvg uvh uvi uvm uvp uvs uvu uvv uvva uvvg uvvh uvvi uvvm uvvp uvvs uvvu uvvv vcard vcf vcs viv vob wav wax wbmp wdp weba webm webp wm wma wml wmls wmv wmx woff woff2 wvx xbm xcf xht xhtml xif xla xlc xlm xls xlsx xlt xlw xm xml xpm xwd xsl zip; do touch example.${file_extension}; done
RUN touch README
# allow user 'me' to read apache's files
RUN chown -R me:root /usr/local/apache2/ && \
chmod -R g+rwX /usr/local/apache2/
# start container as me
USER me
================================================
FILE: README.md
================================================
# Apaxy
apaxy is a customisable theme built to enhance the experience of browsing web directories. It uses the `mod_autoindex` Apache module - and some css - to override the default style of a directory listing.
## Table of contents
- [features](#features)
- [installation](#installation)
- [docker image](#docker-image)
- [apaxy themes](#apaxy-themes)
- [media types](#media-types)
- [gallery](#gallery)
- [troubleshooting](#troubleshooting)
- [credits](#credits)
## Features
Apaxy may be basic, but it gives you a great deal of creative freedom when styling your directory.
- style your directory listing with css
- make it pop with javascript
- add welcome messages, download instructions or copyright notices
- add custom media type icons (requires editing the `.htaccess` file)
- use custom error pages
*Sadly, visual style is all you can work with. It's not possible to alter the generated table structure of the listing directory with Apaxy.*
## Installation
apaxy requires an apache (2.4+) http server. The configuration of the apache http server have to set an `AllowOverride` statement for the Apaxy styled folder:
```apache
AllowOverride Options Indexes FileInfo
```
### Quick start
If you would like, you can automate the installation of Apaxy with the included `apaxy-configure.sh` script.
To get started, first open `apaxy.config` in your favorite editor, then edit the `apacheWebRootPath` and `installWebPath` variables to correspond to your server's settings. Save the file and exit.
You can set some parameters of `apaxy.config` on the command line instead of the config file. You can see the documentation of the cli with the following command: `apaxy-configure.sh -h`.
Then run the configuration script as a user that can write to the `installWebPath` directory. With apache under debian, this would be the `www-data` user:
```bash
$ sudo -u www-data ./apaxy-configure.sh
```
The files will be copied to the web server directory, and modified automatically based on the settings specified.
### Manual install
Let's assume you have a folder named `share` in your server root directory (the path thus being `http://mywebsite.com/share`) that you'd like to use as your listing directory:
- [download](https://github.com/oupala/apaxy/archive/main.zip) and unzip apaxy
- copy and paste the contents of the `/apaxy` folder to your `/share` folder
- edit `htaccess.txt` (now in the `/share` folder) and update all instances of paths marked with *{FOLDERNAME}* to point to your site root
So...
```apache
AddIconByType (gif,{FOLDERNAME}/theme/icons/gif.png) image/gif
```
Should be changed to...
```apache
AddIconByType (gif,/share/theme/icons/gif.png) image/gif
```
- if you want to enable the [gallery](#gallery) feature, overwrite the header and footer files:
```bash
mv footer-lightgallery.html footer.html
mv header-lightgallery.html header.html
```
- edit `footer.html`, along with all the other `html` documents (in the `/share/theme` folder) and update all instances of paths marked with *{FOLDERNAME}* to point to your site root
So...
```html
<script src={FOLDERNAME}/theme/apaxy.js></script>
```
Should be changed to...
```html
<script src=/share/theme/apaxy.js></script>
```
- once done, rename `htaccess.txt` to `.htaccess` in the `/share` directory
- [treat yo'self](http://25.media.tumblr.com/tumblr_lw7q28y0Mz1qanm80o1_500.gif), you're done!
## Docker image
A [local Demo](http://localhost:8080) can be started with docker.
```bash
docker-compose up
```
## Apaxy themes
If you'd like to alter the default Apaxy theme, look in the `/theme` folder and you'll find the following files:
- `header.html`
- `footer.html`
- `style.css`
Edit these as you would any other html or css file.
Adding your own icons is a little more involved. You'll need to edit the main Apaxy `.htaccess` file. Look for the following as an example:
```apache
AddIconByType (gif,{FOLDERNAME}/theme/icons/gif.png) image/gif
```
The above rule will assign an icon named `gif.png` from the directory `{FOLDERNAME}/theme/icons/` to any file whose media type is `image/gif`.
This url path is relative to your site's root.
## Media types
The default apaxy theme `/themes/apaxy` has icons in place for the following media types:
3dml 3ds 3g2 3gp 7z aac adp ai aif aifc aiff apk appcache asf asm asx atom au avi azw bat bin bmp bpk btif bz bz2 c cab caf cb7 cba cbr cbt cbz cc cgm class cmx com conf cpp css csv curl cxx dcurl deb def deploy dic diff dist distz djv djvu dll dmg dms doc docx dot dra dsc dtd dts dtshd dump dvb dwg dxf ecelp4800 ecelp7470 ecelp9600 elc eol eps epub etx exe f f4v f77 f90 fbs fh fh4 fh5 fh7 fhc flac fli flv flx fly for fpx fst fvt g3 gif gv gz gzip h h261 h263 h264 hh hpp htm html ico ics ief ifb in iso jad jar java jpe jpeg jpg jpgm jpgv jpm js json kar ktx latex list log lrf lvp m1v m2a m2v m3a m3u m3u8 m4a m4u m4v Makefile man mar markdown mcurl md mdb mdi me mid midi mj2 mjp2 mk3d mka mks mkv mmr mng mobi mov movie mp2 mp2a mp3 mp4 mp4a mp4v mpe mpeg mpg mpg4 mpga mpkg ms msi mxu n3 nfo npx odb odc odf odft odg odi odm odp ods odt oga ogg ogv opml otc otf otg oth oti otp ots ott p pas patch pbm pct pcx pdf pgm php phtml pic pkg pls png pnm pot ppm pps ppsx ppt pptx prc ps psd py pya pyv qt ra ram rar ras rb README rgb rip rlc rmi rmp roff rpm rss rtf rtx s s3m sass scss scurl sfv sgi sgm sgml sh sid sil smv snd so spot spx sql sub svg svgz t tar tex text tga tif tiff torrent tr tsv ttc ttf ttl txt udeb uri uris urls uu uva uvg uvh uvi uvm uvp uvs uvu uvv uvva uvvg uvvh uvvi uvvm uvvp uvvs uvvu uvvv vcard vcf vcs viv vob wav wax wbmp wdp weba webm webp wm wma wml wmls wmv wmx woff woff2 wvx xbm xht xhtml xif xla xlc xlm xls xlsx xlt xlw xm xml xpmxwd xsl zip
## Gallery
You can enable a gallery feature on apaxy. This feature is based on [lightgallery.js](https://sachinchoolur.github.io/lightgallery.js/).
See [installation](#installation) section for more information.
## Troubleshooting
Make sure the options set in `.htaccess` files of Apaxy can actually be changed. This means that you need to allow to override the used options in your apache configuration of the directory apaxy used with: `AllowOverride Indexes`.
Find more information in the in the [apache documentation](https://httpd.apache.org/docs/current/mod/core.html#allowoverride).
## Credits
apaxy owes its existence to the amazing [h5ai](http://larsjung.de/h5ai/) by [Lars Jung](https://twitter.com/lrsjng). Had I not seen this, I would never have looked into making my own (probably way less useful) version.
[Faenza icons](http://tiheum.deviantart.com/art/Faenza-Icons-173323228) are used in the `apaxy` theme. [Faenza icon theme](https://code.google.com/archive/p/faenza-icon-theme/) has been released under GPLv3 licence.
## Licence
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.
================================================
FILE: apaxy/htaccess.txt
================================================
#
# apaxy
# Copyright (C) 2021 @adamwhitcroft
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
#
# for a full breakdown of the mod_autoindex module:
# http://apache.org/docs/2.4/mod/mod_autoindex.html
#
#
# official media types list from IANA
# https://www.iana.org/assignments/media-types/media-types.xhtml
#
# media types included in apache
# https://svn.apache.org/repos/asf/httpd/httpd/trunk/docs/conf/mime.types
#
# enable indexing
Options +Indexes
# index options
IndexOptions +Charset=UTF-8 +FancyIndexing +FoldersFirst +HTMLTable +IconsAreLinks +IgnoreCase +NameWidth=* +SuppressDescription +SuppressRules +XHTML -SuppressHTMLPreamble
# favicon & meta viewport
IndexHeadInsert "\
<link rel=\"shortcut icon\" href=\"{FOLDERNAME}/theme/favicon.ico\" />\
<meta name=\"viewport\" content=\"width=device-width, initial-scale=1\" />"
# hide ".htaccess" file and "/theme" directory
IndexIgnore .htaccess /theme
#
# general icons (blank, directory, parent directory)
#
#
# replace {FOLDERNAME} with your directory url
#
# if your directory is http://mywebsite.com/share/ you would change to:
#
# AddIcon /share/theme/icons/empty.svg ^^BLANKICON^^
#
AddIcon {FOLDERNAME}/theme/icons/empty.svg ^^BLANKICON^^
AddIcon {FOLDERNAME}/theme/icons/folder.svg ^^DIRECTORY^^
AddIcon {FOLDERNAME}/theme/icons/user-home.svg ..
#
# unused icons (that should be soon removed)
#
# folder-open.svg => maybe a js when a folder is hovered
# folder-document.svg
#
#
# image
#
# ext: ai eps ps
AddIconByType (ps,{FOLDERNAME}/theme/icons/image-x-eps.svg) application/postscript
# ext: bmp
AddIconByType (bmp,{FOLDERNAME}/theme/icons/image-bmp.svg) image/bmp
# ext: gif
AddIconByType (gif,{FOLDERNAME}/theme/icons/image-gif.svg) image/gif
# ext: ico
AddIconByType (ico,{FOLDERNAME}/theme/icons/image-x-ico.svg) image/x-icon
# ext: jpg jpeg jpe
AddIconByType (jpg,{FOLDERNAME}/theme/icons/image-jpeg.svg) image/jpeg
# ext: png
AddIconByType (png,{FOLDERNAME}/theme/icons/image-png.svg) image/png
# ext: psd
AddIconByType (psd,{FOLDERNAME}/theme/icons/image-x-psd.svg) image/vnd.adobe.photoshop
# ext: svg svgz
AddIconByType (draw,{FOLDERNAME}/theme/icons/x-office-drawing.svg) image/svg+xml
# ext: tiff tif
AddIconByType (tiff,{FOLDERNAME}/theme/icons/image-tiff.svg) image/tiff
# xcf media type not yet included in apache, fallback to AddIcon
# ext: xcf
#AddIconByType (xcf,{FOLDERNAME}/theme/icons/image-x-xcf.svg) image/x-xcf
AddIcon {FOLDERNAME}/theme/icons/image-x-xcf.svg .xcf
# all other images
# ext: bmp cgm g3 gif ief jpeg jpg jpe ktx png btif sgi svg svgz tiff tif psd uvi uvvi uvg uvvg djvu djv sub dwg dxf fbs fpx fst mmr rlc mdi wdp npx wbmp xif webp 3ds ras cmx fh fhc fh4 fh5 fh7 ico sid pcx pic pct pnm pbm pgm ppm rgb tga xbm xpm xwd
# ext: odg
# ext: otg
# ext: odi
# ext: oti
AddIconByType (image,{FOLDERNAME}/theme/icons/image-x-generic.svg) image/* \
application/vnd.oasis.opendocument.graphics \
application/vnd.oasis.opendocument.graphics-template \
application/vnd.oasis.opendocument.image \
application/vnd.oasis.opendocument.image-template
#
# audio
#
# audio playlist
# ext: m3u
# ext: m3u8
# ext: pls
AddIconByType (playlist,{FOLDERNAME}/theme/icons/audio-x-mp3-playlist.svg) audio/x-mpegurl \
application/vnd.apple.mpegurl \
application/pls+xml
# all audio
# ext: adp au snd mid midi kar rmi m4a mp4a mpga mp2 mp2a mp3 m2a m3a oga ogg spx s3m sil uva uvva eol dra dts dtshd lvp pya ecelp4800 ecelp7470 ecelp9600 rip weba aac aif aiff aifc caf flac mka m3u wax wma xm rmp ram ra wav
AddIconByType (audio,{FOLDERNAME}/theme/icons/audio-x-generic.svg) audio/*
#
# video
#
# video playlist
# ext: mxu m4u
AddIconByType (playlist,{FOLDERNAME}/theme/icons/video-x-generic.svg) video/vnd.mpegurl
# all video
# ext: 3g2 3gp h261 h263 h264 jpgv jpm jpgm mj2 mjp2 mp4 mp4v mpg4 mpeg mpg mpe m1v m2v ogv qt mov uvh uvvh uvm uvvm uvp uvvp uvs uvvs uvv uvvv dvb fvt mxu m4u pyv uvu uvvu viv webm f4v fli flv m4v mkv mk3d mks mng asf asx avi vob wmv wm wmx wvx movie smv
AddIconByType (video,{FOLDERNAME}/theme/icons/video-x-generic.svg) video/*
#
# internet
#
# ext: html htm
# ext: xhtml xht
# ext: uri uris urls
AddIconByType (html,{FOLDERNAME}/theme/icons/text-html.svg) text/html \
application/xhtml+xml \
text/uri-list
# ext: rss
# ext: atom
AddIconByType (rss,{FOLDERNAME}/theme/icons/application-rss+xml.svg) application/rss+xml \
application/atom+xml
# ext: ics ifb
# ext: vcs
AddIconByType (vcal,{FOLDERNAME}/theme/icons/evolution-calendar.svg) text/calendar \
text/x-vcalendar
# ext: vcard
# ext: vcf
AddIconByType (vcard,{FOLDERNAME}/theme/icons/addressbook.svg) text/vcard \
text/x-vcard
# ext: torrent
AddIconByType (torrent,{FOLDERNAME}/theme/icons/application-x-bittorrent.svg) application/x-bittorrent
#
# office
#
# ext: odc
# ext: otc
# ext: odf
# ext: odft
# ext: ods
# ext: ots
# ext: csv
# ext: xls xlm xla xlc xlt xlw
# ext: xlsx
AddIconByType (calc,{FOLDERNAME}/theme/icons/x-office-spreadsheet.svg) application/vnd.oasis.opendocument.chart \
application/vnd.oasis.opendocument.chart-template \
application/vnd.oasis.opendocument.formula \
application/vnd.oasis.opendocument.formula-template \
application/vnd.oasis.opendocument.spreadsheet \
application/vnd.oasis.opendocument.spreadsheet-template \
text/csv \
application/vnd.ms-excel \
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
# ext: odt
# ext: odm
# ext: ott
# ext: oth
# ext: doc dot
# ext: docx
AddIconByType (doc,{FOLDERNAME}/theme/icons/x-office-document.svg) application/vnd.oasis.opendocument.text \
application/vnd.oasis.opendocument.text-master \
application/vnd.oasis.opendocument.text-template \
application/vnd.oasis.opendocument.text-web \
application/msword \
application/vnd.openxmlformats-officedocument.wordprocessingml.document
# ext: odp
# ext: otp
# ext: ppt pps pot
# ext: pptx
# ext: ppsx
AddIconByType (slideshow,{FOLDERNAME}/theme/icons/x-office-presentation.svg) application/vnd.oasis.opendocument.presentation \
application/vnd.oasis.opendocument.presentation-template \
application/vnd.ms-powerpoint \
application/vnd.openxmlformats-officedocument.presentationml.presentation \
application/vnd.openxmlformats-officedocument.presentationml.slideshow
# ext: mdb
# ext: odb
AddIconByType (database,{FOLDERNAME}/theme/icons/text-x-sql.svg) application/x-msaccess \
application/vnd.oasis.opendocument.database
# ext: pdf
AddIconByType (pdf,{FOLDERNAME}/theme/icons/application-pdf.svg) application/pdf
# ext: rtf
AddIconByType (rtf,{FOLDERNAME}/theme/icons/text-richtext.svg) application/rtf
# ext: latex
# ext: tex
AddIconByType (tex,{FOLDERNAME}/theme/icons/text-x-tex.svg) application/x-latex \
application/x-tex
#
# programming
#
# h media type not yet included in apache, fallback to AddIcon
# ext: h
#AddIconByType (h,{FOLDERNAME}/theme/icons/text-x-chdr.svg) text/x-h
AddIcon {FOLDERNAME}/theme/icons/text-x-chdr.svg .h
# hpp files do not have a specific media type, fallback to AddIcon
# ext: hpp
AddIcon {FOLDERNAME}/theme/icons/text-x-c++hdr.svg .hpp
# cpp files do not have a specific media type, fallback to AddIcon
# ext: cpp
AddIcon {FOLDERNAME}/theme/icons/text-x-c++.svg .cpp
# ext: c cc cxx cpp h hh dic
AddIconByType (c,{FOLDERNAME}/theme/icons/text-x-c.svg) text/x-c
# ext: java
# ext: jar
# ext: class
AddIconByType (java,{FOLDERNAME}/theme/icons/text-x-java.svg) text/x-java-source \
application/java-archive \
application/java-vm
# sass and scss files do not have a specific media type, fallback to AddIcon
# ext: sass scss
AddIcon {FOLDERNAME}/theme/icons/text-css.svg .sass .scss
# ext: css
AddIconByType (css,{FOLDERNAME}/theme/icons/text-css.svg) text/css
# ext: js
# ext: json
AddIconByType (js,{FOLDERNAME}/theme/icons/text-x-javascript.svg) application/javascript \
application/json
# diff and patch files do not have a specific media type, fallback to AddIcon
# ext: diff patch
AddIcon {FOLDERNAME}/theme/icons/text-x-source.svg .diff .patch
# makefile files do not have a specific media type, fallback to AddIcon
# ext: Makefile
AddIcon {FOLDERNAME}/theme/icons/text-x-makefile.svg Makefile
# php files do not have a specific media type, fallback to AddIcon
# ext: php phtml
AddIcon {FOLDERNAME}/theme/icons/application-x-php.svg .php .phtml
# python files do not have a specific media type, fallback to AddIcon
# ext: py
AddIcon {FOLDERNAME}/theme/icons/text-x-python.svg .py
# ruby files do not have a specific media type, fallback to AddIcon
# ext: rb
AddIcon {FOLDERNAME}/theme/icons/application-x-ruby.svg .rb
# ext: sql
AddIconByType (sql,{FOLDERNAME}/theme/icons/text-x-sql.svg) application/x-sql
# ext: xml xsl
# ext: dtd
AddIconByType (xml,{FOLDERNAME}/theme/icons/text-xml.svg) application/xml \
application/xml-dtd
#
# sysadmin
#
# pkg files do not have a specific media type, fallback to AddIcon
# ext: pkg
AddIcon {FOLDERNAME}/theme/icons/package-x-generic.svg .pkg
# ext: bin dms lrf mar so dist distz pkg bpk dump elc deploy
AddIconByType (bin,{FOLDERNAME}/theme/icons/multipart-encrypted.svg) application/octet-stream
# ext: iso
AddIconByType (cd,{FOLDERNAME}/theme/icons/application-x-cd-image.svg) application/x-iso9660-image
# ext: deb udeb
AddIconByType (deb,{FOLDERNAME}/theme/icons/deb.svg) application/x-debian-package
# msi files do not have a specific media type, fallback to AddIcon
# ext: msi
AddIcon {FOLDERNAME}/theme/icons/text-x-install.svg .msi
# ext: exe dll com bat msi
AddIconByType (exe,{FOLDERNAME}/theme/icons/application-x-ms-dos-executable.svg) application/x-msdownload
# ext: dmg
# ext: mpkg
# ext: apk
AddIconByType (package,{FOLDERNAME}/theme/icons/package-x-generic.svg) application/x-apple-diskimage \
application/vnd.apple.installer+xml \
application/vnd.android.package-archive
# rpm files do not have a specific media type, fallback to AddIcon
# ext: rpm
AddIcon {FOLDERNAME}/theme/icons/rpm.svg .rpm
# ext: sh
AddIconByType (script,{FOLDERNAME}/theme/icons/text-x-script.svg) application/x-sh
# ext: ttc otf ttf woff2 woff
AddIconByType (font,{FOLDERNAME}/theme/icons/font-x-generic.svg) font/*
#
# archives
#
# ext: gz
AddIconByType (gzip,{FOLDERNAME}/theme/icons/application-x-archive.svg) application/x-gzip
# gzip media type does not include .gzip file extension, fallback to AddIcon
# ext: gzip
AddIcon {FOLDERNAME}/theme/icons/application-x-archive.svg .gzip
# ext: rar
AddIconByType (rar,{FOLDERNAME}/theme/icons/application-x-rar.svg) application/x-rar-compressed
# ext: tar
AddIconByType (tar,{FOLDERNAME}/theme/icons/application-x-tar.svg) application/x-tar
# ext: zip
AddIconByType (zip,{FOLDERNAME}/theme/icons/application-x-zip.svg) application/zip
# ext: 7z bz bz2 cab
AddIconByType (archive,{FOLDERNAME}/theme/icons/application-x-archive.svg) application/x-7z-compressed \
application/x-bzip \
application/x-bzip2 \
application/vnd.ms-cab-compressed
#
# books
#
# ext: cbr cba cbt cbz cb7
AddIconByType (text,{FOLDERNAME}/theme/icons/image-x-generic.svg) application/x-cbr
# ext: epub
# ext: prc mobi
# ext: azw
AddIconByType (text,{FOLDERNAME}/theme/icons/text-plain.svg) application/epub+zip \
application/x-mobipocket-ebook \
application/vnd.amazon.ebook
#
# text
#
# readme files do not have a specific media type, fallback to AddIcon
# ext: README
AddIcon {FOLDERNAME}/theme/icons/text-x-readme.svg README
# markdown media type not yet included in apache, fallback to AddIcon
# ext: markdown md
#AddIconByType (markdown,{FOLDERNAME}/theme/icons/text-richtext.svg) text/mardown
AddIcon {FOLDERNAME}/theme/icons/text-richtext.svg .markdown .md
# this directive has to be at the end of the file because the text/* media type is very generic and should not be interpreted before other more specific directives
# ext: appcache ics ifb css csv html htm n3 txt text conf def list log in dsc rtx sgml sgm tsv t tr roff man me ms ttl uri uris urls vcard curl dcurl mcurl scurl sub fly flx gv 3dml spot jad wmls wml s asm c cc cxx cpp h hh dic f for f77 f90 java nfo opml p pas etx sfv uu vcs vcf
AddIconByType (text,{FOLDERNAME}/theme/icons/text-plain.svg) text/*
#
# default
#
DefaultIcon {FOLDERNAME}/theme/icons/empty.svg
#
# theme files
#
HeaderName {FOLDERNAME}/theme/header.html
ReadmeName {FOLDERNAME}/theme/footer.html
IndexStyleSheet {FOLDERNAME}/theme/style.css
#
# error pages
#
ErrorDocument 400 {FOLDERNAME}/theme/400.html
ErrorDocument 403 {FOLDERNAME}/theme/403.html
ErrorDocument 404 {FOLDERNAME}/theme/404.html
ErrorDocument 408 {FOLDERNAME}/theme/408.html
ErrorDocument 500 {FOLDERNAME}/theme/500.html
ErrorDocument 502 {FOLDERNAME}/theme/502.html
================================================
FILE: apaxy/theme/.htaccess
================================================
#
# Apaxy by @adamwhitcroft
#
# For a full breakdown of the mod_autoindex module
# http://apache.org/docs/2.2/mod/mod_autoindex.html
#
# Don't index this folder
Options -Indexes
================================================
FILE: apaxy/theme/400.html
================================================
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8"/>
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Error 400</title>
<!-- Stylesheets -->
<link rel="stylesheet" href="{FOLDERNAME}/theme/style.css" />
</head>
<body class="fadeDown">
<div class="center">
<h1>Error.</h1>
<div class="errorCode">400
</div>
<p>Sorry, I don't understand what you want me to do.</p>
</div>
</body>
</html>
================================================
FILE: apaxy/theme/403.html
================================================
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8"/>
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Error 403</title>
<!-- Stylesheets -->
<link rel="stylesheet" href="{FOLDERNAME}/theme/style.css" />
</head>
<body class="fadeDown">
<div class="center">
<h1>Error.</h1>
<div class="errorCode">403
</div>
<p>You aren't allowed to be here.</p>
</div>
</body>
</html>
================================================
FILE: apaxy/theme/404.html
================================================
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8"/>
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Error 404</title>
<!-- Stylesheets -->
<link rel="stylesheet" href="{FOLDERNAME}/theme/style.css" />
</head>
<body class="fadeDown">
<div class="center">
<h1>Error.</h1>
<div class="errorCode">404
</div>
<p>I can't find what you are looking for...</p>
</div>
</body>
</html>
================================================
FILE: apaxy/theme/408.html
================================================
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8"/>
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Error 408</title>
<!-- Stylesheets -->
<link rel="stylesheet" href="{FOLDERNAME}/theme/style.css" />
</head>
<body class="fadeDown">
<div class="center">
<h1>Error.</h1>
<div class="errorCode">408
</div>
<p>I refuse to wait any longer.</p>
</div>
</body>
</html>
================================================
FILE: apaxy/theme/500.html
================================================
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8"/>
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Error 500</title>
<!-- Stylesheets -->
<link rel="stylesheet" href="{FOLDERNAME}/theme/style.css" />
</head>
<body class="fadeDown">
<div class="center">
<h1>Error.</h1>
<div class="errorCode">500
</div>
<p>I don't know what to do. This isn't your fault.</p>
</div>
</body>
</html>
================================================
FILE: apaxy/theme/502.html
================================================
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8"/>
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Error 502</title>
<!-- Stylesheets -->
<link rel="stylesheet" href="{FOLDERNAME}/theme/style.css" />
</head>
<body class="fadeDown">
<div class="center">
<h1>Error.</h1>
<div class="errorCode">502
</div>
<p>I received some invalid information from my master.</p>
</div>
</body>
</html>
================================================
FILE: apaxy/theme/apaxy-lightgallery.js
================================================
var imageSelector = [
'tr:not(.parent) td.indexcolname a[href$=".gif"]',
'tr:not(.parent) td.indexcolname a[href$=".GIF"]',
'tr:not(.parent) td.indexcolname a[href$=".heic"]',
'tr:not(.parent) td.indexcolname a[href$=".HEIC"]',
'tr:not(.parent) td.indexcolname a[href$=".jpg"]',
'tr:not(.parent) td.indexcolname a[href$=".JPG"]',
'tr:not(.parent) td.indexcolname a[href$=".png"]',
'tr:not(.parent) td.indexcolname a[href$=".PNG"]',
].join(', ');
lightGallery(document.getElementById('indexlist'), {
selector: imageSelector,
mode: 'lg-slide',
hideBarsDelay: 2000,
loop: false,
hideControlOnEnd: true,
download: true,
cssEasing : 'cubic-bezier(0.25, 0, 0.25, 1)'
});
================================================
FILE: apaxy/theme/apaxy.js
================================================
// content filtering, based on "light javascript table filter" by Chris Coyier
// https://codepen.io/chriscoyier/pen/tIuBL - MIT License
(function(document) {
'use strict';
var TableFilter = (function(Arr) {
// the search bar element
var _input;
// find all rows of all tables and call _filter on them
function _onInputEvent(e) {
_input = e.target;
var tables = document.getElementsByTagName('table');
Arr.forEach.call(tables, function(table) {
Arr.forEach.call(table.tBodies, function(tbody) {
Arr.forEach.call(tbody.rows, _filter);
});
});
}
// show or hide a row based on the value of _input
function _filter(row) {
// skip "special" rows
if (row.className.indexOf('indexhead') != -1 || row.className.indexOf('parent') != -1) {
return;
}
// only check the 'name' field
var text = row.getElementsByTagName('td')[1].textContent.toLowerCase();
var val = _input.value.toLowerCase();
// change display type to show / hide this row
row.style.display = text.indexOf(val) === -1 ? 'none' : 'table-row';
}
return {
init: function() {
// grab the 1st child and add the indexhead class. tr:nth-child(1)
var row = document.getElementsByTagName('tr')[0];
// some versions of apache already add this class
if (row !== null && row.className.indexOf('indexhead') == -1) {
row.className += ' indexhead';
}
// grab the 2nd child and add the parent class. tr:nth-child(2)
row = document.getElementsByTagName('tr')[1];
// when apaxy is installed at doc root, there is no "parent directory" row
if (row !== null && row.getElementsByTagName('td')[1].textContent === 'Parent Directory') {
row.className += ' parent';
}
// find the search box and bind the input event
document.getElementById('filter').oninput = _onInputEvent;
}
};
})(Array.prototype);
document.addEventListener('readystatechange', function() {
if (document.readyState === 'complete') {
TableFilter.init();
var filterInput = document.getElementById('filter');
if ( filterInput.value.trim().length ){
filterInput.focus();
filterInput.dispatchEvent(new Event('input'));
}
}
});
// Use Keydown to get special keys like Backspace, Enter, Esc.
window.addEventListener('keydown', function (e) {
var filterInput = document.getElementById('filter');
var isFocused = (document.activeElement === filterInput);
if ( !isFocused && String.fromCharCode(e.keyCode).match(/(\w|\s)/g) ) {
filterInput.focus();
} else {
//pressed key is a non-char
//e.g. 'esc', 'backspace', 'up arrow'
}
});
})(document);
// generate a breadcrumb
var uri = window.location.pathname.substr(1);
var arr = uri.split('/');
var url = ""
var bread = '<li><strong><a href="/">Home</a></strong></li>';
var cont = 1;
arr.forEach(function(value){
url = url + '/' + value;
if(value != ''){
if(arr.length == cont+1)
bread += "<li class='active'>"+decodeURI(value)+"</li>";
else
bread += "<li><a href='"+url+"'>"+decodeURI(value)+"</a></li>";
}
cont++;
});
document.getElementById("breadcrumb").innerHTML = bread;
================================================
FILE: apaxy/theme/footer-lightgallery.html
================================================
<div class="block">
{FOOTER-MESSAGE}
</div><!--/.postlisting-->
</div><!--/.wrapper-->
<div class="footer">
Apaxy by <a href="https://twitter.com/adamwhitcroft">@adamwhitcroft</a>
</div><!--/.footer-->
<script src={FOLDERNAME}/theme/apaxy.js></script>
<script src="https://cdn.jsdelivr.net/npm/lightgallery@2.4.0/lightgallery.min.js" integrity="sha256-rJzhAjlCghJKSkx4mAv3VwVgxDSAbNM0AH7PhP4cDns=" crossorigin="anonymous"></script>
<script src={FOLDERNAME}/theme/apaxy-lightgallery.js></script>
================================================
FILE: apaxy/theme/footer.html
================================================
<div class="block">
{FOOTER-MESSAGE}
</div><!--/.postlisting-->
</div><!--/.wrapper-->
<div class="footer">
Apaxy by <a href="https://twitter.com/adamwhitcroft">@adamwhitcroft</a>
</div><!--/.footer-->
<script src={FOLDERNAME}/theme/apaxy.js></script>
================================================
FILE: apaxy/theme/header-lightgallery.html
================================================
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/lightgallery@2.4.0/css/lightgallery-bundle.min.css" integrity="sha256-1gtpcmuOA//0xcazytnM9JqBM3mUDWgwqW1P9U+2/F8=" crossorigin="anonymous">
<div class="wrapper">
<!-- we open the `wrapper` element here, but close it in the `footer.html` file -->
<ol class="breadcrumb" id="breadcrumb">
</ol>
<input type="search" id="filter" placeholder="filter contents" />
{HEADER-MESSAGE}
================================================
FILE: apaxy/theme/header.html
================================================
<div class="wrapper">
<!-- we open the `wrapper` element here, but close it in the `footer.html` file -->
<ol class="breadcrumb" id="breadcrumb">
</ol>
<input type="search" id="filter" placeholder="filter content" />
{HEADER-MESSAGE}
================================================
FILE: apaxy/theme/style.css
================================================
/*! normalize.css v5.0.0 | MIT License | github.com/necolas/normalize.css */
button,hr,input{overflow:visible}audio,canvas,progress,video{display:inline-block}progress,sub,sup{vertical-align:baseline}html{font-family:sans-serif;line-height:1.15;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%}body{margin:0} menu,article,aside,details,footer,header,nav,section{display:block}h1{font-size:2em;margin:.67em 0}figcaption,figure,main{display:block}figure{margin:1em 40px}hr{box-sizing:content-box;height:0}code,kbd,pre,samp{font-family:monospace,monospace;font-size:1em}a{background-color:transparent;-webkit-text-decoration-skip:objects}a:active,a:hover{outline-width:0}abbr[title]{border-bottom:none;text-decoration:underline;text-decoration:underline dotted}b,strong{font-weight:bolder}dfn{font-style:italic}mark{background-color:#ff0;color:#000}small{font-size:80%}sub,sup{font-size:75%;line-height:0;position:relative}sub{bottom:-.25em}sup{top:-.5em}audio:not([controls]){display:none;height:0}img{border-style:none}svg:not(:root){overflow:hidden}button,input,optgroup,select,textarea{font-family:sans-serif;font-size:100%;line-height:1.15;margin:0}button,input{}button,select{text-transform:none}[type=submit], [type=reset],button,html [type=button]{-webkit-appearance:button}[type=button]::-moz-focus-inner,[type=reset]::-moz-focus-inner,[type=submit]::-moz-focus-inner,button::-moz-focus-inner{border-style:none;padding:0}[type=button]:-moz-focusring,[type=reset]:-moz-focusring,[type=submit]:-moz-focusring,button:-moz-focusring{outline:ButtonText dotted 1px}fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}legend{box-sizing:border-box;color:inherit;display:table;max-width:100%;padding:0;white-space:normal}progress{}textarea{overflow:auto}[type=checkbox],[type=radio]{box-sizing:border-box;padding:0}[type=number]::-webkit-inner-spin-button,[type=number]::-webkit-outer-spin-button{height:auto}[type=search]{-webkit-appearance:textfield;outline-offset:-2px}[type=search]::-webkit-search-cancel-button,[type=search]::-webkit-search-decoration{-webkit-appearance:none}::-webkit-file-upload-button{-webkit-appearance:button;font:inherit}summary{display:list-item}[hidden],template{display:none};
/*------------------------------------*\
Apaxy
by @adamwhitcroft
Theme name: Apaxy
Theme author: @adamwhitcroft
\*------------------------------------*/
* {
margin: 0;
padding: 0;
box-sizing: border-box;
-moz-box-sizing: border-box;
-webkit-box-sizing: border-box;
}
html {
min-height: 100%;
color: #61666c;
background-color: #fff;
font-weight: 400;
font-size: 1em;
font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";
line-height: 2em;
}
@media (prefers-color-scheme: dark) {
html {
background-color: #232323;
}
}
body {
padding: 20px;
-webkit-backface-visibility: hidden;
}
code {
font-family: consolas,monospace;
}
a {
color: #333;
text-decoration: none;
}
@media (prefers-color-scheme: dark) {
a {
color: #e9e9e9;
}
}
a, img {
border: none;
outline: none;
}
a > img:hover {
opacity: 0.4;
}
a:hover {
color: #000;
}
@media (prefers-color-scheme: dark) {
a:hover {
color: #696969;
font-weight: bold;
}
}
/*------------------------------------*\
Wrapper
\*------------------------------------*/
.wrapper {
margin: 0 auto;
padding-top: 20px;
max-width: 80%;
}
/*------------------------------------*\
Filter (search box)
\*------------------------------------*/
#filter {
background-color: rgba(0, 0, 0, 0.04);
float: right;
font-size:.75em;
padding: .5em;
margin-bottom: .5em;
border: 1px solid rgba(0, 0, 0, 0.15);
border-radius: .25em;
width: 10em;
transition: width 0.25s ease;
}
@media (prefers-color-scheme: dark) {
#filter {
background-color: rgba(255, 255, 255, 0.07);
border-color: rgba(255, 255, 255, 0.15);
color: white;
}
}
#filter:focus {
width: 14em;
}
/*------------------------------------*\
Demo block
\*------------------------------------*/
.block {
font-size: .875em;
margin: 20px 0;
padding: 20px;
color: #9099A3;
}
/*------------------------------------*\
Table (directory listing)
\*------------------------------------*/
table {
width: 100%;
border-collapse: collapse;
font-size: .875em;
color: rgb(143, 143, 143);
}
@media (prefers-color-scheme: dark) {
table {
color: rgb(111, 111, 111);
}
}
.odd {
background-color: rgb(244, 244, 244);
}
@media (prefers-color-scheme: dark) {
.odd {
background-color: rgb(50, 50, 50);
}
}
tr {
outline: 0;
border: 0;
}
tr.indexhead{
border-bottom: 2px solid #999;
}
tr:not(.indexhead):hover{
box-shadow: 0px 0px 0px 1px rgba(0,0,0,0.25) inset;
-webkit-box-shadow: 0px 0px 0px 1px rgba(0,0,0,0.25) inset;
-moz-box-shadow: 0px 0px 0px 1px rgba(0,0,0,0.25) inset;
}
th {
text-align: left;
font-size: .75em;
padding-right: 20px;
}
/* 2nd Column: Filename */
th + th {
width: 65%;
}
/* 3rd Column: Last Modified */
th + th + th {
}
/* 4th Column: Size */
th + th + th + th {
width: 5%;
}
tr th:first-of-type,
tr td:first-of-type {
padding-left: 10px;
padding-right: 10px;
}
td {
padding: 5px 0;
outline: 0;
border: 0;
vertical-align: middle;
text-align: left;
transition: background 300ms ease;
-o-transition: background 300ms ease;
-ms-transition: background 300ms ease;
-moz-transition: background 300ms ease;
-webkit-transition: background 300ms ease;
}
@media (prefers-color-scheme: dark) {
td {
border-color: #424242;
}
}
td a {
display: block;
}
tr.parent a[href^="/"] {
color: #9099A3;
}
.parent a[href^="/"]:hover {
color: #2281d0;
}
/*------------------------------------*\
Footer
\*------------------------------------*/
.footer {
text-align: center;
font-size: .75em;
}
/*------------------------------------*\
Media query for small screens
\*------------------------------------*/
@media (max-width: 768px) {
body {
padding: 10px;
}
/* 2nd Column: Filename */
.indexcolname { width: 95%; }
/* 3rd Column: Last Modified */
.indexcollastmod { display: none; }
.wrapper { max-width: 100%; }
}
/*------------------------------------*\
Error pages
/*------------------------------------*/
/* Animation */
@-webkit-keyframes fadeDown {
0% {
opacity: 0;
-webkit-transform: translateY(-20px);
}
100% {
opacity: 1;
-webkit-transform: translateY(0);
}
}
@-moz-keyframes fadeDown {
0% {
opacity: 0;
-moz-transform: translateY(-20px);
}
100% {
opacity: 1;
-moz-transform: translateY(0);
}
}
@-ms-keyframes fadeDown {
0% {
opacity: 0;
-ms-transform: translateY(-20px);
}
100% {
opacity: 1;
-ms-transform: translateY(0);
}
}
@-o-keyframes fadeDown {
0% {
opacity: 0;
-o-transform: translateY(-20px);
}
100% {
opacity: 1;
-o-transform: translateY(0);
}
}
@keyframes fadeDown {
0% {
opacity: 0;
transform: translateY(-20px);
}
100% {
opacity: 1;
transform: translateY(0);
}
}
.fadeDown {
-webkit-animation:fadeDown 1s ease;
-moz-animation:fadeDown 1s ease;
-ms-animation:fadeDown 1s ease;
-o-animation:fadeDown 1s ease;
animation:fadeDown 1s ease;
}
/* Center elements in error pages */
.fadeDown .center {
text-align: center;
}
/* Error code display */
.errorCode {
font-size: 80px;
}
/*------------------------------------*\
Breadcrumb
\*------------------------------------*/
.breadcrumb {
padding: 0;
margin: 0;
}
.breadcrumb li {
color: rgb(154, 154, 154);
display: inline-block;
line-height: 10px;
margin: 0 9px 20px -10px;
padding: 0 15px;
position: relative;
white-space: nowrap;
}
@media (prefers-color-scheme: dark) {
.breadcrumb li {
color: rgb(100, 100, 100);
}
}
.breadcrumb li::before,
.breadcrumb li::after {
border-right: 1.5px solid #000;
content: '';
display: block;
height: 50%;
position: absolute;
left: 0;
right: 0;
top: 0;
z-index: -1;
transform: skewX(45deg);
}
@media (prefers-color-scheme: dark) {
.breadcrumb li::before,
.breadcrumb li::after {
border-color: #fff;
}
}
.breadcrumb li::after {
bottom: 0;
top: auto;
transform: skewX(-45deg);
}
.breadcrumb li:last-of-type::before,
.breadcrumb li:last-of-type::after {
display: none;
}
.breadcrumb li a {
letter-spacing: -1px;
text-decoration: none;
}
================================================
FILE: apaxy-configure.sh
================================================
#!/bin/bash
#
# apaxy configurator
# v0.2
# configure apaxy according to your local paths and configuration
# author : Jordan Bancino and Ploc
# contact : jordan [@] bancino.net
# licence : GPLv3
# enabling strict mode
# -e - exit immediatly on error (disable with "+e" when an error can happens, then enable it again with "-e")
# -u - undefined variables are forbidden (enable this option after getting parameters from $1 $2...) see below
# -o pipefail - find error return code inside piped commands
# IFS - set strong internal field separator
set -eo pipefail
IFS=$'\n\t'
# default config
defaultConfigFile="apaxy.config"
defaultApacheWebRootPath="/var/www/html"
defaultInstallWebPath=""
defaultEnableGallery=false
defaultHeaderMessage=""
defaultFooterMessage=""
defaultLogLevel=2
defaultLogFile="$(basename "${0}" .sh).log"
workingDirectory="$(dirname "${0}")"
logLevel="${defaultLogLevel}"
# functions
###
# display help
##
displayHelp () {
cat <<EOF
$(basename "${0}") configure apaxy according to your local paths and configuration.
It can either configure apaxy according to your local paths and configuration bu it can also install the required files in your http server path.
EOF
displayUsage
cat <<EOF
Available optionnal parameters are :
-h - display help
-c - set path/to/apaxy.config file that contains all configuration
-d - set path/to/dir/ directory where apaxy will be installed on the filesystem
-w - set path/to/dir/ directory where apaxy will be available on the httpd server
-g - enable or disable gallery feature
-hm - set the default header message displayed on top of each page
-fm - set the default footer message displayed on bottom of each page
-ll - set the log level
-lf - set the log file
EOF
}
###
# display usage
##
displayUsage () {
cat <<EOF
usage - $(basename "${0}") [-h] [-c path/to/apaxy.config] [-d path/to/dir/] [-w path/to/dir/] [-g true|false] [-hm "header message"] [-fm "footer message"] [-ll logLevel] [-lf logFile]
EOF
}
###
# log a message
#
# @global $logLevel the log level
# @global $logFile the log file
# @param $1 the log level of the message
# @param $2 the log message
##
log () {
local paramLogLevel="${1}"
local paramLogMessage="${2}"
# shellcheck disable=SC2155
local logDate="$(date +%H:%M:%S)"
local logMessage="[${logDate}] ${paramLogMessage}"
if [ "${paramLogLevel}" -le "${logLevel}" ]
then
echo "${logMessage}"
fi
if [ ! -z "${logFile}" ]
then
echo "${logMessage}" >> "${logFile}"
fi
}
# getting parameters value from cli (can overload config file values)
while [ "$#" -ge 1 ] ; do
case "${1}" in
-h|--help) # display help
displayHelp
exit 0
;;
-c) # set path/to/apaxy.config file that contains all configuration
shiftStep=2
paramConfigFile="${2}"
;;
-d) # set path/to/dir/ directory where apaxy will be available on the httpd server
shiftStep=2
paramApacheWebRootPath="${2}"
;;
-w) # set path/to/dir/ directory where apaxy will be installed on the filesystem
shiftStep=2
paramInstallWebPath="${2}"
;;
-g) # enable or disable gallery feature
shiftStep=2
paramEnableGallery="${2}"
;;
-hm) # set the default header message displayed on top of each page
shiftStep=2
paramHeaderMessage="${2}"
;;
-fm) # set the default footer message displayed on bottom of each page
shiftStep=2
paramFooterMessage="${2}"
;;
-ll) # set the log level
shiftStep=2
paramLogLevel="${2}"
;;
-lf) # set the log file
shiftStep=2
paramLogFile="${2}"
;;
*)
displayUsage
exit 2
;;
esac
if [ "$#" -ge "${shiftStep}" ]
then
shift "${shiftStep}"
else
log 1 "ERROR - invalid number of arguments"
exit 3
fi
done
# setting parameters value
if [ -r "${paramConfigFile}" ]
then
# getting parameters value from config file (config file name set by cli values)
configFile="${paramConfigFile}"
# shellcheck source=apaxy.config
source "${configFile}"
elif [ -r "${workingDirectory}/${defaultConfigFile}" ]
then
# getting parameters value from config file (config file name is default)
configFile="${workingDirectory}/${defaultConfigFile}"
# shellcheck source=apaxy.config
source "${configFile}"
else
log 1 "apaxy configuration not found, using internal config from script shell itself"
configFile=null
fi
if [ -n "${paramApacheWebRootPath}" ]
then
apacheWebRootPath="${paramApacheWebRootPath}"
elif [ -z "${apacheWebRootPath}" ]
then
apacheWebRootPath="${defaultApacheWebRootPath}"
fi
if [ -n "${paramInstallWebPath}" ]
then
installWebPath="${paramInstallWebPath}"
elif [ -z "${installWebPath}" ]
then
installWebPath="${defaultInstallWebPath}"
fi
if [ -n "${paramApacheWebRootPath}" ]
then
apacheWebRootPath="${paramApacheWebRootPath}"
elif [ -z "${apacheWebRootPath}" ]
then
apacheWebRootPath="${defaultApacheWebRootPath}"
fi
if [ -n "${paramInstallWebPath}" ]
then
installWebPath="${paramInstallWebPath}"
elif [ -z "${installWebPath}" ]
then
installWebPath="${defaultInstallWebPath}"
fi
installDir="${apacheWebRootPath}${installWebPath}"
if [ -n "${paramEnableGallery}" ]
then
enableGallery="${paramEnableGallery}"
elif [ -z "${enableGallery}" ]
then
enableGallery="${defaultEnableGallery}"
fi
if [ -n "${paramHeaderMessage}" ]
then
headerMessage="${paramHeaderMessage}"
elif [ -z "${headerMessage}" ]
then
headerMessage="${defaultHeaderMessage}"
fi
if [ -n "${paramFooterMessage}" ]
then
footerMessage="${paramFooterMessage}"
elif [ -z "${footerMessage}" ]
then
footerMessage="${defaultFooterMessage}"
fi
if [ -n "${paramLogLevel}" ]
then
logLevel="${paramLogLevel}"
elif [ -z "${logLevel}" ]
then
logLevel="${defaultLogLevel}"
fi
if [ -n "${paramLogFile}" ]
then
logFile="${paramLogFile}"
elif [ -z "${logFile}" ]
then
logFile="${workingDirectory}/${defaultLogFile}"
fi
# enabling strict mode
# -u - undefined variables are forbidden (enable this option after getting parameters from $1 $2...)
set -u
# checking parameters value
if [ ! -d "$(dirname "${logFile}")" ]
then
log 1 "ERROR - $(dirname "${logFile}") does not exist"
exit 4
fi
# script
# output current config
log 3 "- current config"
log 3 " configFile: ${configFile}"
log 3 " apacheWebRootPath: ${apacheWebRootPath}"
log 3 " installWebPath: ${installWebPath}"
log 3 " installDir: ${installDir}"
log 3 " enableGallery: ${enableGallery}"
log 3 " headerMessage: ${headerMessage}"
log 3 " footerMessage: ${footerMessage}"
log 3 " logLevel: ${logLevel}"
log 3 " logFile: ${logFile}"
log 1 "- creating install directory ${installDir}"
mkdir -p "${installDir}"
if [ ! -d "${installDir}" ] || [ ! -w "${installDir}" ]; then
log 1 "ERROR - install directory ${installDir} does not exist or is not writable by the current user"
exit 5
fi
log 1 "- copying apaxy in install directory"
# we want globbing
# shellcheck disable=SC2086
cp -r ${workingDirectory}/apaxy/* "${installDir}/"
log 1 "- configuring apaxy in install directory"
log 2 "- generating htaccess"
sed "s|{FOLDERNAME}|${installWebPath}|g" < "${installDir}/htaccess.txt" > "${installDir}/.htaccess"
rm "${installDir}/htaccess.txt"
if [ "${enableGallery}" = "true" ]
then
log 1 "- enabling gallery feature"
mv -f "${installDir}/theme/header-lightgallery.html" "${installDir}/theme/header.html"
mv -f "${installDir}/theme/footer-lightgallery.html" "${installDir}/theme/footer.html"
else
log 2 "- gallery feature not enabled"
fi
# find all the html files and replace the variable in them
# this will automatically take care of the error pages, headers and footers
log 2 "- setting path in html files"
files=$(find ${installDir} -name "*.html")
while read -r file; do
sed -i "s|{FOLDERNAME}|${installWebPath}|g" "${file}"
sed -i "s|{HEADER-MESSAGE}|${headerMessage}|g" "${file}"
sed -i "s|{FOOTER-MESSAGE}|${footerMessage}|g" "${file}"
done <<< "${files}"
log 2 "- syncing filesystem"
sync
log 1 "- filesystem has been synced and is now consistent"
log 1 "- apaxy has been successfully configured and installed in ${installDir}"
================================================
FILE: apaxy.config
================================================
#!/bin/bash
#
# apaxy configurator
# v0.2
# use "apaxy-configure.sh" to configure apaxy after adjusting the needed values in this file
# author : Jordan Bancino and Ploc
# contact : jordan [@] bancino.net
# licence : GPLv3
# default log level on the console (the lower the number is, the less verbose it is)
#defaultLogLevel=2
# all log messages are written to log file
#defaultLogFile="apaxy.log"
# the apache web root path where the server serves documents
#
# default for apache is /var/www/html
#
# note that path should be absolute, so make sure it starts with a "/"
# and DO NOT leave a trailing slash
#
# good: "/var/www/html" <- starts with "/", does not have trailing "/"
# bad : "var/www/html/" <- does not start with "/", have a trailing "/"
#
apacheWebRootPath="/var/www/html"
# the directory where apaxy will be used (this is relative to the web server root, and contains the "theme" folder)
#
# for instance: "http://example.org/share" would make this value "/share", where "/share/theme" is the theme directory
#
# note that path should be absolute, so make sure it starts with a "/"
# and DO NOT leave a trailing slash
#
# good: "/share" <- starts with "/", does not have trailing "/"
# bad : "share/" <- does not start with "/", has a trailing "/"
#
# by default, apaxy is configured to be installed at the root level of your web server
#
# if you want apaxy to be installed anywhere else, you can set it in the installWebPath variable
#
# installWebPath="/share"
#
installWebPath=""
# enable lightgallery.js to preview images in the browser with navigation links
#
# this feature is disabled by default as it downloads css and js files from a CDN
#
# please enable it with caution
#
enableGallery=false
# set the default header message displayed on top of each page
defaultHeaderMessage=""
# set the default footer message displayed on bottom of each page
defaultFooterMessage=""
================================================
FILE: docker-compose.yml
================================================
version: '3'
services:
apaxy:
image: apaxy
build:
context: .
args:
apaxyPath: ''
ports:
- '80:8080'
volumes:
- './share/:/usr/local/apache2/htdocs/share/'
================================================
FILE: package.json
================================================
{
"name": "apaxy",
"version": "2.6.0-dev",
"description": "A simple, customisable theme for your Apache directory listing.",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1",
"update-changelog": "conventional-changelog --preset angular --infile CHANGELOG.md --same-file --release-count 1"
},
"repository": {
"type": "git",
"url": "git+https://github.com/oupala/apaxy.git"
},
"keywords": [
"apaxy",
"apaxy-themes",
"css",
"icons",
"mime-types",
"customisable-theme",
"docker"
],
"author": "Adam Whitcroft",
"license": "GPL-3.0",
"bugs": {
"url": "https://github.com/oupala/apaxy/issues"
},
"homepage": "https://github.com/oupala/apaxy#readme",
"devDependencies": {
"conventional-changelog": "^3.1.8"
}
}
================================================
FILE: share/PLACE_YOUR_FILES_HERE.txt
================================================
You can place your file in the "share" directory (here!) so that they are accessible if you use docker-compose.
If you want to share files at the root level of your docker container, you'll have to edit the Dockerfile.
gitextract_l1p5zjri/
├── .github/
│ ├── ISSUE_TEMPLATE/
│ │ ├── bug_report.md
│ │ └── feature_request.md
│ └── PULL_REQUEST_TEMPLATE.md
├── .gitignore
├── CHANGELOG.md
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── COPYING.md
├── Dockerfile
├── README.md
├── apaxy/
│ ├── htaccess.txt
│ └── theme/
│ ├── .htaccess
│ ├── 400.html
│ ├── 403.html
│ ├── 404.html
│ ├── 408.html
│ ├── 500.html
│ ├── 502.html
│ ├── apaxy-lightgallery.js
│ ├── apaxy.js
│ ├── footer-lightgallery.html
│ ├── footer.html
│ ├── header-lightgallery.html
│ ├── header.html
│ └── style.css
├── apaxy-configure.sh
├── apaxy.config
├── docker-compose.yml
├── package.json
└── share/
└── PLACE_YOUR_FILES_HERE.txt
SYMBOL INDEX (2 symbols across 1 files)
FILE: apaxy/theme/apaxy.js
function _onInputEvent (line 12) | function _onInputEvent(e) {
function _filter (line 23) | function _filter(row) {
Condensed preview — 30 files, each showing path, character count, and a content snippet. Download the .json file or copy for the full structured content (113K chars).
[
{
"path": ".github/ISSUE_TEMPLATE/bug_report.md",
"chars": 799,
"preview": "---\nname: Bug report\nabout: Create a report to help us improve\n\n---\n\n**Describe the bug**\nA clear and concise descriptio"
},
{
"path": ".github/ISSUE_TEMPLATE/feature_request.md",
"chars": 560,
"preview": "---\nname: Feature request\nabout: Suggest an idea for this project\n\n---\n\n**Is your feature request related to a problem? "
},
{
"path": ".github/PULL_REQUEST_TEMPLATE.md",
"chars": 37,
"preview": "fixes #\n\n## proposed changes\n\n-\n-\n-\n\n"
},
{
"path": ".gitignore",
"chars": 23,
"preview": "node_modules\n.DS_Store\n"
},
{
"path": "CHANGELOG.md",
"chars": 6281,
"preview": "## [2.5.1](https://github.com/oupala/apaxy/compare/2.5.0...2.5.1) (2024-10-09)\n\n\n### Bug Fixes\n\n* lightgallery feature ("
},
{
"path": "CODE_OF_CONDUCT.md",
"chars": 3362,
"preview": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, w"
},
{
"path": "CONTRIBUTING.md",
"chars": 6160,
"preview": "# Contributing to apaxy\n\nFirst and foremost, thank you! We appreciate that you want to contribute\nto apaxy, your time is"
},
{
"path": "COPYING.md",
"chars": 34916,
"preview": "### GNU GENERAL PUBLIC LICENSE\n\nVersion 3, 29 June 2007\n\nCopyright (C) 2007 Free Software Foundation, Inc.\n<https://fsf."
},
{
"path": "Dockerfile",
"chars": 3489,
"preview": "# bash docker image will be used for configuring apaxy\nFROM bash\n\n# set apaxyPath to the path where you want apaxy to be"
},
{
"path": "README.md",
"chars": 7420,
"preview": "# Apaxy\n\napaxy is a customisable theme built to enhance the experience of browsing web directories. It uses the `mod_aut"
},
{
"path": "apaxy/htaccess.txt",
"chars": 15992,
"preview": "#\n# apaxy\n# Copyright (C) 2021 @adamwhitcroft\n#\n# This program is free software: you can redistribute it and/or modify\n#"
},
{
"path": "apaxy/theme/.htaccess",
"chars": 179,
"preview": "#\n#\tApaxy by @adamwhitcroft\n#\n#\tFor a full breakdown of the mod_autoindex module\n#\thttp://apache.org/docs/2.2/mod/mod_au"
},
{
"path": "apaxy/theme/400.html",
"chars": 444,
"preview": "<!DOCTYPE html>\n<html>\n\t<head>\n\t\t<meta charset=\"UTF-8\"/>\n\t\t<meta name=\"viewport\" content=\"width=device-width, initial-sc"
},
{
"path": "apaxy/theme/403.html",
"chars": 425,
"preview": "<!DOCTYPE html>\n<html>\n\t<head>\n\t\t<meta charset=\"UTF-8\"/>\n\t\t<meta name=\"viewport\" content=\"width=device-width, initial-sc"
},
{
"path": "apaxy/theme/404.html",
"chars": 435,
"preview": "<!DOCTYPE html>\n<html>\n\t<head>\n\t\t<meta charset=\"UTF-8\"/>\n\t\t<meta name=\"viewport\" content=\"width=device-width, initial-sc"
},
{
"path": "apaxy/theme/408.html",
"chars": 423,
"preview": "<!DOCTYPE html>\n<html>\n\t<head>\n\t\t<meta charset=\"UTF-8\"/>\n\t\t<meta name=\"viewport\" content=\"width=device-width, initial-sc"
},
{
"path": "apaxy/theme/500.html",
"chars": 442,
"preview": "<!DOCTYPE html>\n<html>\n\t<head>\n\t\t<meta charset=\"UTF-8\"/>\n\t\t<meta name=\"viewport\" content=\"width=device-width, initial-sc"
},
{
"path": "apaxy/theme/502.html",
"chars": 446,
"preview": "<!DOCTYPE html>\n<html>\n\t<head>\n\t\t<meta charset=\"UTF-8\"/>\n\t\t<meta name=\"viewport\" content=\"width=device-width, initial-sc"
},
{
"path": "apaxy/theme/apaxy-lightgallery.js",
"chars": 726,
"preview": "var imageSelector = [\n 'tr:not(.parent) td.indexcolname a[href$=\".gif\"]',\n 'tr:not(.parent) td.indexcolname a[href"
},
{
"path": "apaxy/theme/apaxy.js",
"chars": 3203,
"preview": "// content filtering, based on \"light javascript table filter\" by Chris Coyier\n// https://codepen.io/chriscoyier/pen/tIu"
},
{
"path": "apaxy/theme/footer-lightgallery.html",
"chars": 507,
"preview": " <div class=\"block\">\n {FOOTER-MESSAGE}\n </div><!--/.postlisting-->\n\n</div><!--/.wrapper-->\n\n<div class=\"footer\">\n "
},
{
"path": "apaxy/theme/footer.html",
"chars": 264,
"preview": " <div class=\"block\">\n {FOOTER-MESSAGE}\n </div><!--/.postlisting-->\n\n</div><!--/.wrapper-->\n\n<div class=\"footer\">\n "
},
{
"path": "apaxy/theme/header-lightgallery.html",
"chars": 438,
"preview": "<link rel=\"stylesheet\" href=\"https://cdn.jsdelivr.net/npm/lightgallery@2.4.0/css/lightgallery-bundle.min.css\" integrity="
},
{
"path": "apaxy/theme/header.html",
"chars": 237,
"preview": "<div class=\"wrapper\">\n<!-- we open the `wrapper` element here, but close it in the `footer.html` file -->\n\n<ol class=\"br"
},
{
"path": "apaxy/theme/style.css",
"chars": 8560,
"preview": "/*! normalize.css v5.0.0 | MIT License | github.com/necolas/normalize.css */\nbutton,hr,input{overflow:visible}audio,canv"
},
{
"path": "apaxy-configure.sh",
"chars": 8581,
"preview": "#!/bin/bash\n#\n# apaxy configurator\n# v0.2\n# configure apaxy according to your local paths and configuration\n# author : J"
},
{
"path": "apaxy.config",
"chars": 1905,
"preview": "#!/bin/bash\n#\n# apaxy configurator\n# v0.2\n# use \"apaxy-configure.sh\" to configure apaxy after adjusting the needed value"
},
{
"path": "docker-compose.yml",
"chars": 205,
"preview": "version: '3'\nservices:\n apaxy:\n image: apaxy\n build:\n context: .\n args:\n apaxyPath: ''\n ports"
},
{
"path": "package.json",
"chars": 827,
"preview": "{\n \"name\": \"apaxy\",\n \"version\": \"2.6.0-dev\",\n \"description\": \"A simple, customisable theme for your Apache directory "
},
{
"path": "share/PLACE_YOUR_FILES_HERE.txt",
"chars": 220,
"preview": "You can place your file in the \"share\" directory (here!) so that they are accessible if you use docker-compose.\n\nIf you "
}
]
About this extraction
This page contains the full source code of the AdamWhitcroft/apaxy GitHub repository, extracted and formatted as plain text for AI agents and large language models (LLMs). The extraction includes 30 files (105.0 KB), approximately 27.8k tokens, and a symbol index with 2 extracted functions, classes, methods, constants, and types. Use this with OpenClaw, Claude, ChatGPT, Cursor, Windsurf, or any other AI tool that accepts text input. You can copy the full output to your clipboard or download it as a .txt file.
Extracted by GitExtract — free GitHub repo to text converter for AI. Built by Nikandr Surkov.