This guide will help you to install and setup a production ready Bigcapital.
Self Host Setup
Learn how to self-host Bigcapital for controlled instance
API
Discover the Bigcapital’s API to interact with the core system.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Bigcapital Docs","colors":{"primary":"#76A1FF","light":"#76A1FF","dark":"#000"},"logo":{"light":"https://mintcdn.com/bigcapital/WVY5ORu6xzXKmdxI/logo/light.svg?fit=max\u0026auto=format\u0026n=WVY5ORu6xzXKmdxI\u0026q=85\u0026s=bb81eb8e5af2fb5e066a47522688beb8","dark":"https://mintcdn.com/bigcapital/8aPCQyR4cPWP5gfj/logo/dark.svg?fit=max\u0026auto=format\u0026n=8aPCQyR4cPWP5gfj\u0026q=85\u0026s=78d9ccccea4e56cf20fd75142036be5d"},"favicon":"/favicon.png","appearance":{"default":"dark"},"navbar":{"links":[{"href":"mailto:[email protected]","label":"Support"}],"primary":{"type":"button","label":"Github","href":"https://github.com/bigcapitalhq/bigcapital"}},"footer":{"socials":{"x":"https://x.com/bigcapitalhq","github":"https://github.com/bigcapitalhq/bigcapital"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Community","icon":"discord","href":"https://discord.com/invite/c8nPBJafeb"},{"anchor":"Blog","icon":"newspaper","href":"https://bigcapital.app/blog"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"bigcapital","hasAudioNarration":false,"actualSubdomain":"bigcapital","customDomains":["docs.bigcapital.app"],"gitSource":{"type":"github","owner":"bigcapitalhq","repo":"docs-v2","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a2201485cac5fa6292a51fe","collectionId":"367f51da-8d9c-420d-8dcb-198f7bf4470b","schemaVersion":"v2"},"entitlements":{},"buildId":"6a2201485cac5fa6292a51fe:success","clientVersion":"0.0.3869","searchFilterCounts":[{"language":"default","tag":"API Reference","count":702},{"language":"default","tag":"Reports","count":18},{"language":"default","tag":"Sale Invoices","count":17},{"language":"default","tag":"Sale Estimates","count":15},{"language":"default","tag":"Items","count":13},{"language":"default","tag":"Payments Received","count":12},{"language":"default","tag":"Guides","count":11},{"language":"default","tag":"Accounts","count":11},{"language":"default","tag":"Sale Receipts","count":11},{"language":"default","tag":"Bills","count":10}]},"assistantConfig":{},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".nav-logo{width:140px}"}],"page":{"pagePath":"index","slug":"/","pageMetadata":{"title":"Introduction","description":"Welcome to the Bigcapital documentation","href":"/index","hidden":false},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Welcome to the Bigcapital documentation\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={p:`p`,..._provideComponents(),...props.components},{Card,CardGroup}=_components;if(!Card)_missingMdxReference(`Card`,true);if(!CardGroup)_missingMdxReference(`CardGroup`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`This guide will help you to install and setup a production ready Bigcapital.`}),`\n`,_jsxs(CardGroup,{cols:2,children:[_jsx(Card,{title:`Self Host Setup`,icon:`pen-to-square`,href:`/deployment/docker`,children:_jsx(_components.p,{children:`Learn how to self-host Bigcapital for controlled instance`})}),_jsx(Card,{title:`API`,icon:`image`,href:`/api-reference`,children:_jsx(_components.p,{children:`Discover the Bigcapital’s API to interact with the core system.`})})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Introduction","description":"Welcome to the Bigcapital documentation","href":"/index","hidden":false}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"subdomain":"bigcapital","siteName":"Bigcapital Docs","title":"Introduction - Bigcapital Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2025-11-30T21:03:35.163Z","originalFileLocation":"index.mdx"},"headHtml":"\u003cmeta data-mint-head name=\"description\" content=\"Welcome to the Bigcapital documentation\">\u003cmeta data-mint-head name=\"application-name\" content=\"Bigcapital Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/bigcapital/mM0OGJJEhXNBXmeE/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/bigcapital/mM0OGJJEhXNBXmeE/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/bigcapital/mM0OGJJEhXNBXmeE/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/bigcapital/mM0OGJJEhXNBXmeE/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/bigcapital/mM0OGJJEhXNBXmeE/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/bigcapital/mM0OGJJEhXNBXmeE/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/bigcapital/mM0OGJJEhXNBXmeE/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/bigcapital/mM0OGJJEhXNBXmeE/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/bigcapital/mM0OGJJEhXNBXmeE/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Introduction - Bigcapital Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Welcome to the Bigcapital documentation\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Bigcapital Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.bigcapital.app\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Introduction - Bigcapital Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Welcome to the Bigcapital documentation\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/bigcapital/mM0OGJJEhXNBXmeE/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Bigcapital Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#76A1FF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.bigcapital.app\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/index.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.bigcapital.app/#organization\",\"name\":\"Bigcapital Docs\",\"url\":\"https://docs.bigcapital.app\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/bigcapital/WVY5ORu6xzXKmdxI/logo/light.svg?fit=max\u0026auto=format\u0026n=WVY5ORu6xzXKmdxI\u0026q=85\u0026s=bb81eb8e5af2fb5e066a47522688beb8\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.bigcapital.app#website\",\"name\":\"Bigcapital Docs\",\"url\":\"https://docs.bigcapital.app\",\"publisher\":{\"@id\":\"https://docs.bigcapital.app/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.bigcapital.app/#webpage\",\"url\":\"https://docs.bigcapital.app/\",\"name\":\"Introduction\",\"description\":\"Welcome to the Bigcapital documentation\",\"dateModified\":\"2025-11-30T21:03:35.163Z\",\"isPartOf\":{\"@id\":\"https://docs.bigcapital.app#website\"},\"breadcrumb\":{\"@id\":\"https://docs.bigcapital.app/#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.bigcapital.app/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Get Started\",\"item\":\"https://docs.bigcapital.app/index\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Introduction\",\"item\":\"https://docs.bigcapital.app/\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.bigcapital.app/#article\",\"headline\":\"Introduction\",\"name\":\"Introduction\",\"description\":\"Welcome to the Bigcapital documentation\",\"url\":\"https://docs.bigcapital.app/\",\"mainEntityOfPage\":{\"@id\":\"https://docs.bigcapital.app/#webpage\"},\"dateModified\":\"2025-11-30T21:03:35.163Z\",\"publisher\":{\"@id\":\"https://docs.bigcapital.app/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.bigcapital.app#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Bigcapital Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Bigcapital Docs","nav":{"global":{"anchors":[{"anchor":"Community","icon":"discord","href":"https://discord.com/invite/c8nPBJafeb"},{"anchor":"Blog","icon":"newspaper","href":"https://bigcapital.app/blog"}]},"tabs":[{"tab":"Guides","groups":[{"group":"Get Started","pages":[{"title":"Introduction","description":"Welcome to the Bigcapital documentation","href":""},{"title":"Quickstart","description":"Start building awesome documentation in under 5 minutes","href":"/quickstart"},{"title":"Development","description":"Thank you for considering contributing to our project! We appreciate your interest and welcome any contributions you may have. ","href":"/development"},{"title":"Architecture","description":null,"href":"/architecture"}]},{"group":"Deployments","pages":[{"title":"System Recommendations","description":"This page includes information about the minimum requirements you need to install and use self-managed Bigcapital.","href":"/deployment/recommendation"},{"title":"Setup Script","description":"Deploy Bigcapital quickly using the automated setup script","href":"/deployment/setup-script"},{"title":"Docker","description":"This page includes information about the minimum requirements you need to install and use self-managed Bigcapital.","href":"/deployment/docker"},{"title":"Environment Variables","description":null,"href":"/deployment/env_vars"},{"title":"Signup Restriction","description":"This document describes ways to restrict users from signing up on your self-hosted Bigcapital instance. This configuration is done by editing envirement variables of the instance. ","href":"/deployment/signup_restriction"},{"title":"Plaid Setup","description":"This guide will walk you through configuring Plaid for your self-managed Bigcapital instance. You will learn how to obtain your Plaid credentials, set up the required environment variables, and configure webhooks. ","href":"/deployment/plaid_setup"},{"title":"Troubleshooting","description":null,"href":"/deployment/troubleshooting"}]}]},{"tab":"API Reference","pages":[{"title":"API Reference","href":"/api-reference/introduction"}]}]},"title":"Introduction - Bigcapital Docs","buildId":"dpl_DMQXxPZd444kjahHSuSB7FkJbKrX","deploymentId":"dpl_DMQXxPZd444kjahHSuSB7FkJbKrX","dynamics":[],"chunks":[]}