Skip to content

Commit

Permalink
Readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
mario-deluna committed Jun 5, 2014
1 parent 1db15c9 commit 36a3736
Showing 1 changed file with 31 additions and 16 deletions.
47 changes: 31 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ When someone asks me for about the benefits in CCF:

Setting up a new instance of CCF2 can be done simply through command, or, in other words, with composer.

Run the following command ( without the '$' ) to create a new project with CCF.
Run the following command to create a new project with CCF.

```
$ composer create-project clancats/framework <your project name> --prefer-dist -s dev
Expand All @@ -58,7 +58,7 @@ For some operations ( storage, packtacular etc. ) we may need to grant write per
**Storage:** `/CCF/storage/`<br/>
**Packtacular:** `/public/assets/packtacular/`

you can also set these using the `cli` doctor.
You can also set these using the `cli` doctor.

```
$ php cli doctor::permissions
Expand All @@ -70,7 +70,7 @@ If you get an error setting the permissions try to run the that command with `su

## Structure

In the new CCF2 folder structure we splittet some things apart to make deployment much more efficient.<br/>
In the new CCF2 folder structure we split some things apart to make deployment much more efficient.<br/>


```
Expand Down Expand Up @@ -98,30 +98,32 @@ In the new CCF2 folder structure we splittet some things apart to make deploymen

## Configuration

There is actual no configuration needed to just run the framework (depending on your environment). But we recommend to do some configuration before you start developing your awesome application.
There is usually no configuration _required_ to just run the framework (depending on your environment). We do, however, recommend to do some configuration before you start developing your awesome application.

### Boot

The boot configuration allow you change the core behaviour of the CCF.
The boot configuration allow you change the core behavior of the CCF.

#### Environment

Define how your application detects the environment.<br />
You can create your complete own script to return the runtime environment or you can make use of the env detector.
Define how your application detects the environment.<br/>
You can create an entirely new script of your own to return the runtime environment or you can make use of the env detector.

```
/boot/environment.php
```

> Check out the environment docs: [Environment](/docs/application/environment)
#### Paths

Plan to run multiple CCF installations on one mashine? Using just one single core? This is absolutely no problem you can modify the CCF paths.
Plan on running multiple CCF installations on one machine? Using just a single core? This is no problem because you can modify the CCF paths.

```
/boot/paths.php
```

You are also free to add new paths. Adding a new element to the array will add the path to runtime and also create an path define:
You are also free to add new paths. Adding a new element to the array will add the path to runtime and also create a path define:

```
<value> = <value>PATH
Expand All @@ -136,32 +138,45 @@ You will find an initial **main configuration** file under:
/CCF/app/config/main.config.php
```

**1. Security Salt**
#### Security Salt

At several points CCF is going to encrypt certain things by employing salt. You should define your own salt to keep your application secure.

You can generate a random salt using the following command:

```
$ php cli doctor::security_key
```

**When using composer to create a new project the salt is generated automatically.**

At several point CCF is going to crypt stuff and to do that it uses a salt. You should define your own salt to keep your application secure.
Otherwise you will find the key under security in the main configuration:

```php
'security' => array(
'salt' => 'L~7(%(9=@9+8u.Oo4+ysT45fkA4,82',
'salt' => 'L~7(%(9=@9+8u.Oo4+ysT45fkA4,82',
),
```

**2. Path**
#### Path offset

Maybe you would like to run your application not from the domain root. Instead from a subfolder in this example *forums*.
Maybe you would like to run your application from somewhere other than the domain root, e.g. from a subfolder.
*forums*.

```php
// www.yourdomain.com/forums/
'url' => array(
'path' => '/forums/',
'path' => '/forums/',
),
```

> For everything else, check out the main configuration documents: [Configuration](/docs/application/main_configuration/)
---

## Routing

Depending on your system you will need to setup something that all public request end on the `public/index.php` file.
Depending on your system you will need to set something up so that all public requests end on the `public/index.php` file.

CCF ships with an `.htaccess` for apache systems with `mod_rewrite` enabled:

Expand Down

0 comments on commit 36a3736

Please sign in to comment.