Recipes: Deploying Your Site

Showtime. Once you are happy with your site, you are ready to go live with it!

Preparing for deployment

Prerequisites

• A Gatsby site
• The Gatsby CLI installed

Directions

1. Stop your development server if it is running (Ctrl + C on your command line in most cases)

2. For the standard site path at the root directory (/), run gatsby build using the Gatsby CLI on the command line. The built files will now be in the public folder.

3. To include a site path other than / (such as /site-name/), set a path prefix by adding the following to your gatsby-config.js and replacing yourpathprefix with your desired path prefix:

There are a few reasons to do this — for instance, hosting a blog built with Gatsby on a domain with another site not built on Gatsby. The main site would direct to example.com, and the Gatsby site with a path prefix could live at example.com/blog.

4. With a path prefix set in gatsby-config.js, run gatsby build with the --prefix-paths flag to automatically add the prefix to the beginning of all Gatsby site URLs and <Link> tags.

5. Make sure that your site looks the same when running gatsby build as with gatsby develop. By running gatsby serve when you build your site, you can test out (and debug if necessary) the finished product before deploying it live.

Additional resources

• Walk through building and deploying an example site in tutorial part one
• Learn about performance optimization
• Read about other deployment related topics
• Check out the deployment docs for specific hosting platforms and how to deploy to them

Deploying to Netlify

Use netlify-cli to deploy your Gatsby application without leaving the command-line interface.

Prerequisites

• A Gatsby site with a single component index.js
• The netlify-cli package installed
• The Gatsby CLI installed

Directions

1. Build your gatsby application using gatsby build

2. Login into Netlify using netlify login

3. Run the command netlify init. Select the “Create & configure a new site” option.

4. Choose a custom website name if you want or press enter to receive a random one.

5. Choose your Team.

6. Change the deploy path to public/

7. Make sure that everything looks fine before deploying to production using netlify deploy -d . --prod

Additional resources

• Hosting on Netlify
• gatsby-plugin-netlify

Deploying to ZEIT Now

Use Now CLI to deploy your Gatsby application without leaving the command-line interface.

Prerequisites

• A ZEIT Now account
• A Gatsby site with a single component index.js
• Now CLI package installed
• Gatsby CLI installed

Directions

1. Login into Now CLI using now login

2. Change to the directory of your Gatsby.js application in the Terminal if you aren’t already there

3. Run now to deploy it

Additional resources

• Deploying to ZEIT Now