├── .gitignore
├── Vagrantfile
├── LICENSE
├── README.md
└── Vagrant-setup
    └── bootstrap.sh


/.gitignore:
--------------------------------------------------------------------------------
1 | .vagrant
2 | 


--------------------------------------------------------------------------------
/Vagrantfile:
--------------------------------------------------------------------------------
 1 | # -*- mode: ruby -*-
 2 | # vi: set ft=ruby :
 3 | 
 4 | $script = <<SCRIPT
 5 | echo I am provisioning...
 6 | date > /etc/vagrant_provisioned_at
 7 | SCRIPT
 8 | 
 9 | Vagrant.configure("2") do |config|
10 |   config.vm.provision "shell", inline: $script
11 | end
12 | 
13 | Vagrant::Config.run do |config|
14 |   config.vm.box = "ubuntu/trusty64"
15 |   config.vm.host_name = "postgresql" 
16 | 
17 |   config.vm.share_folder "bootstrap", "/mnt/bootstrap", ".", :create => true
18 |   config.vm.provision :shell, :path => "Vagrant-setup/bootstrap.sh"
19 |   
20 |   # PostgreSQL Server port forwarding
21 |   config.vm.forward_port 5432, 15432
22 | end
23 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | The MIT License (MIT)
 2 | 
 3 | Copyright © JackDB, Inc. 2014
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining
 6 | a copy of this software and associated documentation files (the
 7 | "Software"), to deal in the Software without restriction, including
 8 | without limitation the rights to use, copy, modify, merge, publish,
 9 | distribute, sublicense, and/or sell copies of the Software, and to
10 | permit persons to whom the Software is furnished to do so, subject to
11 | the following conditions:
12 | 
13 | The above copyright notice and this permission notice shall be
14 | included in all copies or substantial portions of the Software.
15 | 
16 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17 | EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18 | MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19 | IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
20 | CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
21 | TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
22 | SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | ### What is it?
 2 | 
 3 | A Vagrant configuration that starts up a PostgreSQL database in a virtual machine for local application development.
 4 | 
 5 | ### Installation
 6 | 
 7 | First install [Vagrant] and [Virtual Box].
 8 | 
 9 | Then, run the following to create a new PostgreSQL app dev virtual machine:
10 | 
11 | 	# Clone it locally:
12 |     $ git clone https://github.com/jackdb/pg-app-dev-vm myapp
13 | 
14 |     # Enter the cloned directory:
15 |     $ cd myapp
16 | 
17 |     # Delete the old .git and README:
18 |     $ rm -rf README.md .git
19 | 
20 |     # Optionally edit the database username/password:
21 |     $ $EDITOR Vagrant-setup/bootstrap.sh
22 | 
23 | ### Usage
24 | 
25 |     # Start up the virtual machine:
26 |     $ vagrant up
27 | 
28 |     # Stop the virtual machine:
29 |     $ vagrant halt
30 | 
31 | ### What does it do?
32 | 
33 | It creates a virtual server running Ubuntu 14.04 with the latest version of PostgreSQL (*as of writing 9.4*) installed. It also edits the PostgreSQL configuration files to allow network access and creates a database user/database for your application to use.
34 | 
35 | Once it has started up it will print out how to access the database on the virtual machine. It will look something like this:
36 | 
37 |     $ vagrant up
38 |     Bringing machine 'default' up with 'virtualbox' provider...
39 |     [... truncated ...]
40 |     Your PostgreSQL database has been setup and can be accessed on your local machine on the forwarded port (default: 15432)
41 |       Host: localhost
42 |       Port: 15432
43 |       Database: myapp
44 |       Username: myapp
45 |       Password: dbpass
46 | 
47 |     Admin access to postgres user via VM:
48 |       vagrant ssh
49 |       sudo su - postgres
50 | 
51 |     psql access to app database user via VM:
52 |       vagrant ssh
53 |       sudo su - postgres
54 |       PGUSER=myapp PGPASSWORD=dbpass psql -h localhost myapp
55 | 
56 |     Env variable for application development:
57 |       DATABASE_URL=postgresql://myapp:dbpass@localhost:15432/myapp
58 | 
59 |     Local command to access the database via psql:
60 |       PGUSER=myapp PGPASSWORD=dbpass psql -h localhost -p 15432 myapp
61 | 
62 | ### Why use the shell provisioner?
63 | 
64 | Or alternatively, why not [Chef](http://www.getchef.com/chef/), [Puppet](http://puppetlabs.com/), [Ansible](http://www.ansibleworks.com/), or [Salt](http://www.saltstack.com/)?
65 | 
66 | Mainly because it's simple and anybody with a basic knowledge of shell scripting can tweak the `bootstrap.sh` to their liking.
67 | 
68 | ### License
69 | 
70 | This is released under the MIT license. See the file [LICENSE](LICENSE).
71 | 
72 | [Virtual Box]: https://www.virtualbox.org/
73 | Vagrant]: http://www.vagrantup.com/
74 | 


