summaryrefslogtreecommitdiffstats
path: root/admin/survey/minify/docs/Install.wiki.md
diff options
context:
space:
mode:
authorAnton Luka Šijanec <anton@sijanec.eu>2022-01-11 12:35:47 +0100
committerAnton Luka Šijanec <anton@sijanec.eu>2022-01-11 12:35:47 +0100
commit19985dbb8c0aa66dc4bf7905abc1148de909097d (patch)
tree2cd5a5d20d7e80fc2a51adf60d838d8a2c40999e /admin/survey/minify/docs/Install.wiki.md
download1ka-19985dbb8c0aa66dc4bf7905abc1148de909097d.tar
1ka-19985dbb8c0aa66dc4bf7905abc1148de909097d.tar.gz
1ka-19985dbb8c0aa66dc4bf7905abc1148de909097d.tar.bz2
1ka-19985dbb8c0aa66dc4bf7905abc1148de909097d.tar.lz
1ka-19985dbb8c0aa66dc4bf7905abc1148de909097d.tar.xz
1ka-19985dbb8c0aa66dc4bf7905abc1148de909097d.tar.zst
1ka-19985dbb8c0aa66dc4bf7905abc1148de909097d.zip
Diffstat (limited to 'admin/survey/minify/docs/Install.wiki.md')
-rw-r--r--admin/survey/minify/docs/Install.wiki.md61
1 files changed, 61 insertions, 0 deletions
diff --git a/admin/survey/minify/docs/Install.wiki.md b/admin/survey/minify/docs/Install.wiki.md
new file mode 100644
index 0000000..328e873
--- /dev/null
+++ b/admin/survey/minify/docs/Install.wiki.md
@@ -0,0 +1,61 @@
+# Installation
+
+Minify requires PHP 5.3+, `git`, and `composer`.
+
+## Typical Installation
+
+Clone the project into the `min/` directory inside your document root and install its dependencies:
+
+```bash
+cd /path/to/public_html
+git clone https://github.com/mrclay/minify.git min
+cd min
+composer install --no-dev
+```
+
+**Note:** If you do this on localhost, make sure the `min/vendor/` directory gets deployed to production.
+
+## Installing as a composer dependency
+
+Add `"mrclay/minify": "~3.0.0"` to your site's composer.json, and `composer install`.
+
+The following assumes your `vendor` directory is in your document root. Adjust the `MINIFY` path as needed:
+
+```bash
+cd /path/to/public_html
+mkdir min
+MIN=min/
+MINIFY=vendor/mrclay/minify/
+cp ${MINIFY}example.index.php ${MIN}index.php
+cp ${MINIFY}.htaccess ${MIN}
+cp ${MINIFY}config.php ${MIN}
+cp ${MINIFY}groupsConfig.php ${MIN}
+cp ${MINIFY}quick-test.js ${MIN}
+cp ${MINIFY}quick-test.css ${MIN}
+```
+
+Edit `min/index.php` to remove the ``die()`` statement and adjust the `vendor` path as needed.
+
+**Note:** This does not install the [URL builder](BuilderApp.wiki.md), but it's not necessary for operation.
+
+## Verifing it works
+
+You can verify it works via these two URLs:
+
+* http://example.org/min/?f=min/quick-test.js
+* http://example.org/min/?f=min/quick-test.css
+
+If your server supports mod_rewrite, the `?` are not necessary:
+
+* http://example.org/min/f=min/quick-test.js
+* http://example.org/min/f=min/quick-test.css
+
+## Having trouble?
+
+Write the [Google Group](http://groups.google.com/group/minify) for help.
+
+## More links
+
+* [Usage instructions](UserGuide.wiki.md)
+* [Cookbook](CookBook.wiki.md) for more advanced options
+* [All docs](docs)