Go to file

Hannah Wolfe c64148f361 Merge pull request #2256 from caerphoto/1795-typography Add support for typographically-correct punctuation		2014-02-28 10:49:06 +00:00
content	Rename 'plugins' to 'apps'	2014-01-21 15:45:27 +07:00
core	Merge pull request #2256 from caerphoto/1795-typography	2014-02-28 10:49:06 +00:00
.gitignore	Rename 'plugins' to 'apps'	2014-01-21 15:45:27 +07:00
.gitmodules	Changed git submodule to use git instead of ssh	2013-10-14 11:26:38 -04:00
.npmignore	Update package.json for publishing to npm	2014-02-23 09:38:47 -05:00
.travis.yml	Fix package.json scripts to be more in line with	2014-02-18 22:53:21 -05:00
config.example.js	Add logging config option	2014-02-10 21:07:11 +00:00
CONTRIBUTING.md	Fix package.json scripts to be more in line with	2014-02-18 22:53:21 -05:00
Gemfile	Explicitly add Ruby dependencies to project via Bundler	2013-10-23 18:16:16 -07:00
Gemfile.lock	Explicitly add Ruby dependencies to project via Bundler	2013-10-23 18:16:16 -07:00
Gruntfile.js	Add support for typographically-correct punctuation	2014-02-28 09:44:08 +00:00
index.js	Restore support for using ghost as a npm module fixes #1326	2013-11-27 17:39:14 +00:00
LICENSE	2013 => 2014	2014-01-13 01:31:58 +01:00
package.json	Update package.json for publishing to npm	2014-02-23 09:38:47 -05:00
README.md	ReadMe Improvements	2014-02-26 22:19:32 +01:00
SECURITY.md	Use less markup for links	2013-10-22 21:22:35 +01:00

README.md

Ghost

Ghost is a free, open, simple blogging platform that's available to anyone who wants to use it. Lovingly created and maintained by John O'Nolan + Hannah Wolfe + an amazing group of contributors.

Visit the project's website at http://ghost.org • docs on http://docs.ghost.org.

Getting Involved

Want to report a bug, request a feature, or help us build or translate Ghost? Check out our in depth guide to Contributing to Ghost. We need all the help we can get! You can also join in with our community to keep up-to-date and meet other Ghosters.

Getting Started

There are two main ways to get started with Ghost, take care to use the method which best suits your needs.

Please note - the downloadable zip files we provide on Ghost.org are pre-built packages designed for getting started quickly. Cloning from the git repository requires you to install several dependencies and build the assets yourself.

Getting Started Guide for Bloggers

If you just want to get a Ghost blog running in the fastest time possible, this method is for you.

For detailed instructions for various platforms visit the Ghost Installation Guide. If you get stuck, help is available on our forum.

Install Node.js - Ghost requires Node v0.10.
Download the latest Ghost package from Ghost.org. If you cloned the GitHub repository you should follow the instructions for developers.
Create a new directory where you would like to run the code, and unzip the package to that location.
Fire up a terminal (or node command prompt in Windows) and change directory to the root of the Ghost application (where config.example.js and index.js are)
run npm install --production to install the node dependencies. If you see error Error: ENOENT on this step, make sure you are in the project directory and try again.
To start ghost, run npm start
Visit http://localhost:2368/ in your web browser or go to http://localhost:2368/ghost to log in

Check out the Documentation for more detailed instructions, or get in touch via the forum if you get stuck.

Getting Started Guide for Developers

If you're a theme, app or core developer, or someone comfortable getting up and running from a git clone, this method is for you.

If you clone the GitHub repository, you will need to build a number of assets, such as SASS and JavaScript templates. This requires you to have Ruby and a number of other pre-requisites. Full instructions can be found in the Contributing Guide under the heading "Working on Ghost Core".

Check out the Documentation for more detailed instructions, or get in touch via the forum if you get stuck.

If you want to use Ghost as a NPM module there is a Wiki entry where you can find instructions on how to get set up.

Upgrading to The Latest Version

Upgrade instructions are in the Ghost Guide

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 to register a new user. Once you have entered your desired credentials you will be automatically logged in to the admin area.

Community

Keep track of Ghost development and Ghost community activity.

Follow Ghost on Twitter, Facebook and Google+.
Read and subscribe to the The Official Ghost Blog.
Join in discussions on the Ghost Forum
Chat with Ghost developers on IRC. We're on irc.freenode.net, in the #Ghost channel. We have a public meeting every Tuesday at 5:30pm London time.

Versioning

For transparency and insight into our release cycle, and for striving to maintain backward compatibility, Ghost will be maintained according to the Semantic Versioning guidelines as much as possible.

Releases will be numbered with the following format:

<major>.<minor>.<patch>-<build>

Constructed with the following guidelines:

A new major release indicates a large change where backwards compatibility is broken.
A new minor release indicates a normal change that maintains backwards compatibility.
A new patch release indicates a bugfix or small change which does not affect compatibility.
A new build release indicates this is a pre-release of the version.