summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAaron Parecki <aaron@parecki.com>2016-04-21 07:48:16 -0700
committerAaron Parecki <aaron@parecki.com>2016-04-21 07:48:16 -0700
commit904782f973a12542cacb394e2e1d0827accd995a (patch)
tree66f5ef63678ba61f9cfdc69cc6682bc51a57c05b /README.md
parentd0055bad24153e1dc696df2b8825dba4c523b434 (diff)
move editor folder to editor-files, remove appcache
* it sometimes confuses web servers to have a folder named "editor" while also serving routes with the same name * dropped appcache stuff since it wasn't working super well * add nginx config to the readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md40
1 files changed, 40 insertions, 0 deletions
diff --git a/README.md b/README.md
index 097c5c4..c5c7b47 100644
--- a/README.md
+++ b/README.md
@@ -6,6 +6,46 @@ Work in progress. Do not use!
https://quill.p3k.io/
+### Web Server Configuration
+
+Set the document root to the "public" folder of this repo, and ensure all requests are routed through `public/index.php` if they don't match a file.
+
+#### nginx
+
+```
+server {
+ listen 80;
+ server_name quill.dev;
+
+ root /path/to/Quill/public;
+
+ error_log logs/quill.error.log notice;
+
+ try_files $uri /index.php?$args;
+
+ location /index.php {
+ fastcgi_pass php-pool;
+ fastcgi_index index.php;
+ include fastcgi_params;
+ fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
+ }
+}
+```
+
+#### Apache htaccess
+
+```
+ RewriteEngine on
+
+ RewriteBase /
+
+ RewriteCond %{REQUEST_FILENAME} !-f
+ RewriteCond %{REQUEST_FILENAME} !-d
+ RewriteCond %{REQUEST_URI} !=/favicon.ico
+ RewriteRule ^ index.php [L]
+```
+
+
### Contributing
By submitting code to this project, you agree to irrevocably release it under the same license as this project.