Skip to main content

components/github/convex.config

For AI agents: see llms.txt for the complete documentation index. Markdown versions are available by adding .md to a page URL or requesting Accept: text/markdown.

Variables​

default​

const default: ComponentDefinition<any, {
  CLIENT_ID: VString<string, "required">;
  CLIENT_SECRET: VString<string, "required">;
}>;

The GitHub oauth component. Install it once, with the httpPrefix its callback is served under, and bind the OAuth app's credentials:

app.use(authGithub, {
  httpPrefix: "/oauth/github",
  env: {
    CLIENT_ID: app.env.AUTH_GITHUB_CLIENT_ID,
    CLIENT_SECRET: app.env.AUTH_GITHUB_CLIENT_SECRET,
  },
});