{"id":13595,"library":"netlify-cms-proxy-server","title":"Netlify CMS Proxy Server","description":"The `netlify-cms-proxy-server` is an Express-based proxy server designed to facilitate local development for Netlify CMS, which has since been rebranded as Decap CMS. It allows content editors to interact with a local Git repository via the CMS interface running on `localhost`, eliminating the need for a live Git backend during local development. The package's current version is 1.3.24, and it was last published approximately four years ago. Following the rebranding of Netlify CMS to Decap CMS in February 2023, this package has been superseded by `decap-server`, which provides equivalent functionality and is actively maintained. Users are strongly advised to migrate to `decap-server` for current features, support, and security updates, as `netlify-cms-proxy-server` is considered deprecated.","status":"deprecated","version":"1.3.24","language":"javascript","source_language":"en","source_url":"https://github.com/netlify/netlify-cms#master","tags":["javascript","netlify","netlify-cms","backend"],"install":[{"cmd":"npm install netlify-cms-proxy-server","lang":"bash","label":"npm"},{"cmd":"yarn add netlify-cms-proxy-server","lang":"bash","label":"yarn"},{"cmd":"pnpm add netlify-cms-proxy-server","lang":"bash","label":"pnpm"}],"dependencies":[{"reason":"Core framework for the proxy server, as it is an 'express server'.","package":"express"},{"reason":"Implied dependency for interacting with local Git repositories, although specific package name is not provided in metadata.","package":"git-utils"}],"imports":[{"note":"The primary way to use this package is via the `npx` command-line tool. It is not designed for direct programmatic import in most userland applications. For new projects, use `npx decap-server` instead.","wrong":"import netlifyCmsProxyServer from 'netlify-cms-proxy-server'","symbol":"netlify-cms-proxy-server","correct":"npx netlify-cms-proxy-server"},{"note":"This import pattern was historically used for programmatic setup (e.g., in a `setupProxy.js` for React apps) and is CommonJS-specific. This method is deprecated with the package itself; use `decap-server`'s equivalent for Decap CMS.","wrong":"import { registerLocalFs } from 'netlify-cms-proxy-server'","symbol":"registerLocalFs","correct":"const { registerLocalFs } = require('netlify-cms-proxy-server/dist/middlewares');"},{"note":"Accessing the middlewares directly is a CommonJS pattern. This module structure and the package itself are deprecated. Modern Decap CMS local development should use `decap-server`.","wrong":"import * as middlewares from 'netlify-cms-proxy-server/dist/middlewares'","symbol":"middlewares","correct":"const middlewares = require('netlify-cms-proxy-server/dist/middlewares');"}],"quickstart":{"code":"npx netlify-cms-proxy-server\n# In your config.yml:\n# backend:\n#   name: proxy\n#   proxy_url: http://localhost:8081/api/v1\n#   branch: master # optional, defaults to master\n\n# To customize port or repo directory via .env:\n# GIT_REPO_DIRECTORY=FULL_PATH_TO_LOCAL_GIT_REPO\n# PORT=CUSTOM_PORT\n\n# Example .env file:\n# PORT=8082\n# GIT_REPO_DIRECTORY=/Users/username/my-git-repo","lang":"bash","description":"Demonstrates how to start the proxy server using npx and configure your `config.yml` for local development. It also shows how to customize the port and repository directory via a `.env` file for the now-deprecated Netlify CMS Proxy Server. For current Decap CMS usage, substitute `netlify-cms-proxy-server` with `decap-server`."},"warnings":[{"fix":"Migrate to `decap-server` for local proxy functionality with Decap CMS. Uninstall `netlify-cms-proxy-server` and install `decap-server`.","message":"This package, `netlify-cms-proxy-server`, is deprecated. Netlify CMS was rebranded to Decap CMS in February 2023, and this proxy server has been superseded by `decap-server`.","severity":"breaking","affected_versions":">=1.0.0"},{"fix":"Never expose `netlify-cms-proxy-server` or `decap-server` to public networks or use it in production. Ensure it only listens on `localhost` or `127.0.0.1`.","message":"The proxy server runs an unauthenticated Express server, meaning any client on `localhost` can send requests. It is designed and safe only for local development environments.","severity":"gotcha","affected_versions":">=1.0.0"},{"fix":"Always use a recent LTS version of Node.js (e.g., Node.js 18 or 20) to ensure compatibility across all Decap CMS components.","message":"The `engines.node` specifies `>=v10.22.1`. While this package might technically run on older Node.js versions, the broader Decap CMS ecosystem may require much newer Node.js versions for compatibility with other components.","severity":"gotcha","affected_versions":"<=1.3.24"},{"fix":"Explicitly set `branch: main` (or your repository's default branch) in your `config.yml` under the `backend` section when using a non-standard default branch name.","message":"The `branch` configuration in `config.yml` is optional and defaults to 'master'. If your repository uses a different default branch name (e.g., 'main'), the proxy server might not find the correct branch unless explicitly configured.","severity":"gotcha","affected_versions":">=1.0.0"}],"env_vars":null,"search_vec":"'1.3.24':69 '2023':90 'activ':106 'advis':111 'ago':78 'allow':35 'approxim':75 'backend':59,139 'base':15 'cms':2,8,25,33,47,84,87,128,138 'consid':132 'content':36 'current':66,119 'decap':32,86,98,116 'decap-serv':97,115 'deprec':133 'design':18 'develop':22,62 'editor':37 'elimin':52 'equival':102 'express':14 'express-bas':13 'facilit':20 'featur':120 'februari':89 'follow':79 'four':76 'function':103 'git':43,58 'interact':39 'interfac':48 'javascript':134 'last':73 'live':57 'local':21,42,61 'localhost':51 'maintain':107 'migrat':113 'need':54 'netlifi':1,7,24,83,127,135,137 'netlify-cm':136 'netlify-cms-proxy-serv':6,126 'packag':64,92 'provid':101 'proxi':3,9,16,129 'publish':74 'rebrand':30,81 'repositori':44 'run':49 'secur':123 'server':4,10,17,99,117,130 'sinc':28 'strong':110 'supersed':95 'support':121 'updat':124 'user':108 'version':67 'via':45 'year':77","created_at":"2026-04-20T01:55:18.497635+00:00","updated_at":"2026-04-20T01:55:18.497635+00:00","problems":[{"fix":"Verify that your `config.yml` settings (especially `proxy_url` and `branch`) are correct. Ensure the `npx netlify-cms-proxy-server` command is run from the root of a valid local Git repository and that the repository is correctly initialized.","cause":"The proxy server failed to process a request, often due to a misconfiguration in `config.yml` or issues with the local Git repository access.","error":"POST http://localhost:8081/api/v1 422 (Unprocessable Entity)"},{"fix":"Stop the conflicting application or configure a different port for the proxy server by creating a `.env` file in your repository root with `PORT=YOUR_CUSTOM_PORT` (e.g., `PORT=8082`). Update your `config.yml` `proxy_url` to match the new port.","cause":"The default port 8081, or a custom port configured in `.env`, is already in use by another application.","error":"Address already in use :::8081"},{"fix":"Ensure the package is available. If using `npx`, it will try to download it. If running from `package.json` scripts, ensure `netlify-cms-proxy-server` is listed in your `devDependencies` and installed via `npm install` or `yarn install`.","cause":"The package is not installed globally or locally, or `npx` cannot locate it in the current environment.","error":"Cannot find module 'netlify-cms-proxy-server'"}],"ecosystem":"npm","meta_description":null,"install_score":null,"quickstart_score":null,"quickstart_tag":null,"pypi_latest":null,"cli_name":"netlify-cms-proxy-server","cli_version":null,"type":"library","homepage":"https://decapcms.org","github":"https://github.com/netlify/netlify-cms.git#master","docs":null,"changelog":null,"pypi":null,"npm":"https://www.npmjs.com/package/netlify-cms-proxy-server","openapi_spec":null,"status_page":null,"smithery":null,"categories":["devops","web-framework"],"base_url":null,"auth_type":null,"provenance":{"verified_status":null,"verified_at":null,"last_verified":"2026-06-17","next_check":"2026-07-18","install_tag":null}}