yohan/SemanticScuttle
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

phar installation instructions

Browse Source
This commit is contained in:
Christian Weiske 2011-08-24 22:24:53 +02:00
parent 7947dad6a5
commit 6f5cd7c6e4
2 changed files with 65 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/INSTALL.txt
View File

@ -14,6 +14,11 @@ To run SemanticScuttle, you need:
Standard installation instructions
==================================
If you downloaded the ``.phar`` file, follow the `Phar setup instructions`__.
Otherwise continue here:
__ install-phar.html
If you've downloaded a ``SemanticScuttle-x.y.z.zip`` file from SourceForge,
then this instructions are for you.

65
doc/install-phar.rst
View File

@ -5,6 +5,12 @@ SemanticScuttle .phar installation
How to install the `.phar` version of SemanticScuttle.
Note: The ``.phar`` file can be used from the browser and
via command line. Use ``--help`` to find out what you can do.
.. contents::
Server setup
============
Apache or any other web server is by default not configured to let PHP handle
@ -21,9 +27,58 @@ Adding ``.phar`` is trivial::
<FilesMatch "\.ph(ar|p3?|tml)$">
Restart your server after this configuration change.
2. Database setup
3. Configuration
1. Configuration file
2. Caching
4. Visit SemanticScuttle
Database setup
==============
Extract the database schema from the ``.phar`` file::
$ php SemanticScuttle-0.98.3.phar x data/tables.sql tables.sql
Import the schema into you MySQL server::
$ mysql -umyusername mydatabase < tables.sql
Database upgrades
-----------------
If you are upgrading from an earlier version of SemanticScuttle, you might need
to upgrade your database schema.
See the `upgrade instructions`_ for more information.
Get a list of all schema files with ::
$ php SemanticScuttle-0.98.3.phar list | grep schema
and then extract the relevant ones with ::
$ php SemanticScuttle-0.98.3.phar x data/schema/6.sql
.. _upgrade instructions: UPGRADE.html
Configuration
=============
Extract the configuration file from the ``.phar`` file::
$ php SemanticScuttle-0.98.3.phar x data/config.php.dist SemanticScuttle-0.98.3.phar.config.php
Note that the file name must be exactly the name of the ``.phar``
plus ``.config.php`` - otherwise the configuration file is not detected.
After extracting it, modify it according to your needs.
Caching
-------
If you want to enable caching, make sure you use a ``$dir_cache`` that is
_outside_ the phar file.
Visit SemanticScuttle
=====================
Open your browser and navigate to the ``.phar`` file.
Happy bookmarking!