Welcome to Ghost

This short guide will teach you how to get Ghost up and running on your computer. It doesn't cover deploying it to a live server, just getting it running on your machine so that you can use it, and develop on top of it.

Setup Instructions

Compatibility Notes

Ghost uses SQLite which must be built natively on the operating system you intend to run Ghost on. We are working to improve this process, but in the meantime the following OS compatibility notes apply:

  • Linux - Ghost should install and run with no problems
  • Mac - you may require Xcode (free) and the CLI Tools which can be installed from Xcode to get Ghost installed
  • Windows - Ghost will and does install and run (really well actually) on Windows, but there are a set of pre-requisites which are tricky to install. Detailed instructions for this are coming very soon.

Pre-requisites

Ghost requires node 0.10.* or 0.11.* and npm. Download and install from nodejs.org

Installing

  1. Once you've downloaded one of the release packages, unzip it, and place the directory wherever you would like to run the code
  2. Fire up a terminal (or node command prompt in Windows) and change directory to the root of the Ghost application (where config.js and index.js are)
  3. run npm install to install the node dependencies (if you get errors to do with SQLite, please see the compatibility notes)
  4. To start ghost, run npm start
  5. Visit http://localhost:2368/ in your web browser

Logging in For The First Time

Once you have the Ghost server up and running, you should be able to navigate to http://localhost:2368/ghost from a web browser, where you will be prompted for a login.

  1. Click on the "register new user" link
  2. Enter your user details (careful here: There is no password reset yet!)
  3. Return to the login screen and use those details to log in.

Finding Your Way Around Ghost

You should now be logged in and up and running with the very first, very earliest, most historically significant, most prototypal version of the Ghost blogging platform. Click around the dashboard. You will find that most things work, but many things do not. We're still working on those. Keep downloading the new packages as we release them, and you should hopefully see big changes between each version as we go!