updated readme

This commit is contained in:
Parziphal 2013-12-07 15:37:27 -05:00
parent 0e8359ba89
commit b289ee6f53

View File

@ -11,32 +11,24 @@ Requirements
* Requires PHP 5.4+. It was developed under PHP 5.4.7 and MySQL v5.5.27.
* Must have PHP libraries are GD2 (for image processing), PDO (database) and cURL (for both Image search and Search external data features).
* Recommended libraries are Imagick and Memcached.
* If running under Apache, the Rewrite mod must be enabled. Also, to serve gzipped assets (css and js files), the Headers mod is needed.
* Both Git and Composer are needed for installation/update. How to install Composer can be found [here](http://getcomposer.org/download/) and/or [here](http://getcomposer.org/doc/00-intro.md).
* If running under Apache, the Rewrite mod must be enabled. Also, to serve gzipped assets (css and js files), the Headers mod is needed.
Installation
------------
Go to the location where you want MyImouto to be installed, then clone the repo, then install dependencies:
* Install system dependencies: `composer install`.
* Create a database for the booru.
* Create `config/config.php` and `config/database.yml` by copying their respective _.example_ files.
* Set your database configuration in `config/database.yml`.
* Configure the booru by editing `config/config.php`. For a minimum configuration, both *server_host* and *url_base* options must be correctly configured.
* Run the installer: `php install.php`. Enter a name and password for the admin account when asked, then wait for the installation to finish.
* Finally, point the document root of your web server to the `/public` folder. That's where the index.php file is.
git clone https://github.com/myimouto/myimouto
cd myimouto
composer install
* Wait for Composer to download MyImouto and all its dependencies. After that, wait a little longer as the asset files will be compiled.
* Point the document root of your web server to the /public folder.
* Create the database for the booru.
* Create config/config.php and config/database.yml.example by copying their respective ".example" files.
* Set your database configuration in _config/database.yml_.
* Set your MyImouto configuration in _config/config.php_ (read the _config/default_config.php_ file to see the available options). For the system for work correctly only the *server_host* and *url_base* options are the most important.
* If you're not accessing the site locally, list the IP address you'll connect from in the 'safe_ips' array in _install/config.php_.
* Go to your site to complete the installation. After installation is completed, you may delete the install folder.
* After installation is completed, run `php config/boot.php db:migrate` to run database migrations.
Updating
--------
Every time you update the files with `git remote update` or something, also run `composer update` to update dependencies, specially for the framework, and also `php config/boot.php db:migrate` to run database migrations.
Every time you update the files with `git remote update` or something, also run `composer update` to update dependencies, specially for the framework, and also run `php config/boot.php db:migrate` to run database migrations (if any).
Troubleshooting
---------------