{"componentChunkName":"component---smooth-doc-smooth-doc-src-templates-doc-js","path":"/docs/on-premise/installation/","result":{"data":{"mdx":{"fields":{"pageType":"doc","title":"Installation","editLink":""},"body":"var _excluded = [\"components\"];\nfunction _extends() { return _extends = Object.assign ? Object.assign.bind() : function (n) { for (var e = 1; e < arguments.length; e++) { var t = arguments[e]; for (var r in t) ({}).hasOwnProperty.call(t, r) && (n[r] = t[r]); } return n; }, _extends.apply(null, arguments); }\nfunction _objectWithoutProperties(e, t) { if (null == e) return {}; var o, r, i = _objectWithoutPropertiesLoose(e, t); if (Object.getOwnPropertySymbols) { var s = Object.getOwnPropertySymbols(e); for (r = 0; r < s.length; r++) o = s[r], t.includes(o) || {}.propertyIsEnumerable.call(e, o) && (i[o] = e[o]); } return i; }\nfunction _objectWithoutPropertiesLoose(r, e) { if (null == r) return {}; var t = {}; for (var n in r) if ({}.hasOwnProperty.call(r, n)) { if (e.includes(n)) continue; t[n] = r[n]; } return t; }\n/* @jsxRuntime classic */\n/* @jsx mdx */\n\nvar _frontmatter = {\n  \"title\": \"Installation\",\n  \"description\": \"installation\",\n  \"order\": 30,\n  \"section\": \"On-Premise\"\n};\nvar layoutProps = {\n  _frontmatter: _frontmatter\n};\nvar MDXLayout = \"wrapper\";\nreturn function MDXContent(_ref) {\n  var components = _ref.components,\n    props = _objectWithoutProperties(_ref, _excluded);\n  return mdx(MDXLayout, _extends({}, layoutProps, props, {\n    components: components,\n    mdxType: \"MDXLayout\"\n  }), mdx(\"h1\", {\n    \"id\": \"installation\"\n  }, mdx(\"a\", {\n    parentName: \"h1\",\n    \"href\": \"#installation\",\n    \"aria-label\": \"installation permalink\",\n    \"className\": \"anchor\"\n  }, mdx(\"svg\", {\n    parentName: \"a\",\n    \"aria-hidden\": \"true\",\n    \"focusable\": \"false\",\n    \"height\": \"16\",\n    \"version\": \"1.1\",\n    \"viewBox\": \"0 0 16 16\",\n    \"width\": \"16\"\n  }, mdx(\"path\", {\n    parentName: \"svg\",\n    \"fillRule\": \"evenodd\",\n    \"d\": \"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"\n  }))), \"Installation\"), mdx(\"br\", null), mdx(\"p\", null, \"This page details the steps to install PathcoreFlow to an on-premise server or virtual machine (VM). This is not applicable to any customers of Pathcore's cloud services.\"), mdx(\"div\", {\n    className: \"info\"\n  }, \"For additional assistance with installation of PathcoreFlow to a server or virtual machine, please reach out to your account manager to ask about our installation support service.\"), mdx(\"h2\", {\n    \"id\": \"prerequisites\"\n  }, mdx(\"a\", {\n    parentName: \"h2\",\n    \"href\": \"#prerequisites\",\n    \"aria-label\": \"prerequisites permalink\",\n    \"className\": \"anchor\"\n  }, mdx(\"svg\", {\n    parentName: \"a\",\n    \"aria-hidden\": \"true\",\n    \"focusable\": \"false\",\n    \"height\": \"16\",\n    \"version\": \"1.1\",\n    \"viewBox\": \"0 0 16 16\",\n    \"width\": \"16\"\n  }, mdx(\"path\", {\n    parentName: \"svg\",\n    \"fillRule\": \"evenodd\",\n    \"d\": \"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"\n  }))), \"Prerequisites\"), mdx(\"p\", null, \"In addition to the \", mdx(\"a\", {\n    parentName: \"p\",\n    \"href\": \"/flow/manual/latest/docs/on-premise/technical-requirements/\"\n  }, \"Technical Requirements\"), \" you will require:\"), mdx(\"ul\", null, mdx(\"li\", {\n    parentName: \"ul\"\n  }, mdx(\"a\", {\n    parentName: \"li\",\n    \"href\": \"https://www.docker.com/\"\n  }, \"Docker\"), \" Container Engine installed and updated to the latest stable version\", mdx(\"ul\", {\n    parentName: \"li\"\n  }, mdx(\"li\", {\n    parentName: \"ul\"\n  }, \"Including Docker Compose plugin\"))), mdx(\"li\", {\n    parentName: \"ul\"\n  }, \"The server or VM hostname and/or static IP address where users will access the PathcoreFlow service\"), mdx(\"li\", {\n    parentName: \"ul\"\n  }, \"The installation script (\", mdx(\"inlineCode\", {\n    parentName: \"li\"\n  }, \"pathcoreflow-vX.Y.Z-installer.sh\"), \") provided by Pathcore Support\")), mdx(\"h2\", {\n    \"id\": \"installation-instructions\"\n  }, mdx(\"a\", {\n    parentName: \"h2\",\n    \"href\": \"#installation-instructions\",\n    \"aria-label\": \"installation instructions permalink\",\n    \"className\": \"anchor\"\n  }, mdx(\"svg\", {\n    parentName: \"a\",\n    \"aria-hidden\": \"true\",\n    \"focusable\": \"false\",\n    \"height\": \"16\",\n    \"version\": \"1.1\",\n    \"viewBox\": \"0 0 16 16\",\n    \"width\": \"16\"\n  }, mdx(\"path\", {\n    parentName: \"svg\",\n    \"fillRule\": \"evenodd\",\n    \"d\": \"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"\n  }))), \"Installation Instructions\"), mdx(\"p\", null, \"Standard installation of PathcoreFlow is performed using the \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"pathcoreflow-vX.Y.Z-installer.sh\"), \" script provided by Pathcore Support.\"), mdx(\"details\", null, mdx(\"summary\", null, \" To install PathcoreFlow \"), mdx(\"ol\", null, mdx(\"li\", {\n    parentName: \"ol\"\n  }, mdx(\"p\", {\n    parentName: \"li\"\n  }, \"Transfer the install script to the server or VM which will host PathcoreFlow. This is typically done via \", mdx(\"a\", {\n    parentName: \"p\",\n    \"href\": \"https://en.wikipedia.org/wiki/SSH_File_Transfer_Protocol\"\n  }, \"SSH File Transfer Protocol (SFTP)\"), \" (e.g., the \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"scp\"), \" command) to somewhere temporary (e.g., \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"/tmp\"), \")\")), mdx(\"li\", {\n    parentName: \"ol\"\n  }, mdx(\"p\", {\n    parentName: \"li\"\n  }, \"Log in to the server or VM hosting PathcoreFlow and run the install script, e.g.:\"), mdx(\"pre\", {\n    parentName: \"li\"\n  }, mdx(\"code\", {\n    parentName: \"pre\",\n    \"className\": \"language-bash\"\n  }, \"bash /tmp/pathcoreflow-v4.2.0-installer.sh\\n\")), mdx(\"div\", {\n    className: \"info\"\n  }, mdx(\"div\", null, \"The script should be executed by a user with \", mdx(\"code\", null, \"sudo\"), \" access. Your password may be requested to perform some tasks.\"))), mdx(\"li\", {\n    parentName: \"ol\"\n  }, mdx(\"p\", {\n    parentName: \"li\"\n  }, \"Follow the prompts for information. You will be asked to provide the following information:\"), mdx(\"ul\", {\n    parentName: \"li\"\n  }, mdx(\"li\", {\n    parentName: \"ul\"\n  }, \"The UID (User ID) and GID (Group ID) for the user that will own the database files\"), mdx(\"li\", {\n    parentName: \"ul\"\n  }, \"The hostname or IP address that will be used to access PathcoreFlow\"), mdx(\"li\", {\n    parentName: \"ul\"\n  }, \"A team name (this can be changed later)\"), mdx(\"li\", {\n    parentName: \"ul\"\n  }, \"The name, email address, and password for the initial administrator user\"))), mdx(\"li\", {\n    parentName: \"ol\"\n  }, mdx(\"p\", {\n    parentName: \"li\"\n  }, \"A summary is displayed after installing, and your PathcoreFlow service should be available at the listed URL\")))), mdx(\"h2\", {\n    \"id\": \"after-installation\"\n  }, mdx(\"a\", {\n    parentName: \"h2\",\n    \"href\": \"#after-installation\",\n    \"aria-label\": \"after installation permalink\",\n    \"className\": \"anchor\"\n  }, mdx(\"svg\", {\n    parentName: \"a\",\n    \"aria-hidden\": \"true\",\n    \"focusable\": \"false\",\n    \"height\": \"16\",\n    \"version\": \"1.1\",\n    \"viewBox\": \"0 0 16 16\",\n    \"width\": \"16\"\n  }, mdx(\"path\", {\n    parentName: \"svg\",\n    \"fillRule\": \"evenodd\",\n    \"d\": \"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"\n  }))), \"After Installation\"), mdx(\"p\", null, \"After completing the initial installation, you may also need to perform some additional \", mdx(\"a\", {\n    parentName: \"p\",\n    \"href\": \"/flow/manual/latest/docs/on-premise/configuration/\"\n  }, \"configuration\"), \" for certain features.\"), mdx(\"h2\", {\n    \"id\": \"support\"\n  }, mdx(\"a\", {\n    parentName: \"h2\",\n    \"href\": \"#support\",\n    \"aria-label\": \"support permalink\",\n    \"className\": \"anchor\"\n  }, mdx(\"svg\", {\n    parentName: \"a\",\n    \"aria-hidden\": \"true\",\n    \"focusable\": \"false\",\n    \"height\": \"16\",\n    \"version\": \"1.1\",\n    \"viewBox\": \"0 0 16 16\",\n    \"width\": \"16\"\n  }, mdx(\"path\", {\n    parentName: \"svg\",\n    \"fillRule\": \"evenodd\",\n    \"d\": \"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"\n  }))), \"Support\"), mdx(\"p\", null, \"Pathcore also offers specialized technical support services designed for on-premise deployments. These services are designed to support customer IT teams with installation and maintenance of Pathcore software.\"), mdx(\"p\", null, \"These services can accommodate standard or non-standard deployments and provide custom solutions when required. Ask your account manager for more information about support services we offer.\"));\n}\n;\nMDXContent.isMDXComponent = true;","tableOfContents":{"items":[{"url":"#installation","title":"Installation","items":[{"url":"#prerequisites","title":"Prerequisites"},{"url":"#installation-instructions","title":"Installation Instructions"},{"url":"#after-installation","title":"After Installation"},{"url":"#support","title":"Support"}]}]}}},"pageContext":{"id":"23f312af-1ad3-59ab-ae35-8091f9a97817"}},"staticQueryHashes":["1086510573","1106176283","1122327541","2140385554","2719290676","3597609067","4027383558"]}