Overview
Running Ghost locally is the easiest way to get your own copy of the software running and be able to do some local development with it. By the end of this guide you will have completed a local Ghost install that runs in development mode using SQLite3. This install is not suitable for production use or contributing to core.Prerequisites
To install Ghost locally you will need the following:- A computer running MacOS, Windows or Linux
- A supported version of Node.js
- Either yarn or npm to manage packages
- Python 3 and setuptools for building SQLite3
- A clean, empty directory on your machine
Install Ghost-CLI
Ghost-CLI is a commandline tool to help you get Ghost installed and configured for use, quickly and easily. The npm module can be installed withnpm
or yarn
on a local machine, depending on your preference.
ghost help
to see a list of available commands.
Install Ghost
In your terminal,cd
into an empty directory and run the install command:
http://localhost:2368
and http://localhost:2368/ghost
to access Ghost Admin ✨
That’s it! You’re done.
- Your publication is setup in
development
mode with less caching - The SQLite3 database is auto-setup and located in
/content/data/
- Logs only go to
stdout
Starting & Stopping
Ghost runs in a separate background process and remains running until you stop it or restart your computer. So you may find these commands useful for taming it:ghost stop
to stop Ghostghost start
to start Ghostghost log
views logsghost ls
to list all running Ghost blogs
ghost help
for a list of available commands, or explore the full Ghost-CLI documentation.
Troubleshooting
For troubleshooting and errors, try searching this documentation and FAQ section to find information about common error messages.Developing Themes
To work on a Ghost Handlebars Theme locally, your custom theme should always be placed in the top-level/content/themes/
directory.