diff options
author | Chris Cornutt <enygma@phpdeveloper.org> | 2015-07-22 15:16:10 -0500 |
---|---|---|
committer | Chris Cornutt <enygma@phpdeveloper.org> | 2015-07-22 15:16:10 -0500 |
commit | 2296cedf3f68accc5ca87e590ddbdf7af16a0e4d (patch) | |
tree | 8c4d90cb469b87732e6f1a44c92cbb78091906a2 /docs | |
parent | 27edfa2b258456c13a6474e56575cdc638898214 (diff) | |
download | gatekeeper-2296cedf3f68accc5ca87e590ddbdf7af16a0e4d.zip gatekeeper-2296cedf3f68accc5ca87e590ddbdf7af16a0e4d.tar.gz gatekeeper-2296cedf3f68accc5ca87e590ddbdf7af16a0e4d.tar.bz2 |
updating install docs to use the new setup.sh script
Diffstat (limited to 'docs')
-rw-r--r-- | docs/installation-and-configuration.md | 39 |
1 files changed, 7 insertions, 32 deletions
diff --git a/docs/installation-and-configuration.md b/docs/installation-and-configuration.md index b0248d3..e8be68a 100644 --- a/docs/installation-and-configuration.md +++ b/docs/installation-and-configuration.md @@ -8,16 +8,6 @@ The best way to install Gatekeeper is through Composer (though I suppose you cou composer require psecio/gatekeeper ``` -or, if you want to edit the `composer.json` yourself and get specific with the version: - -``` -{ - "require": { - "psecio/gatekeeper": "1.0" - } -} -``` - ## Dependencies *Gatekeeper* makes use of several other PHP dependencies to help reduce code duplication: @@ -27,13 +17,12 @@ or, if you want to edit the `composer.json` yourself and get specific with the v - [password_compat](http://github.com/ircmaxell/password-compat) - [phpdotenv](http://github.com/vlucas/phpdotenv) -## Setup -There's a few things you'll need to do before using the system. First off, it uses [Phinx](https://phinx.org) for working -with the database tables (creation and all). Second it uses the handy [phpdotenv](https://github.com/vlucas/phpdotenv) library -to handle the loading of environment values. This helps you understand the installation and usage a bit better. +## Setup Quick Start + +There's a "quick start" method for getting Gatekeeper up and running in two steps: -1. Create a database named `gatekeeper` and create a user for it (this is configured later) +1. Create your Gatekeeper database and user: ``` create database gatekeeper; @@ -41,26 +30,12 @@ grant all on gatekeeper.* to 'gk-user'@'localhost' identified by 'some-password- flush privileges; ``` -1. Copy the `.env.dist` file from the *Gatekeeper* vendor directory to the (non-`DOCUMENT_ROOT`) place of your choosing and rename it to `.env`. -2. Copy the `phinx.dist.xml` file to the place of your choosing (again, non-`DOCUMENT_ROOT`) and rename it to `phinx.yml`. - -``` -cp vendor/psecio/gatekeeper/.env.dist /tmp/someplace/.env -cp vendor/psecio/gatekeeper/phinx.dist.yml /tmp/someplace/phinx.yml -``` - -3. Open both of these files and update the **connection information** to match the database you created earlier. -4. Now we run the migrations: - -``` -vendor/bin/phinx migrate -c /tmp/somplace/phinx.yml -``` +2. Execute the `vendor/bin/setup.sh` file. This script will ask several questions about your database setup, write the needed files and run the migrations for you. -Where the `/tmp/someplace/phinx.yml` is the path to where you put your `phinx.yml` file (again, not in the document root **please!**). +That's it - you're all done! -If you get errors here, be sure the connection information is correct. -5. You're ready to go! +## You're ready to go! You can now start using the *Gatekeeper* functionality in your application. You only need to call the `init` function to set up the connection and get the instance configured: |