Skip to content
Use Vagrant to build a server with Ghost and nginx configured ready for blogging action
Shell Nginx
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
ghost
nginx
provisioners/shell
util-scripts
.gitignore
LICENSE
README.md
Vagrantfile

README.md

vagrant-ghost

Uses Vagrant to configure Ghost fronted by nginx as a reverse proxy ready for your blogging pleasure.

Note that this is currently configured to work with the following providers:

Install

Install Vagrant and the plugin for the provider you are going to use:

Clone the repository to get a copy of the code:

git clone https://github.com/cruskit/vagrant-ghost.git

Configure

You will need to configure some environment variables to customize the creation process. These are:

VirtualBox

  • PRIVATE_KEY_PATH : the location of the private key to use with SSH when provisioning & accessing your Digital Ocean droplet.

Digital Ocean

  • DO_AUTH_TOKEN : the Authorisation Token to use with Digital Ocean. Log into the Digital Ocean console, use "Apps & Apis" and generate a Personal Access Token to use here.
  • PRIVATE_KEY_PATH : the location of the private key to use with SSH when provisioning & accessing your Digital Ocean droplet.
  • TARGET_HOST_NAME : the hostname to give for the provisioned machine. If you have a DNS name for the machine, this would be ideal to use here.

Amazon Web Services

This assumes you've created an IAM user with permissions to perform provisioning activites. Use the IAM user credentials for below.

Note that the provisioning script assumes you've got an AWS Security Group named "WebServer", so if you don't you'll need to create it. It will need TCP access on ports 22, 80 and 443.

  • AWS_KEYPAIR_NAME : the name of the keypair that AWS will load into the created VM to allow access
  • AWS_PRIVATE_KEY_PATH : the location of the private key associated with the AWS_KEYPAIR_NAME
  • AWS_ACCESS_KEY_ID : access key id for an AWS IAM user with permissions to provision a machine
  • AWS_ACCESS_KEY : the access for that corresponds to AWS_ACCESS_KEY_ID

If you are feeling lazy, you may want to just create a file, for example setenv.sh with contents:

export PRIVATE_KEY_PATH="~/.ssh/private_key_name"

export DO_AUTH_TOKEN="my token"
export TARGET_HOST_NAME="myhostname"

export AWS_PRIVATE_KEY_PATH="~/.ssh/private_key_name.pem"
export AWS_ACCESS_KEY_ID="AAAABBBBBCCCCCCDDDDD"
export AWS_ACCESS_KEY="aaaabbbbbbccccccddddd"
export AWS_KEYPAIR_NAME="aws-keypair-name"

and then run source ./setenv.sh to set the environment variables.

Run

To provision your machine run the following from the directory where you cloned the code:

vagrant up --provider=digital_ocean

or

vagrant up --provider=aws

This will create you a new Digital Ocean or AWS virtual machine and install and configure Ghost & nginx.

Once this completes you can access Ghost at:

  • https://<host_ip/

(Note that if using the VirtualBox provider, you will need to use https://localhost:8443/ as forwarding ports under 1024 doesn't work on the Mac, so it is set to forward 8443->443)

You will need to login and create an admin account at:

  • https://<host_ip/ghost

Note that the server is configured with a self signed certificate so you'll need to click through the certificate warning in your browser.

Some useful commands for working with your machine:

  • vagrant ssh : will log you into the Droplet as root so you can do some more fine tuning
  • vagrant destroy : will terminate the Droplet and remove it so you stop getting charged for it

Things to note

SSL Certificates

The install will automatically create you a self signed certificate so that HTTPS connections will work. nginx is configured to look for the following certificates, so you can replace these if you've generated some properly signed certificates for your domain:

  • /etc/nginx/certs/server.crt;
  • /etc/nginx/certs/server.key;

If you have valid certificates, put them in the vagrant directory /certificates (call them server.crt and server.key) and the provisioner will copy them to the above location.

Managing nginx & ghost

Ghost and nginx are configured to be managed by systemd. They are configured for automatic restart on boot.

If you make a configuration change you can restart them by:

  • systemctl restart nginx
  • systemctl restart ghost

Note that there are also corresponding commands for stop/start/status. nginx also supports a reload command if you have just modified the configuration.

Ghost Themes

Any themes provided under: /vagrant/ghost/themes/ will automatically be installed in Ghost

List of potential future enhancements

These are things that are on the list for later:

  • nginx log file rotation & archiving / cleanup
  • npm log file rotation & archiving / cleanup
You can’t perform that action at this time.