Skip to content

Commit

Permalink
Updating readme with instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
bwhiteman committed Jul 23, 2015
1 parent 320ed61 commit 93c1154
Showing 1 changed file with 29 additions and 2 deletions.
31 changes: 29 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,30 @@
# firmament
Perl and bash scripts to create cooperative database and web server docker containers.
Perl and bash scripts to create cooperative database and web server docker containers.
Provides a simplified configuration of interconnected [Docker containers](https://docker.com)
* Provides a straigtforward mechanism to deploy Node Express apps into Docker containers
* Aliases and simplifies common Docker commands to make deploying, linking, and managing Docer containers easier.
* Composed of Node and Bash scripts utilizing API's from Docker, GIT, and Strongloop.

# How To Get firmament
```Bash
$ wget https://github.com/sotera/firmament/raw/master/install-scripts/prep-ubuntu14.04.sh
$ sudo chmod 700 prep_ubuntu14.04.sh
$ sudo su
$ ./prep_ubuntu14.04.sh
exit
$ git clone https://github.com/Sotera/firmament
$ cd firmament/install-scripts
$ ./prep-client.sh
>> 3 for using vim
$ sudo usermod -aG docker ubuntu
```
close your terminal and log back in for changes to take effect.

# Usage
* List available commands ```$ f --help```
* Firmament pulls required modules as needed or you can get all required modules at once. ```$ f init```
* Create a template of lined Docker Containers (from ~/firmament). ```$ f m t```
* Edit the template to create the containers you wish with links to the repositores that host your apps.
* Build the containers. ```$ f m b```
* Firmament aliases Docker as 'd'
* ```$ docker ps``` == ```$ f d ps```
* ```$ f d sh 5``` will shell into Docker Container #5 from the ps results.

0 comments on commit 93c1154

Please sign in to comment.