This integration automatically mounts the Decap CMS (or any compatible CMS like Sveltia) admin dashboard to /admin and custom OAuth authentication backend routes to /oauth, /oauth/callback using GitHub as the provider.

_This way, you aren't vendor-locked to Netlify and your app can be deployed anywhere that supports SSR._

Installation

``bash
npx astro add astro-decap-cms-oauth
`

Manual Installation

`bash
npm install astro-decap-cms-oauth
`

`js
import { defineConfig } from "astro/config";
import decapCmsOauth from "astro-decap-cms-oauth";

export default defineConfig({
...,
integrations: [decapCmsOauth()],
});
`

Usage

1. Put your config.yml file in public/admin/config.yml (see Decap CMS Docs for more info)

`yml
backend:
name: github
branch: main # change this to your branch
repo: dorukgezici/astro-decap-cms-oauth # change this to your repo
site_domain: astro-decap-cms-oauth.vercel.app # change this to your domain
base_url: https://astro-decap-cms-oauth.vercel.app # change this to your prod URL
auth_endpoint: oauth # the oauth route provided by the integration
`

2. Set up _GitHub OAuth app_ (recommended) or _GitHub App_

$3

On GitHub, go to Settings > Developer Settings > OAuth apps > New OAuth app. Or use this direct link.

Homepage URL: This must be the prod URL of your application.

Authorization callback URL: This must be the prod URL of your application followed by /oauth/callback.

$3

Register a new GitHub application on GitHub (details).

Select the scopes as content:write

Homepage URL: This must be the prod URL of your application.

Authorization callback URL: This must be the prod URL of your application followed by /oauth/callback.

Once registered, click on the Generate a new client secret button. The app’s Client ID and Client Secret will be displayed.

Then navigate to https://github.com/apps//installations/new to install it on the repo. You can scope the access tokens further if wanted - details on this page

`bash
curl -s 'https://api.github.com/repos//' | jq .id
`

You can then use this ID for the OAUTH_GITHUB_REPO_ID environment variable.

4. Set env variables

`bash


GitHub OAuth App & GitHub App

`js
export interface DecapCMSOptions {
decapCMSSrcUrl?: string;
decapCMSVersion?: string;
adminDisabled?: boolean;
adminRoute?: string;
oauthDisabled?: boolean;
oauthLoginRoute?: string;
oauthCallbackRoute?: string;
}

const defaultOptions: DecapCMSOptions = {
decapCMSSrcUrl: "",
decapCMSVersion: "3.3.3",
adminDisabled: false,
adminRoute: "/admin",
oauthDisabled: false,
oauthLoginRoute: "/oauth",
oauthCallbackRoute: "/oauth/callback",
};
`

To override default version of Decap CMS used, set PUBLIC_DECAP_CMS_VERSION env variable (takes precedence) or decapCMSVersion in astro.config.mjs.
To disable injecting Decap CMS admin route, set adminDisabled to true in astro.config.mjs.
To disable injecting OAuth routes, set oauthDisabled to true in astro.config.mjs.

`js
import { defineConfig } from "astro/config";
import decapCmsOauth from "astro-decap-cms-oauth";

export default defineConfig({
...,
integrations: [
decapCmsOauth({
decapCMSVersion: "3.3.3",
adminDisabled: false,
oauthDisabled: true,
}),
],
});
`

$3

To use Sveltia or any other Decap CMS compatible dashboard, set PUBLIC_DECAP_CMS_SRC_URL env variable (takes precedence) or decapCMSSrcUrl in astro.config.mjs. If set, PUBLIC_DECAP_CMS_VERSION / decapCMSVersion settings are ignored.

`js
import { defineConfig } from "astro/config";
import decapCmsOauth from "astro-decap-cms-oauth";

export default defineConfig({
...,
integrations: [
decapCmsOauth({
decapCMSSrcUrl: "https://unpkg.com/@sveltia/cms/dist/sveltia-cms.js",
}),
],
});
``