Skip to content
This repository has been archived by the owner on Aug 2, 2019. It is now read-only.

Commit

Permalink
fiddling with spacing to try to improve markdown formatting results
Browse files Browse the repository at this point in the history
  • Loading branch information
lornajane committed Sep 26, 2012
1 parent 9fd5a51 commit a97dc6b
Showing 1 changed file with 18 additions and 12 deletions.
30 changes: 18 additions & 12 deletions README.md
Expand Up @@ -9,29 +9,35 @@ You can either install joind.in on an existing PHP platform, or use our vagrant
## Quick Start - Using Vagrant

You can set up a development virtual machine running joind.in by following these simple instructions.

1. Install requirements. (Note: these are not required by joind.in itself, but are required for this quick start guide.)
- VirtualBox (https://www.virtualbox.org/) (versions 4.0 and 4.1 are currently supported)
- Ruby (http://www.ruby-lang.org/)
- Vagrant (http://vagrantup.com/)

2. Clone repository to any location and fetch required submodules (containing Puppet manifests).
git clone https://github.com/joindin/joind.in && cd joind.in
git submodule init
git submodule update
git clone https://github.com/joindin/joind.in && cd joind.in
git submodule init
git submodule update

3. Start the process by running Vagrant.
> vagrant up
vagrant up

4. Add hostname to /etc/hosts.
> echo "127.0.0.1 dev.joind.in" | sudo tee -a /etc/hosts
echo "127.0.0.1 dev.joind.in" | sudo tee -a /etc/hosts

5. Browse to the newly provisioned development copy of joind.in.
> open http://dev.joind.in:8080
open http://dev.joind.in:8080

*Notes:*

- HTTP and SSH ports on the VM are forwarded to localhost (22 -> 2222, 80 -> 8080)
- The joind.in directory you cloned will be mounted inside the VM at /vagrant
- You can develop by editing the files you cloned in the IDE of you choice.
- The database is running inside the VM. You can get to it by doing the following:
you@you> vagrant ssh
vagrant@vm> sudo su
root@vm> mysql joindin
you@you> vagrant ssh
vagrant@vm> sudo su
root@vm> mysql joindin
- To stop the VM do one of the following:
> vagrant suspend # if you plan on running it later
> vagrant destroy # if you wish to delete the VM completely
Expand All @@ -49,13 +55,13 @@ You can set up a development virtual machine running joind.in by following these
(use the correct username and password)
4. Create directories for user-added content.

mkdir src/system/cache/ctokens && chown apache:apache src/system/cache/ctokens
mkdir src/system/cache/ctokens && chown apache:apache src/system/cache/ctokens

(or whatever user and group your web server runs as)
5. Create configuration files for database and config (based on the .dist templates):

cp src/system/application/config/database.php.dist src/system/application/config/database.php
cp src/system/application/config/config.php.dist src/system/application/config/config.php
cp src/system/application/config/database.php.dist src/system/application/config/database.php
cp src/system/application/config/config.php.dist src/system/application/config/config.php

Edit these files as appropriate!

Expand Down

0 comments on commit a97dc6b

Please sign in to comment.