Skip to content
This repository has been archived by the owner on Dec 22, 2020. It is now read-only.

Commit

Permalink
Updated documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
jeremyzahner committed Nov 25, 2015
1 parent 8c12b5c commit b7d9df3
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 21 deletions.
20 changes: 2 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,36 +4,20 @@
[![Dependency Status](https://www.versioneye.com/user/projects/561b7b5ea193340f280012df/badge.svg?style=flat)](https://www.versioneye.com/user/projects/561b7b5ea193340f280012df) (Composer)

## Roadmap
* Removing all deployment functionality
* Better documentation

## Requirements

* PHP >= 5.4
* Ansible >= 1.7 (for deployments)

## Installation

1. Clone the git repo - `git clone git@github.com:jshmrtn/rokket.git`
2. Run `composer install`
3. Copy `.env.example` to `.env` and update environment variables.
4. Add theme(s) in `web/app/themes` as you would for a normal WordPress site.
4. Set your site vhost document root to `/path/to/site/web/` (`/path/to/site/current/web/` if using deployments)
4. Set your site vhost document root to `/path/to/site/web/`
5. Access WP admin at `http://example.com/wp/wp-admin`

## Deployments

### Setup
1. Copy `config/deploy/vars/deployment_vars_local.yml.example` to `/config/deploy/vars/deployment_vars_local.yml`.
2. Copy `config/deploy/vars/deployment_vars.yml.example` to `/config/deploy/vars/deployment_vars.yml`.
2. Set your local variables in `config/deploy/vars/deployment_vars_local.yml`.
3. Set your project specific variables in `config/deploy/vars/deployment_vars.yml`.
4. Set your Dev/Staging/Production Server IP(s) or Hostname(s) in `config/deploy/hosts/*`.
5. For each different host copy `config/deploy/host_vars/yourhost.yml.example` and name it according to the declaration in `config/deploy/hosts/*`.
6. Set your host specific variables in `config/deploy/host_vars/*.yml`

### Usage
Run `./rokket.sh` for instructions.

## Contributing

Contributions are welcome from everyone. We will add [contributing guidelines](CONTRIBUTING.md) as soon as possible.
Expand Down
2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"type": "project",
"license": "MIT",
"description": "Full fledged modern Wordpress stack.",
"version": "2.0.4",
"version": "2.0.5",
"homepage": "https://github.com/jshmrtn/rokket/",
"authors": [
{
Expand Down
4 changes: 2 additions & 2 deletions composer.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit b7d9df3

Please sign in to comment.