Registry / devops / netlify-cms-proxy-server

netlify-cms-proxy-server

library1.3.24jsnpmunverified

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.

devops web-framework

npm install netlify-cms-proxy-server

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · NETLIFY-CMS-PROXY-

netlify-cms-proxy-server

devopsjavascriptv1.3.24

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

netlify-cms-proxy-server

✓ npx netlify-cms-proxy-server

✗ import netlifyCmsProxyServer from 'netlify-cms-proxy-server'

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.

registerLocalFs

✓ const { registerLocalFs } = require('netlify-cms-proxy-server/dist/middlewares');

✗ import { registerLocalFs } from 'netlify-cms-proxy-server'

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.

middlewares

✓ const middlewares = require('netlify-cms-proxy-server/dist/middlewares');

✗ import * as middlewares from 'netlify-cms-proxy-server/dist/middlewares'

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`.

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`.

npx netlify-cms-proxy-server # In your config.yml: # backend: # name: proxy # proxy_url: http://localhost:8081/api/v1 # branch: master # optional, defaults to master # To customize port or repo directory via .env: # GIT_REPO_DIRECTORY=FULL_PATH_TO_LOCAL_GIT_REPO # PORT=CUSTOM_PORT # Example .env file: # PORT=8082 # GIT_REPO_DIRECTORY=/Users/username/my-git-repo

netlify-cms-proxy-server --version

Debug

Known issues

breakingThis 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`.

fix

Migrate to `decap-server` for local proxy functionality with Decap CMS. Uninstall `netlify-cms-proxy-server` and install `decap-server`.

affects: >=1.0.0

gotchaThe 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.

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`.

affects: >=1.0.0

gotchaThe `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.

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.

affects: <=1.3.24

gotchaThe `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.

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.

affects: >=1.0.0

Errors

Common errors & fixes

POST http://localhost:8081/api/v1 422 (Unprocessable Entity)

The proxy server failed to process a request, often due to a misconfiguration in `config.yml` or issues with the local Git repository access.

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.

Address already in use :::8081

The default port 8081, or a custom port configured in `.env`, is already in use by another application.

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.

Cannot find module 'netlify-cms-proxy-server'

The package is not installed globally or locally, or `npx` cannot locate it in the current environment.

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`.

Upgrade

Version history

1.3.24latest on npm

Audit

Dependencies

expressrequiredCore framework for the proxy server, as it is an 'express server'.

git-utilsrequiredImplied dependency for interacting with local Git repositories, although specific package name is not provided in metadata.

Agent activity

4 hits · last 30 days

node

Resources

githubhttps://github.com/netlify/netlify-cms.git#master ↗

packagehttps://www.npmjs.com/package/netlify-cms-proxy-server ↗

homepagehttps://decapcms.org ↗