Working with a Local Git Repository
You can connect Decap CMS to a local Git repository, instead of working with a live repo.
- Navigate to a local Git repository configured with the CMS.
- Add the top-level property
local_backend
configuration to yourconfig.yml
:
# when using the default proxy server port
local_backend: true
backend:
name: git-gateway
Run
npx decap-server
from the root directory of the above repository.- If the default port (8081) is in use, the proxy server won’t start and you will see an error message. In this case, follow these steps before proceeding.
Start your local development server (e.g. run
gatsby develop
).Open
http://localhost:<port>/admin
to verify that your can administer your content locally. Replace<port>
with the port of your local development server. For example Gatsby’s default port is8000
Note: decap-server
runs an unauthenticated express server. As any client can send requests to the server, it should only be used for local development. Also note that editorial_workflow
is not supported in this environment.
Configure the Decap CMS proxy server port number
- Create a
.env
file in the project’s root folder and define the PORT you’d like the proxy server to use
PORT=8082
- Update the
local_backend
object inconfig.yml
and specify aurl
property to use your custom port number
backend:
name: git-gateway
local_backend:
# when using a custom proxy server port
url: http://localhost:8082/api/v1
# when accessing the local site from a host other than 'localhost' or '127.0.0.1'
allowed_hosts: ['192.168.0.1']