Skip to content

README.md

Latest commit

 

History

History
29 lines (19 loc) · 847 Bytes

README.md

File metadata and controls

29 lines (19 loc) · 847 Bytes
Raw

@studiocms/github Plugin

codecov

This plugin integrates GitHub as an OAuth authentication provider for StudioCMS. It sets up the necessary authentication service, including the provider's name, endpoint paths and required environment variables.

Usage

Add this plugin in your StudioCMS config. (studiocms.config.mjs)

import { defineStudioCMSConfig } from 'studiocms/config';
import github from '@studiocms/github';

export default defineStudioCMSConfig({
    // other options here
    plugins: [github()]
});

Required ENV Variables

  • CMS_GITHUB_CLIENT_ID
  • CMS_GITHUB_CLIENT_SECRET
  • CMS_GITHUB_REDIRECT_URI

License

MIT Licensed.