mirror of
https://github.com/TryGhost/Ghost.git
synced 2024-12-14 18:52:05 +03:00
Hannah Wolfe
commit
bcede61a0a
157
README.md
157
README.md
@ -1,101 +1,114 @@
|
||||
# [Ghost](https://github.com/TryGhost/Ghost) [](https://travis-ci.org/TryGhost/Ghost)
|
||||
<a href="https://github.com/TryGhost/Ghost"><img src="https://cloud.githubusercontent.com/assets/120485/6622822/c4c639fe-c8e7-11e4-9e64-5bec06c8b4c3.png" alt="Ghost" /></a>
|
||||
<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>
|
||||
|
||||
|
||||
|
||||
|
||||
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](http://twitter.com/JohnONolan) + [Hannah Wolfe](http://twitter.com/ErisDS) + an amazing group of [contributors](https://github.com/TryGhost/Ghost/contributors).
|
||||
|
||||
|
||||
Visit the project's website at <http://ghost.org> • docs on <http://support.ghost.org>.
|
||||
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.
|
||||
|
||||
- [Ghost.org](https://ghost.org)
|
||||
- [Latest Release](https://ghost.org/download/)
|
||||
- [Support](https://ghost.org/support/)
|
||||
- [Theme Docs](http://themes.ghost.org)
|
||||
- [Contributing Guide](https://github.com/TryGhost/Ghost/blob/master/CONTRIBUTING.md)
|
||||
- [Feature Requests](http://ideas.ghost.org/)
|
||||
- [Dev Blog](http://dev.ghost.org)
|
||||
|
||||
|
||||
## Getting Involved
|
||||
# Quick Start Install
|
||||
|
||||
Want to report a bug, request a feature, contribute, or translate Ghost? Check out our in-depth guide to [Contributing to Ghost](https://github.com/TryGhost/Ghost/blob/master/CONTRIBUTING.md). We need all the help we can get! You can also join in with our [community](https://github.com/TryGhost/Ghost#community) to keep up-to-date and meet other Ghosters.
|
||||
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](https://ghost.org/forum/installation/) for help.
|
||||
|
||||
1. Download the [latest release](https://ghost.org/download/) of Ghost
|
||||
1. Unzip in the location you want to install
|
||||
1. Fire up a terminal
|
||||
1. `npm install --production`
|
||||
1. Start Ghost!
|
||||
- Local environment: `npm start`
|
||||
- On a server: `npm start --production`
|
||||
1. `http://localhost:2368/ghost` :tada:
|
||||
|
||||
More [install docs](http://support.ghost.org/installation/) here in case you got stuck.
|
||||
|
||||
|
||||
## Getting Started
|
||||
# Developer Install (from git)
|
||||
|
||||
There are a few different ways to install Ghost, take care to use the method which best suits your needs.
|
||||
Install Node.js.
|
||||
|
||||
**Please note** - the downloadable zip files we provide on [Ghost.org](http://ghost.org/download), the [GitHub releases page](https://github.com/TryGhost/Ghost/releases), and via npm are pre-built packages designed for getting setup quickly. Cloning from the git repository requires you to install several dependencies and build the assets yourself.
|
||||
```bash
|
||||
# Node v0.10.x - full support
|
||||
# Node v0.12.x and io.js v1.2 - partial support
|
||||
#
|
||||
# Choose wisely
|
||||
```
|
||||
|
||||
### Compatibility
|
||||
Clone :ghost:
|
||||
|
||||
Ghost is fully compatible with **Node v0.10.x**, 0.10.36 is the recommended version of Node for running Ghost in production.
|
||||
```bash
|
||||
git clone git://github.com/tryghost/ghost.git
|
||||
cd ghost
|
||||
```
|
||||
|
||||
Ghost is also compatible with **Node v0.12** and **io.js-v1.2**. Please note that these versions are more likely to run into installation problems, please use the [support forum](https://ghost.org/forum/installation/) for help with install issues.
|
||||
Install grunt. No prizes here.
|
||||
|
||||
Ghost may also be compatible with other io.js versions, providing binaries are available for sqlite3, and for node-sass if you are building Ghost from source rather than using a pre-built zip file.
|
||||
```bash
|
||||
npm install -g grunt-cli
|
||||
```
|
||||
|
||||
Install Ghost. If you're running locally, use [master](https://github.com/TryGhost/Ghost/tree/master). For production, use [stable](https://github.com/TryGhost/Ghost/tree/stable). :no_entry_sign::rocket::microscope:
|
||||
|
||||
```bash
|
||||
npm install
|
||||
```
|
||||
|
||||
Build the things!
|
||||
|
||||
```bash
|
||||
grunt init
|
||||
```
|
||||
|
||||
Minify that shit for production?
|
||||
|
||||
```bash
|
||||
grunt prod
|
||||
```
|
||||
|
||||
Start your engines.
|
||||
|
||||
```bash
|
||||
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](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.
|
||||
|
||||
|
||||
### Install from zip (fastest & best for bloggers)
|
||||
# Deploying Ghost
|
||||
|
||||
If you just want to get a Ghost blog running in the fastest time possible, this method is for you.
|
||||
The easiest way to deploy Ghost is on our official <strong><a href="https://ghost.org/pricing/">Ghost(Pro)</a></strong> hosted platform. This service funds the Ghost Foundation, which makes actively maintaining this project possible.
|
||||
|
||||
For detailed instructions on various platforms, visit the [Ghost Installation Guide](http://support.ghost.org/installation/). If you get stuck, help is available on [our support site](http://support.ghost.org/).
|
||||
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.
|
||||
|
||||
1. Install [Node.js](http://nodejs.org) - See [compatibility](https://github.com/TryGhost/Ghost#compatibility) section for details of supported versions
|
||||
1. Download the latest Ghost package from [Ghost.org](http://ghost.org/download).
|
||||
1. Create a new directory where you would like to run the code, and un-zip the package to that location.
|
||||
1. Fire up a Terminal, the Node Command Prompt or shell and change directory to the root of the Ghost application (where config.example.js and index.js are)
|
||||
1. 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.
|
||||
1. To start ghost, run `npm start`
|
||||
1. Visit `http://localhost:2368/` in your web browser or go to `http://localhost:2368/ghost` to log in
|
||||
|
||||
Check out the [Documentation](http://support.ghost.org/) for more detailed instructions, or get in touch via the [forum](http://ghost.org/forum) if you get stuck.
|
||||
[Other options](http://support.ghost.org/deploying-ghost/) are available if you prefer playing around with servers by yourself.
|
||||
|
||||
|
||||
### Install from git
|
||||
# Staying Up to Date
|
||||
|
||||
If you're a developer or someone comfortable getting up and running from a `git clone`, this method is for you.
|
||||
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.
|
||||
|
||||
If you clone the GitHub repository, you will need to build a number of assets using grunt.
|
||||
You can talk to other Ghost users on [our forums](https://ghost.org/forum) or 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.
|
||||
|
||||
Please do **NOT** use the master branch of Ghost in production. If you are using git to deploy to production, please use the latest [release](https://github.com/TryGhost/Ghost/releases) or the [stable](https://github.com/TryGhost/Ghost/tree/stable) branch which contains the latest release.
|
||||
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.
|
||||
|
||||
Full instructions & troubleshooting tips can be found in the [Contributing Guide](https://github.com/TryGhost/Ghost/blob/master/CONTRIBUTING.md#working-on-ghost-core).
|
||||
|
||||
#### Quickstart:
|
||||
|
||||
1. Install node (see [compatibility](https://github.com/TryGhost/Ghost#compatibility) section for details of supported versions)
|
||||
1. `npm install -g grunt-cli`
|
||||
1. `npm install`
|
||||
1. `grunt init` (and `grunt prod` if you want to run Ghost in production mode)
|
||||
1. `npm start`
|
||||
|
||||
Check out the [Documentation](http://support.ghost.org/) for more detailed instructions, or get in touch via the [forum](http://ghost.org/forum) if you get stuck.
|
||||
:saxophone::turtle:
|
||||
|
||||
|
||||
### Install from npm
|
||||
|
||||
If you want to build Ghost into a larger node app, or are familiar with using `npm` packages, then this method might be for you.
|
||||
|
||||
`npm install ghost`
|
||||
|
||||
Further setup instructions can be found in the [using Ghost as an npm module](https://github.com/TryGhost/Ghost/wiki/Using-Ghost-as-an-npm-module) wiki entry.
|
||||
|
||||
|
||||
### Keeping up-to-date
|
||||
|
||||
Upgrade instructions can be found on the [Ghost Support Site](http://support.ghost.org/how-to-upgrade/).
|
||||
|
||||
New releases are announced on the [dev blog](http://dev.ghost.org/tag/releases/), which you can subscribe to for notifications of new versions. Each new release is published with highlights and a full changelog, which are also available on the [releases page](https://github.com/TryGhost/Ghost/releases) of GitHub.
|
||||
|
||||
|
||||
### 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 setup your blog and user account. Once you have entered your desired credentials you will be automatically logged in to the admin area. The setup screen will not be accessible once the process has been completed.
|
||||
|
||||
|
||||
## Community
|
||||
|
||||
Keep track of Ghost development and Ghost community activity.
|
||||
|
||||
* Follow Ghost on [Twitter](http://twitter.com/TryGhost), [Facebook](https://www.facebook.com/ghost) and [Google+](https://plus.google.com/114465948129362706086).
|
||||
* Read and subscribe to the [Official Ghost Blog](http://blog.ghost.org) and the [Ghost Development Blog](http://dev.ghost.org).
|
||||
* Join in discussions on the [Ghost Forum](http://ghost.org/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.
|
||||
|
||||
|
||||
## Copyright & License
|
||||
# Copyright & License
|
||||
|
||||
Copyright (c) 2013-2015 Ghost Foundation - Released under the [MIT license](LICENSE).
|
||||
|
||||
Loading…
Reference in New Issue
Block a user