{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"Omnicron Docs","colors":{"primary":"#2563eb","light":"#2563eb","dark":"#2563eb"},"favicon":"/favicon.png","logo":null,"api":{"mdx":{"server":"http://localhost:9000/api","auth":{"method":"bearer","name":"Authorization"}}},"background":{"decoration":null,"color":{"light":"#f0f0f0","dark":"#0B0E13"}},"navbar":{"links":[{"label":"Discord","href":"https://discord.com/channels/1265810179602120868/1265810180663152742"}],"primary":{"type":"github","href":"https://github.com/kingmariano/omnicron"}},"footer":{"socials":{"x":"https://x.com/charlesozochuk1","github":"https://github.com/kingmariano/","linkedin":"https://www.linkedin.com/in/charles-ozochukwu-8bb4701b4/"}},"navigation":{"global":{"anchors":[{"anchor":"Github","href":"https://github.com/kingmariano/omnicron","icon":"github"},{"anchor":"Issues","href":"https://github.com/kingmariano/omnicron/issues","icon":"envelope"},{"anchor":"Join our Community","href":"https://discord.com/channels/1265810179602120868/1265810180663152742","icon":"discord"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"omnicron","hasAudioNarration":false,"actualSubdomain":"omnicron","customDomains":[],"gitSource":{"type":"github","owner":"kingmariano","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"feedback":{"thumbs":true,"edits":true,"issues":true},"entitlements":{},"buildId":"6ae9214564faca65e1de50a3:success","clientVersion":"0.0.4248","searchFilterCounts":[{"language":"default","tag":"API Reference","count":30},{"language":"default","tag":"Endpoint Examples","count":29},{"language":"default","tag":"Documentation","count":16},{"language":"default","tag":"Features","count":13},{"language":"default","tag":"Image Generation","count":6},{"language":"default","tag":"Text To Speech","count":4},{"language":"default","tag":"Image Upscale","count":3},{"language":"default","tag":"Music Generation","count":3},{"language":"default","tag":"Speech To Text","count":3},{"language":"default","tag":"Get Started","count":3}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[],"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"get-started/quick-start/requirements","slug":"/get-started/quick-start/requirements","pageMetadata":{"title":"Requirements","description":"Ensure you have the necessary tools and dependencies to set up Omnicron.","href":"/get-started/quick-start/requirements"},"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: \"Ensure you have the necessary tools and dependencies to set up Omnicron.\"\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={a:`a`,li:`li`,p:`p`,ul:`ul`,..._provideComponents(),...props.components},{Heading}=_components;if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`To get started with Omnicron, make sure your system meets the following requirements:`}),`\n`,_jsx(Heading,{level:`3`,id:`go-1-20+`,children:`Go 1.20+`}),`\n`,_jsx(_components.p,{children:`Ensure you have Go 1.20 or higher installed.`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`https://golang.org/doc/install`,children:`Install Go`})}),`\n`]}),`\n`,_jsx(Heading,{level:`3`,id:`python-3-8-or-higher`,children:`Python 3.8 or Higher`}),`\n`,_jsx(_components.p,{children:`Make sure you have Python 3.8 or higher.`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`https://www.python.org/downloads/`,children:`Install Python`})}),`\n`]}),`\n`,_jsx(Heading,{level:`3`,id:`git`,children:`Git`}),`\n`,_jsx(_components.p,{children:`Git is essential for managing the source code and version control.`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`https://git-scm.com/book/en/v2/Getting-Started-Installing-Git`,children:`Install Git`})}),`\n`]}),`\n`,_jsx(Heading,{level:`3`,id:`docker-and-docker-compose`,children:`Docker and Docker-compose`}),`\n`,_jsx(_components.p,{children:`Docker and Docker-compose are necessary for containerizing Omnicron and its dependencies.`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`https://docs.docker.com/get-docker/`,children:`Install Docker`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`https://docs.docker.com/compose/install/`,children:`Install Docker-compose`})}),`\n`]}),`\n`,_jsx(Heading,{level:`3`,id:`tesseract-ocr`,children:`Tesseract-ocr`}),`\n`,_jsx(_components.p,{children:`Tesseract-ocr is used for optical character recognition in image processing.`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`https://github.com/tesseract-ocr/tesseract#installing-tesseract`,children:`Install Tesseract-ocr`})}),`\n`]}),`\n`,_jsx(Heading,{level:`3`,id:`ffmpeg`,children:`ffmpeg`}),`\n`,_jsx(_components.p,{children:`ffmpeg is a multimedia framework used for handling video, audio, and other multimedia files.`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`https://ffmpeg.org/download.html`,children:`Install ffmpeg`})}),`\n`]}),`\n`,_jsx(_components.p,{children:`Make sure you have these tools and dependencies installed to ensure a smooth setup and operation of Omnicron.`})]})}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":"Requirements","description":"Ensure you have the necessary tools and dependencies to set up Omnicron.","href":"/get-started/quick-start/requirements"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Go 1.20+","slug":"go-1-20+","depth":3,"children":[]},{"title":"Python 3.8 or Higher","slug":"python-3-8-or-higher","depth":3,"children":[]},{"title":"Git","slug":"git","depth":3,"children":[]},{"title":"Docker and Docker-compose","slug":"docker-and-docker-compose","depth":3,"children":[]},{"title":"Tesseract-ocr","slug":"tesseract-ocr","depth":3,"children":[]},{"title":"ffmpeg","slug":"ffmpeg","depth":3,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"omnicron","siteName":"Omnicron Docs","title":"Requirements - Omnicron Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-07T02:48:28.417Z","originalFileLocation":"get-started/quick-start/requirements.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Ensure you have the necessary tools and dependencies to set up Omnicron.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Omnicron 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/omnicron/UzLbdTxqWWB17_rd/_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/omnicron/UzLbdTxqWWB17_rd/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/omnicron/UzLbdTxqWWB17_rd/_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/omnicron/UzLbdTxqWWB17_rd/_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/omnicron/UzLbdTxqWWB17_rd/_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/omnicron/UzLbdTxqWWB17_rd/_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/omnicron/UzLbdTxqWWB17_rd/_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/omnicron/UzLbdTxqWWB17_rd/_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/omnicron/UzLbdTxqWWB17_rd/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Requirements - Omnicron Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Ensure you have the necessary tools and dependencies to set up Omnicron.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Omnicron Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://omnicron.mintlify.app/get-started/quick-start/requirements\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://omnicron.mintlify.site/_mintlify/api/og/v2?division=Quick+Start\u0026amp;title=Requirements\u0026amp;description=Ensure+you+have+the+necessary+tools+and+dependencies+to+set+up+Omnicron.\u0026amp;theme=aa1d3c7c23f7c4456555427f\u0026amp;signature=78d1a6bed42b28ad18cffde9d8dd3905566f314737dc8450ca34a956fdd9a750\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Requirements - Omnicron Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Ensure you have the necessary tools and dependencies to set up Omnicron.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://omnicron.mintlify.site/_mintlify/api/og/v2?division=Quick+Start\u0026amp;title=Requirements\u0026amp;description=Ensure+you+have+the+necessary+tools+and+dependencies+to+set+up+Omnicron.\u0026amp;theme=aa1d3c7c23f7c4456555427f\u0026amp;signature=78d1a6bed42b28ad18cffde9d8dd3905566f314737dc8450ca34a956fdd9a750\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/omnicron/UzLbdTxqWWB17_rd/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Omnicron Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2563eb\">\u003clink data-mint-head rel=\"canonical\" href=\"https://omnicron.mintlify.app/get-started/quick-start/requirements\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/get-started/quick-start/requirements.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://omnicron.mintlify.app/#organization\",\"name\":\"Omnicron Docs\",\"url\":\"https://omnicron.mintlify.app\"},{\"@type\":\"WebSite\",\"@id\":\"https://omnicron.mintlify.app#website\",\"name\":\"Omnicron Docs\",\"url\":\"https://omnicron.mintlify.app\",\"publisher\":{\"@id\":\"https://omnicron.mintlify.app/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://omnicron.mintlify.app/get-started/quick-start/requirements#webpage\",\"url\":\"https://omnicron.mintlify.app/get-started/quick-start/requirements\",\"name\":\"Requirements\",\"description\":\"Ensure you have the necessary tools and dependencies to set up Omnicron.\",\"dateModified\":\"2026-01-07T02:48:28.417Z\",\"isPartOf\":{\"@id\":\"https://omnicron.mintlify.app#website\"},\"breadcrumb\":{\"@id\":\"https://omnicron.mintlify.app/get-started/quick-start/requirements#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://omnicron.mintlify.app/get-started/quick-start/requirements#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Get Started\",\"item\":\"https://omnicron.mintlify.app/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Requirements\",\"item\":\"https://omnicron.mintlify.app/get-started/quick-start/requirements\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://omnicron.mintlify.app/get-started/quick-start/requirements#article\",\"headline\":\"Requirements\",\"name\":\"Requirements\",\"description\":\"Ensure you have the necessary tools and dependencies to set up Omnicron.\",\"url\":\"https://omnicron.mintlify.app/get-started/quick-start/requirements\",\"mainEntityOfPage\":{\"@id\":\"https://omnicron.mintlify.app/get-started/quick-start/requirements#webpage\"},\"dateModified\":\"2026-01-07T02:48:28.417Z\",\"publisher\":{\"@id\":\"https://omnicron.mintlify.app/#organization\"},\"isPartOf\":{\"@id\":\"https://omnicron.mintlify.app#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Omnicron Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Omnicron Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/get-started/quick-start/requirements.md","siteName":"Omnicron Docs","nav":{"global":{"anchors":[{"anchor":"Github","href":"https://github.com/kingmariano/omnicron","icon":"github"},{"anchor":"Issues","href":"https://github.com/kingmariano/omnicron/issues","icon":"envelope"},{"anchor":"Join our Community","href":"https://discord.com/channels/1265810179602120868/1265810180663152742","icon":"discord"}]},"tabs":[{"tab":"Documentation","groups":[{"group":"Get Started","pages":[{"title":"Introduction","description":"Welcome to the Omnicron Docs!","href":"/introduction"},{"group":"Quick Start","pages":[{"title":"Requirements","href":"/get-started/quick-start/requirements"},{"title":"Installation","description":"Follow these steps to install Omnicron and get started quickly.","href":"/get-started/quick-start/installation"}]}]},{"group":"Features","pages":[{"title":"Chat Completions","icon":"message","href":"/features/chatcompeletion"},{"title":"Image Generation","icon":"image","href":"/features/imagegeneration"},{"title":"Image Upscale","icon":"sparkles","href":"/features/imageupscale"},{"title":"Video Generation","icon":"video","href":"/features/videogeneration"},{"title":"Text To Speech","icon":"volume","href":"/features/textTospeech"},{"title":"Speech To Text","icon":"text","href":"/features/speechTotext"},{"title":"Music Generation","icon":"music","href":"/features/musicgeneration"},{"title":"Video Downloader","icon":"download","href":"/features/downloadvideo"},{"title":"Convert To MP3","icon":"file-mp3","href":"/features/convertTomp3"},{"title":"Song Recognition","icon":"magnifying-glass-music","href":"/features/shazam"},{"title":"Music Download","icon":"cloud-music","href":"/features/musicdownload"},{"title":"YouTube Summarization","icon":"youtube","href":"/features/youtubesummarization"},{"title":"Image To Text","icon":"file","iconType":"solid","href":"/features/imageTotext"}]}]},{"tab":"API Reference","pages":[{"title":"API Reference","href":"/api-reference/authentication"}]},{"tab":"SDKs","pages":[{"title":"SDKs","href":"/sdks/golang"}]},{"tab":"Contributing","pages":[{"title":"Contributing","href":"/contributing/introduction"}]}]},"basePath":"","title":"Requirements - Omnicron Docs","deploymentId":"dpl_2pTxFtyBudBMYZiCw1MyvoA1wxpd","buildId":"dpl_2pTxFtyBudBMYZiCw1MyvoA1wxpd","dynamics":[],"chunks":[]}