Ghost/README.md

102 lines
4.3 KiB
Markdown
Raw Normal View History

2016-09-20 12:27:48 +03:00
<a href="https://github.com/TryGhost/Ghost"><img src="https://cloud.githubusercontent.com/assets/120485/18661790/cf942eda-7f17-11e6-9eb6-9c65bfc2abd8.png" alt="Ghost" /></a>
2015-03-12 22:40:21 +03:00
<a href="https://travis-ci.org/TryGhost/Ghost"><img align="right" src="https://travis-ci.org/TryGhost/Ghost.svg?branch=master" alt="Build status" /></a>
2016-09-20 12:27:48 +03:00
<a href="https://dev.ghost.org/lts"><img src="https://cloud.githubusercontent.com/assets/120485/18661856/0930282e-7f18-11e6-948a-00546393fd93.png" alt="Warning: Major release in progress. Expect things to be broken in master." /></a>
2013-05-11 20:44:25 +04:00
2015-03-12 22:40:21 +03:00
The project is maintained by a non-profit organisation called the **Ghost Foundation**, along with an amazing group of independent [contributors](https://github.com/TryGhost/Ghost/contributors). We're trying to make publishing software that changes the shape of online journalism.
2015-03-12 22:40:21 +03:00
- [Ghost.org](https://ghost.org)
- [Latest Release](https://ghost.org/developers/)
- [Support](http://support.ghost.org/)
2015-03-12 22:40:21 +03:00
- [Theme Docs](http://themes.ghost.org)
- [Contributing Guide](https://github.com/TryGhost/Ghost/blob/master/.github/CONTRIBUTING.md)
2015-03-12 22:40:21 +03:00
- [Feature Requests](http://ideas.ghost.org/)
2016-09-20 12:27:48 +03:00
- [Developer Blog](http://dev.ghost.org)
**NOTE: If youre stuck, cant get something working or need some help, please head on over and join our [Slack community](https://ghost.org/slack/) rather than opening an issue.**
2016-09-20 12:27:48 +03:00
&nbsp;
2013-11-12 13:05:57 +04:00
2015-03-12 22:40:21 +03:00
# Quick Start Install
2013-11-12 13:05:57 +04:00
2016-09-20 12:27:48 +03:00
First, youll need **Node.js v4 LTS** or a [supported version](http://support.ghost.org/supported-node-versions/).
1. Download the [latest release](https://ghost.org/developers/) of Ghost
2016-09-20 12:27:48 +03:00
1. Unzip, and fire up terminal
2015-03-12 22:40:21 +03:00
1. `npm install --production`
1. Start Ghost!
- Local environment: `npm start`
- On a server: `npm start --production`
1. `http://localhost:2368/ghost` :tada:
2016-09-20 12:27:48 +03:00
More [install docs](http://support.ghost.org/installation/) here in case you get stuck.
2016-09-20 12:27:48 +03:00
&nbsp;
2016-09-20 12:27:48 +03:00
<a name="getting-started"></a>
# Developer Install
2015-02-28 19:46:16 +03:00
2016-09-20 12:27:48 +03:00
This is for if you want to hack on Ghost core. First, youll need **Node.js v4 LTS** or a [supported version](http://support.ghost.org/supported-node-versions/). Then:
2015-03-12 22:40:21 +03:00
```bash
git clone git://github.com/tryghost/ghost.git
cd ghost
```
2016-09-20 12:27:48 +03:00
Install grunt
2015-03-12 22:40:21 +03:00
```bash
npm install -g grunt-cli
```
2016-09-20 12:27:48 +03:00
Install Ghost
2015-03-12 22:40:21 +03:00
```bash
npm install
```
2015-03-12 22:40:21 +03:00
Build the things!
2015-03-12 22:40:21 +03:00
```bash
grunt init
```
2016-09-20 12:27:48 +03:00
Start your engines
2015-03-12 22:40:21 +03:00
```bash
2016-09-20 12:27:48 +03:00
grunt dev
2015-03-12 22:40:21 +03:00
```
2016-09-20 12:27:48 +03:00
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](https://github.com/TryGhost/Ghost/wiki/Using-Ghost-as-an-npm-module). More general [install docs](http://support.ghost.org/installation/) here in case you got stuck.
2014-03-20 15:53:23 +04:00
2016-09-20 12:27:48 +03:00
&nbsp;
2015-03-12 22:40:21 +03:00
# Deploying Ghost
2016-09-20 12:27:48 +03:00
<a href="https://ghost.org/pricing"><img src="https://cloud.githubusercontent.com/assets/120485/18662071/f30da886-7f18-11e6-90f2-42c0ade79fd1.png" alt="Ghost(Pro)" /></a>
The easiest way to deploy Ghost is with our official **[Ghost(Pro)](https://ghost.org/pricing/)** managed service. You can have a fresh instance up and running in a couple of clicks with a worldwide CDN, backups, security and maintenance all done for you.
2016-09-20 12:27:48 +03:00
Not only will it save you [many hours per month](https://ghost.org/ghost-pro-vs-self-hosting/), but all revenue goes to the Ghost Foundation, which funds the maintenance and further development of Ghost itself. So youll be supporting open source software *and* getting a great service **at the same time**! Talk about win/win. :trophy:
2016-09-20 12:27:48 +03:00
[Other options](http://support.ghost.org/deploying-ghost/) are also available if you prefer playing around with servers by yourself, of course. The freedom of choice is in your hands.
2016-09-20 12:27:48 +03:00
&nbsp;
2015-03-12 22:40:21 +03:00
# Staying Up to Date
2015-03-12 22:40:21 +03:00
When a new version of Ghost comes out, you'll want to look over these [upgrade instructions](http://support.ghost.org/how-to-upgrade/) for what to do next.
2015-09-29 14:10:04 +03:00
You can talk to other Ghost users and developers in our [public Slack team](https://ghost.org/slack/) (it's pretty awesome). We have a public meeting every Tuesday at 5:30pm UK time.
2016-09-20 12:27:48 +03:00
New releases are announced on the [dev blog](http://dev.ghost.org/tag/releases/). You can subscribe by email or follow [@TryGhost_Dev](https://twitter.com/tryghost_dev) on Twitter, if you prefer your updates bite-sized and facetious. :saxophone::turtle:
2016-09-20 12:27:48 +03:00
&nbsp;
2015-03-12 22:40:21 +03:00
# Copyright & License
2013-05-19 19:37:45 +04:00
Copyright (c) 2013-2017 Ghost Foundation - Released under the [MIT license](LICENSE).