TryGhost/Ghost
1
0
Fork 0
mirror of https://github.com/TryGhost/Ghost.git synced 2024-12-15 03:12:54 +03:00
Code Issues Projects Releases Wiki Activity
Turn your audience into a business. Publishing, memberships, subscriptions and newsletters.
4,571 Commits 253 Branches 1,686 Tags 364 MiB
JavaScript 71.4%
TypeScript 15.2%
CSS 6.4%
Handlebars 5.7%
HTML 1.1%
Other 0.1%
0484eee6a5
Go to file
Felix Rieseberg 0484eee6a5 Replace fs.exists (deprecated) with fs.stat 
Closes #4847

- Replaces the deprecated fs.exists() with fs.stat(), in accordance with iojs & node.
2015-03-17 11:49:43 -07:00
content Upgrading Casper to 1.1.7 2015-03-09 18:01:45 +00:00
core Replace fs.exists (deprecated) with fs.stat 2015-03-17 11:49:43 -07:00
.bowerrc Adding .bowerrc 2014-04-03 09:43:47 +01:00
.gitignore Implement popovers 2014-10-20 22:09:45 +01:00
.gitmodules in some cases the git protocol cannot be processed (port blocking or other reasons) with https it should work for everyone 2014-04-04 18:21:39 +02:00
.jscsrc Remove ObjectController proxying behavior. 2015-01-01 21:51:20 -05:00
.jshintrc Remove jshint rules that are no longer supported 2015-01-23 21:00:37 +00:00
.npmignore Adding Grunt tasks for Sass 2014-08-31 14:16:58 +01:00
.travis.yml Node v0.12 & io.js support. 2015-03-09 20:27:14 +01:00
bower.json Drag & Drop Navigation Reordering 2015-02-12 17:02:46 +00:00
config.example.js adding config flags to control all items mentioned in PRIVACY.md 2014-09-13 12:04:01 -04:00
CONTRIBUTING.md README & CONTRIBUTING updates 2015-03-09 20:54:00 +00:00
Gruntfile.js No more source maps in grunt prod 2015-03-09 17:38:08 +00:00
index.js Add checks for packages and contentPath to startup 2014-09-22 21:27:34 +00:00
LICENSE Update copyright 2015-01-02 16:11:13 +02:00
package.json Version bump to 0.5.10 2015-03-09 20:56:46 +00:00
PRIVACY.md Adds twitter cards and schema.org to {{ghost_head}} 2014-10-17 17:26:14 +02:00
README.md README & CONTRIBUTING updates 2015-03-09 20:54:00 +00:00
SECURITY.md Use less markup for links 2013-10-22 21:22:35 +01:00

README.md

Ghost Build Status

Ghost Screenshot

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://support.ghost.org.

Getting Involved

Want to report a bug, request a feature, contribute, 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 a few different ways to install Ghost, take care to use the method which best suits your needs.

Please note - the downloadable zip files we provide on Ghost.org, the GitHub releases page, 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.

Compatibility

Ghost is fully compatible with Node v0.10.x, 0.10.36 is the recommended version of Node for running Ghost in production.

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 for help with install issues.

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.

Install from zip (fastest & best 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 on various platforms, visit the Ghost Installation Guide. If you get stuck, help is available on our support site.

  1. Install Node.js - See compatibility section for details of supported versions
  2. Download the latest Ghost package from Ghost.org.
  3. Create a new directory where you would like to run the code, and un-zip the package to that location.
  4. 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)
  5. 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.
  6. To start ghost, run npm start
  7. 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.

Install from git

If you're a 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 using grunt.

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 or the stable branch which contains the latest release.

Full instructions & troubleshooting tips can be found in the Contributing Guide.

Quickstart:

  1. Install node (see compatibility section for details of supported versions)
  2. npm install -g grunt-cli
  3. npm install
  4. grunt init (and grunt prod if you want to run Ghost in production mode)
  5. npm start

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

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 wiki entry.

Keeping up-to-date

Upgrade instructions can be found on the Ghost Support Site.

New releases are announced on the dev blog, 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 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.

Copyright & License

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