--------------------------------------------------------------------------------
/Vagrant-setup/bootstrap.sh:
--------------------------------------------------------------------------------
  1 | #!/bin/sh -e
  2 | 
  3 | # Edit the following to change the name of the database user that will be created:
  4 | APP_DB_USER=myapp
  5 | APP_DB_PASS=dbpass
  6 | 
  7 | # Edit the following to change the name of the database that is created (defaults to the user name)
  8 | APP_DB_NAME=$APP_DB_USER
  9 | 
 10 | # Edit the following to change the version of PostgreSQL that is installed
 11 | PG_VERSION=9.4
 12 | 
 13 | ###########################################################
 14 | # Changes below this line are probably not necessary
 15 | ###########################################################
 16 | print_db_usage () {
 17 |   echo "Your PostgreSQL database has been setup and can be accessed on your local machine on the forwarded port (default: 15432)"
 18 |   echo "  Host: localhost"
 19 |   echo "  Port: 15432"
 20 |   echo "  Database: $APP_DB_NAME"
 21 |   echo "  Username: $APP_DB_USER"
 22 |   echo "  Password: $APP_DB_PASS"
 23 |   echo ""
 24 |   echo "Admin access to postgres user via VM:"
 25 |   echo "  vagrant ssh"
 26 |   echo "  sudo su - postgres"
 27 |   echo ""
 28 |   echo "psql access to app database user via VM:"
 29 |   echo "  vagrant ssh"
 30 |   echo "  sudo su - postgres"
 31 |   echo "  PGUSER=$APP_DB_USER PGPASSWORD=$APP_DB_PASS psql -h localhost $APP_DB_NAME"
 32 |   echo ""
 33 |   echo "Env variable for application development:"
 34 |   echo "  DATABASE_URL=postgresql://$APP_DB_USER:$APP_DB_PASS@localhost:15432/$APP_DB_NAME"
 35 |   echo ""
 36 |   echo "Local command to access the database via psql:"
 37 |   echo "  PGUSER=$APP_DB_USER PGPASSWORD=$APP_DB_PASS psql -h localhost -p 15432 $APP_DB_NAME"
 38 | }
 39 | 
 40 | export DEBIAN_FRONTEND=noninteractive
 41 | 
 42 | PROVISIONED_ON=/etc/vm_provision_on_timestamp
 43 | if [ -f "$PROVISIONED_ON" ]
 44 | then
 45 |   echo "VM was already provisioned at: $(cat $PROVISIONED_ON)"
 46 |   echo "To run system updates manually login via 'vagrant ssh' and run 'apt-get update && apt-get upgrade'"
 47 |   echo ""
 48 |   print_db_usage
 49 |   exit
 50 | fi
 51 | 
 52 | PG_REPO_APT_SOURCE=/etc/apt/sources.list.d/pgdg.list
 53 | if [ ! -f "$PG_REPO_APT_SOURCE" ]
 54 | then
 55 |   # Add PG apt repo:
 56 |   echo "deb http://apt.postgresql.org/pub/repos/apt/ trusty-pgdg main" > "$PG_REPO_APT_SOURCE"
 57 | 
 58 |   # Add PGDG repo key:
 59 |   wget --quiet -O - https://apt.postgresql.org/pub/repos/apt/ACCC4CF8.asc | apt-key add -
 60 | fi
 61 | 
 62 | # Update package list and upgrade all packages
 63 | apt-get update
 64 | apt-get -y upgrade
 65 | 
 66 | apt-get -y install "postgresql-$PG_VERSION" "postgresql-contrib-$PG_VERSION"
 67 | 
 68 | PG_CONF="/etc/postgresql/$PG_VERSION/main/postgresql.conf"
 69 | PG_HBA="/etc/postgresql/$PG_VERSION/main/pg_hba.conf"
 70 | PG_DIR="/var/lib/postgresql/$PG_VERSION/main"
 71 | 
 72 | # Edit postgresql.conf to change listen address to '*':
 73 | sed -i "s/#listen_addresses = 'localhost'/listen_addresses = '*'/" "$PG_CONF"
 74 | 
 75 | # Append to pg_hba.conf to add password auth:
 76 | echo "host    all             all             all                     md5" >> "$PG_HBA"
 77 | 
 78 | # Explicitly set default client_encoding
 79 | echo "client_encoding = utf8" >> "$PG_CONF"
 80 | 
 81 | # Restart so that all new config is loaded:
 82 | service postgresql restart
 83 | 
 84 | cat << EOF | su - postgres -c psql
 85 | -- Create the database user:
 86 | CREATE USER $APP_DB_USER WITH PASSWORD '$APP_DB_PASS';
 87 | 
 88 | -- Create the database:
 89 | CREATE DATABASE $APP_DB_NAME WITH OWNER=$APP_DB_USER
 90 |                                   LC_COLLATE='en_US.utf8'
 91 |                                   LC_CTYPE='en_US.utf8'
 92 |                                   ENCODING='UTF8'
 93 |                                   TEMPLATE=template0;
 94 | EOF
 95 | 
 96 | # Tag the provision time:
 97 | date > "$PROVISIONED_ON"
 98 | 
 99 | echo "Successfully created PostgreSQL dev virtual machine."
100 | echo ""
101 | print_db_usage
102 | 


--------------------------------------------------------------------------------