X-Git-Url: https://git.cweiske.de/phorkie.git/blobdiff_plain/7f492c9b1429f7f8f91469492b6113f3b804ffb7..32a54ab3d31dfe234186793e4ed610ec63d88f3c:/README.rst diff --git a/README.rst b/README.rst index 651e181..0e8cadf 100644 --- a/README.rst +++ b/README.rst @@ -61,6 +61,12 @@ Installation Look at ``config.default.php`` for values that you may adjust. 5. Set your web server's document root to ``/path/to/phorkie/www/`` + Alternatively, you can add a symlink to the ``www`` folder into your + web server's existing document root tree (being careful to keep + main phorkie folder outside the document root for security purposes) + and ensure you set the ``baseurl`` config option appropriately. You + must also set the ``RewriteBase`` in the ``.htaccess`` file or adjust + the nginx configuration accordingly. 6. Open phorkie in your web browser @@ -112,6 +118,7 @@ It is used to provide search capabilities and the list of recent pastes. __ http://www.elasticsearch.org/ + Setup ===== Edit ``config.php``, setting the ``elasticsearch`` property to the HTTP URL @@ -119,6 +126,7 @@ of the index, e.g. :: http://localhost:9200/phorkie/ +You must use a search namespace with Elasticsearch such as ``phorkie/``. Run the index script to import all existing pastes into the index:: php scripts/index.php @@ -138,7 +146,7 @@ index, run the following command:: Phorkie will automatically re-index everything when ``setupcheck`` is enabled in the configuration file. -You may also manually run the reindexer with:: +You may also manually run the reindexing script with:: $ php scripts/index.php @@ -281,6 +289,8 @@ If you use nginx, place the following lines into your ``server`` block: rewrite ^/([0-9]+)/tool/([^/]+)/(.+)$ /tool.php?id=$1&tool=$2&file=$3; rewrite ^/new$ /new.php; + rewrite ^/feed/new$ /feed-new.php; + rewrite ^/feed/updated$ /feed-updated.php; rewrite ^/list$ /list.php; rewrite ^/list/([0-9]+)$ /list.php?page=$1;