Home

Awesome

Serve files missing from the document root

Build Status

Not all projects have the resources to hand-craft every root file.

This single PHP class generates all of them for you. Apache configuration files are also included.

This repository is modular. See Adding a new root file section below.

Usage

# Clone this repo
git clone https://github.com/szepeviktor/RootFiles.git
cd RootFiles/bin/
# Generate Apache configuration files
./generate-apache-httpd-configs.sh /directory/for/generator-script

Comment out aliases for existing files in dist/rootfiles.conf, include it in your site's configuration and copy dist/rootfiles.php at the specified path.

You're done!

Download

If you don't have access to Apache vhost config just download the current release (.htaccess and rootfiles.php) and place them in your site's document root.

404 handling

See https://github.com/szepeviktor/wordpress-plugin-construction/blob/master/404-adaptive.php

Based on https://github.com/mathiasbynens/small

See the results

Search access log for served root files

grep -E "GET ($(sed -ne 's|^\s*Alias "\(.\+\)" /.\+$|\1|p' rootfiles.conf|paste -d"|" -s) HTTP/)" /var/log/apache2/access.log

List of Well-Known URIs

http://www.iana.org/assignments/well-known-uris/well-known-uris.xhtml

Other root files

Alternative solution

RewriteEngine On
RewriteRule "^/apple-app-site-association$" - [R=200]
<Location "/apple-app-site-association">
    # Inline response body
    ErrorDocument 200 '{ "applinks": { "apps": [], "details": [] } }'
</Location>

Contribution

PR-s are welcome!

Adding a new root file

  1. Add a README.md file (example below)
  2. Add all the paths with leading slash in .path
  3. Create the file with minimal contents with full path (could be in a subdirectory)
  4. Add generator.phps with case statement (path, content type, content) you may use the %%FILE:file.ext%% placeholder for base64 encoded file contents
  5. Optionally add full example in the _example directory
# Full Name with Company and Function

Small description.

| Data          |               |
| ------------- | ------------- |
| file name     | file.ext      |
| type          | JSON          |
| specification | [Title](/URL) |
| tutorial      | [Title](/URL) |

### HTML head link

<link rel="name" />

Or: Must be in the document root.