Ghost/README.md
2015-12-23 15:36:44 -05:00

4.5 KiB
Raw Blame History

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.

NOTE: If youre stuck, cant get something working or need some help, please head on over and join our Slack community rather than opening an issue.

Quick Start Install

Make sure you've installed Node.js - We recommend the latest Node v0.10.x release. For other versions click here. May contain nuts.

  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 - recommended
# Node v0.12.x and v4.2.x - supported
#
# 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 aficionados can also read up on using Ghost as an NPM module.

More general install docs here in case you got stuck.

Deploying Ghost

Ghost(Pro) + DigitalOcean

Save yourself time and headaches with our fully managed Ghost(Pro) service. Deploy a new instance of Ghost in a couple of clicks running on DigitalOceans rock solid infrastructure, with a worldwide CDN thrown in at no extra charge.

All revenue from Ghost(Pro) goes to the Ghost Foundation, the non-profit org which funds the maintenance and further development of Ghost.

Other options are also 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 and developers in our public Slack team (it's pretty awesome). We have a public meeting every Tuesday at 5:30pm UK 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.