How to Run Gatsby on Cloudways?

11 minutes read

Running Gatsby on Cloudways is a straightforward process. Here are the steps you need to follow:

  1. Sign up for a Cloudways account and set up a server. Cloudways offers a variety of hosting options, so choose the one that suits your needs.
  2. Once your server is set up, access it via SSH. Cloudways provides you with the necessary credentials to connect to your server.
  3. Install Node.js on your Cloudways server. Gatsby is built with Node.js, so make sure it is installed. You can use the package manager of your choice, such as apt or yum, to install Node.js.
  4. Install Gatsby globally on your server using the npm package manager. Run the following command in your server's terminal: npm install -g gatsby-cli
  5. Navigate to the location where you want to create your Gatsby project. Once you are in the desired directory, use the Gatsby CLI to create a new Gatsby project. For example, you can run: gatsby new my-gatsby-project
  6. Change into the created project directory: cd my-gatsby-project
  7. Install the project dependencies by running: npm install
  8. Once the installation is complete, you can start the development server and run Gatsby locally using the following command: gatsby develop This will start the Gatsby development server, and you can access your Gatsby site by visiting the provided URL.
  9. To optimize and build your Gatsby site for production, use the following command: gatsby build This will generate a production-ready version of your site in the public directory.
  10. After building your Gatsby site, you can deploy it on Cloudways by uploading the contents of the public directory to your server. You can use various methods such as FTP, SFTP, or SSH to transfer the files.
  11. Finally, configure your server to serve the Gatsby site from the public directory. You can create an Apache or Nginx virtual host configuration file and specify the document root as the public directory.

That's it! Your Gatsby site should now be up and running on Cloudways.

Best Cloud Hosting Services of 2024


Rating is 5 out of 5



Rating is 5 out of 5



Rating is 4.9 out of 5



Rating is 4.9 out of 5


How to troubleshoot common issues when running Gatsby on Cloudways?

When running Gatsby on Cloudways, you may encounter several common issues. Here are some troubleshooting steps to resolve them:

  1. Verify the Node.js version: Ensure that the Node.js version installed on the server meets the minimum requirements specified by Gatsby. You can check the version by running node --version in your server's terminal. If the version is outdated, update it using the Cloudways platform or through SSH if you have access.
  2. Install required plugins: Check if all the required plugins specified in your Gatsby configuration are installed. Run npm list --depth=0 in your project directory to see the installed packages. If any packages are missing, install them using npm install package-name.
  3. Check file/folder permissions: Verify that the necessary files and folders have the appropriate permissions. Many issues can arise from incorrect file permissions. Make sure that your project directory has read, write, and execute permissions for the relevant user.
  4. Clear cache and rebuild: If you are experiencing unexpected behavior, it's often helpful to clear the cache and rebuild your Gatsby project. Run npm run clean to remove the cache and then rebuild the project with npm run build.
  5. Review error logs: Check the error logs in the Cloudways platform or by accessing the server through SSH. The error logs can provide valuable insights into the specific issue and point you in the right direction for further troubleshooting.
  6. Temporary directory issues: Verify that the temporary directory for Gatsby is correctly set up. Check the GATSBY_DIR environment variable in your server's configuration. It should point to a directory with write permissions and sufficient disk space.
  7. Review the Cloudways documentation: Cloudways provides comprehensive documentation on deploying various applications, including Gatsby. Review their documentation to see if there are any specific instructions or guidance available for troubleshooting Gatsby on their platform.

If the issue persists after trying these troubleshooting steps, consider reaching out to the Cloudways support team or the Gatsby community for further assistance.

What are the caching options available for Gatsby on Cloudways?

On Cloudways, there are a few caching options available for Gatsby:

  1. Varnish Cache: Cloudways provides built-in support for Varnish Cache, which is a powerful HTTP accelerator. Varnish Cache can significantly improve the performance of your Gatsby website by caching dynamic content and serving it quickly.
  2. Redis Cache: Redis is an in-memory data structure store that can be used as a cache. Cloudways offers Redis as a caching option, which can help speed up dynamic content and reduce database load.
  3. Memcached: Cloudways also supports Memcached, another popular in-memory caching system. Memcached can improve website performance by caching frequently accessed data and reducing the need for repeated database queries.

Note that caching options like Varnish Cache, Redis Cache, and Memcached are server-side caching solutions. They can be used to cache dynamic content and improve performance, but they may not have a direct impact on Gatsby's build time or static content caching. Gatsby has its own built-in caching mechanisms to optimize build and serve static content efficiently.

What are the disk space limitations when running Gatsby on Cloudways?

The disk space limitations when running Gatsby on Cloudways depend on the specific hosting plan you choose. Cloudways offers hosting plans with different storage space options ranging from 20GB to 3840GB (4TB). You can select a plan that suits your needs based on the amount of disk space required for your Gatsby project.

How to monitor the resource usage of a Gatsby site on Cloudways?

