Ghost/README.md
John O'Nolan 3e67014c23 Added new Slack team details
BECAUSE INTERNET
2015-04-15 14:59:25 +03:00

4.4 KiB

Ghost Build status

Ghost Screenshot

Ghost is a simple, powerful publishing platform that allows you to share your stories with the world.

The project is maintained by a non-profit organisation called the Ghost Foundation, along with an amazing group of independent contributors. We're trying to make publishing software that changes the shape of online journalism.

Quick Start Install

Make sure you've installed Node.js - We recommend the latest Node v0.10.x release.

Ghost is also compatible with Node v0.12 and io.js v1.2, but please note that these versions are more likely to run into installation problems. May contain nuts. Please use the forum for help.

  1. Download the latest release of Ghost
  2. Unzip in the location you want to install
  3. Fire up a terminal
  4. npm install --production
  5. Start Ghost!
    • Local environment: npm start
    • On a server: npm start --production
  6. http://localhost:2368/ghost 🎉

More install docs here in case you got stuck.

Developer Install (from git)

Install Node.js.

# Node v0.10.x - full support
# Node v0.12.x and io.js v1.2 - partial support
#
# Choose wisely

Clone 👻

git clone git://github.com/tryghost/ghost.git
cd ghost

Install grunt. No prizes here.

npm install -g grunt-cli

Install Ghost. If you're running locally, use master. For production, use stable. 🚫🚀🔬

npm install

Build the things!

grunt init

Minify that shit for production?

grunt prod

Start your engines.

npm start

## running production? Add --production

Congrats! You made it. BTW you can also just npm install ghost if you're into that sort of thing. NPM afficionados can also read up on using Ghost as an NPM module.

More general install docs here in case you got stuck.

Deploying Ghost

The easiest way to deploy Ghost is on our official Ghost(Pro) hosted platform. This service funds the Ghost Foundation, which makes actively maintaining this project possible.

Also, you get to save yourself a lot of wasted time and headaches by deploying a new instance of Ghost to a managed server with a global content delivery network in just a few clicks.

Other options are available if you prefer playing around with servers by yourself.

Staying Up to Date

When a new version of Ghost comes out, you'll want to look over these upgrade instructions for what to do next.

You can talk to other Ghost users on our forums or chat with Ghost developers in our public Slack team (it's pretty awesome). We have a public meeting every Tuesday at 5:30pm London time.

New releases are announced on the dev blog. You can subscribe by email or follow @TryGhost_Dev on Twitter, if you prefer your updates bite-sized and facetious.

🎷🐢

Copyright & License

Copyright (c) 2013-2015 Ghost Foundation - Released under the MIT license.