h5ai icon indicating copy to clipboard operation
h5ai copied to clipboard

Outdated instructions in README.md? Incomplete instructions?

Open earthbound19 opened this issue 4 years ago • 1 comments

The README.md at this writing warns not to install the src folder, but there is no such folder in the project. Is that instruction outdated?

Also, it's totally unclear how to make any arbitrary directory published. Do .htaccess and/or index.php files need to be added to folders intended to be published? Do they also need to be listed in the root folder .htaccess file in a DirectoryIndex section? I've tried combinations of those things (including copying the .htaccess and index.php file from the _h5ai/public directory) to no avail.

All I get are Forbidden Apache errors when navigating to those directories over the web.

And I strongly suggest putting install instructions in the README.md in the repository, not at an external site. Then anyone can clone the repo and they'll still have the instructions if the site become inaccessible.

earthbound19 avatar Jun 27 '20 18:06 earthbound19

This warning to not install src, is only if you want build h5ai from src (git repo). This has nothing to do with the release file(s) self (so you can't find a src folder).

README.md

Important

  • Do not install any files from the src folder, they need to be preprocessed to work correctly!
  • Find a preprocessed package and detailed install instructions on the project page.

....

Build

There are installation ready packages for the latest releases and dev builds.

Apache 2.4 vhost Snippet

<Directory "/path/to/files">
    SSLOptions +StdEnvVars
    DirectoryIndex /_h5ai/public/index.php
    Options -Indexes
    AllowOverride All
    Require all granted
</Directory>

Regards.

vr0 avatar Jul 21 '20 13:07 vr0