To monitor the resource usage of a Gatsby site on Cloudways, you can follow these steps:

  1. Log in to your Cloudways account.
  2. Select the desired application from the list of applications.
  3. Navigate to the "Monitoring" section from the left-hand side menu.
  4. On the Monitoring page, you will see various monitoring options such as CPU Usage, RAM Usage, Disk Usage, and Bandwidth Usage.
  5. By default, Cloudways provides a real-time overview of resource usage in the form of graphs. You can view resource usage for the last 24 hours, last 7 days, or last 30 days. You can also select a specific time range using the custom range option.
  6. To get detailed information about a specific metric, click on the respective graph or select the metric from the drop-down list above the graph.
  7. Cloudways also allows you to set up alerts based on resource thresholds. You can define specific values for CPU, RAM, Disk, or Bandwidth and receive alerts via email or other notification channels.
  8. Additionally, you can enable advanced monitoring options like New Relic or integrate external services like ElasticSearch,, etc., to have more in-depth insights into your Gatsby site's resource usage.

Following these steps will help you monitor the resource usage of your Gatsby site on Cloudways and stay informed about the performance and health of your application.

What are the backup options for a Gatsby site on Cloudways?

There are several backup options for a Gatsby site on Cloudways:

  1. Manual backup: Cloudways provides a manual backup feature that allows you to create a backup of your Gatsby site with just a few clicks. You can choose to create a full backup or a partial backup that includes only specific files or databases.
  2. Automated backup: Cloudways also offers automated backup options. You can configure a backup schedule to create regular backups of your Gatsby site automatically. The frequency and retention period of automated backups can be customized according to your needs.
  3. Offsite backups: Cloudways allows you to easily create offsite backups of your Gatsby site. You can select popular cloud storage providers like AWS S3, Google Cloud Storage, or DigitalOcean Spaces to store your backups. This ensures that your data is safe even if something happens to your server.
  4. One-click restore: In case of any data loss or issues, Cloudways provides a one-click restore feature. You can select a specific backup from the backup list and restore it quickly to your Gatsby site.
  5. Clone server: Cloudways allows you to clone your entire server, including the Gatsby site, databases, and settings. This is a useful backup option if you want to create a duplicate copy of your site for testing or development purposes.

Overall, Cloudways offers a range of backup options for your Gatsby site, providing flexibility and peace of mind when it comes to safeguarding your data.

How to manage Gatsby plugins and dependencies on Cloudways?

To manage Gatsby plugins and dependencies on Cloudways, you can follow these steps:

  1. Connect to your Cloudways server: Log in to your Cloudways account. From the Cloudways dashboard, navigate to the server where your Gatsby project is hosted. Click on the "Launch SSH Terminal" button to connect to your server via SSH.
  2. Navigate to your Gatsby project directory: Once connected to the server via SSH, navigate to the directory where your Gatsby project is located. For example: cd /path/to/your/gatsby/project
  3. Install/update dependencies: Use the package manager of your choice, either npm or yarn, to install or update the dependencies for your Gatsby project. For example, using npm: npm install Or using yarn: yarn install
  4. Add/modify Gatsby plugins: If you want to add a new Gatsby plugin to your project, you can do it by updating the gatsby-config.js file located in the root of your project. Add the plugin name to the plugins array in the configuration file. For example: module.exports = { siteMetadata: { //... }, plugins: [ //... "gatsby-plugin-example", ], }; If you want to modify the configuration of an existing Gatsby plugin, you can update the respective configuration file or modify the plugin options directly in the gatsby-config.js file.
  5. Build and deploy the Gatsby project: Once you have made the necessary changes to plugins and dependencies, you can build and deploy your Gatsby project to see the changes on your live site. Use the following command: npm run build Or with yarn: yarn build After the build process completes, the Gatsby project will generate a public directory that contains the optimized assets for your site.
  6. Serve the Gatsby site: To serve the Gatsby site on Cloudways, you can set up a web server (e.g., Apache or Nginx) to point to the public directory of your Gatsby project. Configure the web server by creating a new application or adding the project to an existing application in the Cloudways console, depending on your setup. Consult Cloudways documentation for detailed instructions specific to your web server configuration.

By following these steps, you can manage Gatsby plugins and dependencies on Cloudways and ensure your site is updated with the latest changes.

Twitter LinkedIn Telegram Whatsapp

Related Posts:

The tutorial "Deploy MODX on Cloudways" is a step-by-step guide that helps users to set up and launch a MODX website on the Cloudways platform. The tutorial emphasizes deploying MODX, a powerful content management system (CMS) to manage websites, and C...
Deploying Gatsby on SiteGround involves a series of steps to ensure that your Gatsby site is successfully deployed and accessible on the SiteGround hosting platform. Here is an overview of the process:Build Your Gatsby Site: Begin by developing your Gatsby sit...
To install WordPress on Cloudways, follow these steps:Sign up for an account on Cloudways website.Log in to your Cloudways account.Click on "Launch" to start a new server.Choose the desired cloud infrastructure provider (such as Amazon Web Services, Go...