openc3-cosmos-tool-docs 5.14.1 → 5.15.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/tools/staticdocs/404.html +3 -3
- data/tools/staticdocs/assets/css/styles.a4426211.css +1 -0
- data/tools/staticdocs/assets/js/{019369f3.d8613c30.js → 019369f3.3a124fd7.js} +1 -1
- data/tools/staticdocs/assets/js/{058ffc22.acfac831.js → 058ffc22.c85ad785.js} +1 -1
- data/tools/staticdocs/assets/js/0686a885.4d6b8154.js +1 -0
- data/tools/staticdocs/assets/js/{07876b9c.990c8af0.js → 07876b9c.b8d12431.js} +1 -1
- data/tools/staticdocs/assets/js/078dbab0.45ea4593.js +1 -0
- data/tools/staticdocs/assets/js/0f5d161c.dda04dbb.js +1 -0
- data/tools/staticdocs/assets/js/{0ff569c9.f11f548e.js → 0ff569c9.317b47d0.js} +1 -1
- data/tools/staticdocs/assets/js/103cc3be.a946540f.js +1 -0
- data/tools/staticdocs/assets/js/{13196248.1b40932b.js → 13196248.d8f8ef9f.js} +1 -1
- data/tools/staticdocs/assets/js/13c1b4e4.50ee3d02.js +1 -0
- data/tools/staticdocs/assets/js/{1b2b4b61.b662e271.js → 1b2b4b61.2556cd65.js} +1 -1
- data/tools/staticdocs/assets/js/{2047b354.cf71ed85.js → 2047b354.75fe47dd.js} +1 -1
- data/tools/staticdocs/assets/js/{22b3ac48.10ffd4c3.js → 22b3ac48.77516494.js} +1 -1
- data/tools/staticdocs/assets/js/2601.ca992ab9.js +1 -0
- data/tools/staticdocs/assets/js/26b8abb2.dcdf815e.js +1 -0
- data/tools/staticdocs/assets/js/{2923e883.0cbdcbc5.js → 2923e883.ed90d0a7.js} +1 -1
- data/tools/staticdocs/assets/js/{2bb7bf90.41136655.js → 2bb7bf90.c642620c.js} +1 -1
- data/tools/staticdocs/assets/js/3dd7ef3b.f84c6956.js +1 -0
- data/tools/staticdocs/assets/js/{3df159b4.6c6b5f85.js → 3df159b4.ff98bfab.js} +1 -1
- data/tools/staticdocs/assets/js/40365d27.c318f801.js +1 -0
- data/tools/staticdocs/assets/js/{411898ad.fb3b44cb.js → 411898ad.e29e2db3.js} +1 -1
- data/tools/staticdocs/assets/js/{42170351.99726677.js → 42170351.15f2f1e3.js} +1 -1
- data/tools/staticdocs/assets/js/43652efd.4e7d6a97.js +1 -0
- data/tools/staticdocs/assets/js/53ca7c5b.3f1245d5.js +1 -0
- data/tools/staticdocs/assets/js/54d0d530.769f5473.js +1 -0
- data/tools/staticdocs/assets/js/55cdbca5.695875ea.js +1 -0
- data/tools/staticdocs/assets/js/5723.f6123e37.js +1 -0
- data/tools/staticdocs/assets/js/{1131.f9e1547d.js → 5778.7d36f1c2.js} +1 -1
- data/tools/staticdocs/assets/js/5b233ba7.0029b2f5.js +1 -0
- data/tools/staticdocs/assets/js/{5bc719f6.80666891.js → 5bc719f6.84f6ce9e.js} +1 -1
- data/tools/staticdocs/assets/js/{5c6ce5ec.3cb1b75a.js → 5c6ce5ec.8667906a.js} +1 -1
- data/tools/staticdocs/assets/js/5e3ed378.91d6735f.js +1 -0
- data/tools/staticdocs/assets/js/5fe211ef.1d991947.js +1 -0
- data/tools/staticdocs/assets/js/64630c4f.a229ae1d.js +1 -0
- data/tools/staticdocs/assets/js/6831b732.a77e4761.js +1 -0
- data/tools/staticdocs/assets/js/696b4199.2700ad91.js +1 -0
- data/tools/staticdocs/assets/js/{6b210247.0db8db18.js → 6b210247.074332a1.js} +1 -1
- data/tools/staticdocs/assets/js/6b65133b.109a6bef.js +1 -0
- data/tools/staticdocs/assets/js/6f92e431.67f5a7a4.js +1 -0
- data/tools/staticdocs/assets/js/{72c6d8a8.41b091e3.js → 72c6d8a8.5fca8d68.js} +1 -1
- data/tools/staticdocs/assets/js/75373ac0.6a0a4fa2.js +1 -0
- data/tools/staticdocs/assets/js/75e64983.e31793e1.js +1 -0
- data/tools/staticdocs/assets/js/7760.7f593c4f.js +2 -0
- data/tools/staticdocs/assets/js/7918.25ec42db.js +1 -0
- data/tools/staticdocs/assets/js/{867640d5.7d9b46cc.js → 867640d5.a8f59357.js} +1 -1
- data/tools/staticdocs/assets/js/89e76475.de702714.js +1 -0
- data/tools/staticdocs/assets/js/8f7843ee.0f25fdc3.js +1 -0
- data/tools/staticdocs/assets/js/9424f0b3.66b19930.js +1 -0
- data/tools/staticdocs/assets/js/97535711.ddc0f5af.js +1 -0
- data/tools/staticdocs/assets/js/99581c43.0767018a.js +1 -0
- data/tools/staticdocs/assets/js/{99b59eea.56ab3bff.js → 99b59eea.d4dd9989.js} +1 -1
- data/tools/staticdocs/assets/js/9d6e81d0.c31feabc.js +1 -0
- data/tools/staticdocs/assets/js/9fb6059a.30085d79.js +1 -0
- data/tools/staticdocs/assets/js/{a507c363.b04cc959.js → a507c363.198e9246.js} +1 -1
- data/tools/staticdocs/assets/js/a677c089.48b6c791.js +1 -0
- data/tools/staticdocs/assets/js/{a9987364.a33207e6.js → a9987364.cfb3492e.js} +1 -1
- data/tools/staticdocs/assets/js/aa6b6c1b.065a8213.js +1 -0
- data/tools/staticdocs/assets/js/b4596165.b4c6c1b8.js +1 -0
- data/tools/staticdocs/assets/js/b6d70f94.66d95cb7.js +1 -0
- data/tools/staticdocs/assets/js/b9f60ba6.655a4097.js +1 -0
- data/tools/staticdocs/assets/js/bd0034eb.ff7f6265.js +1 -0
- data/tools/staticdocs/assets/js/c24eae19.db62873a.js +1 -0
- data/tools/staticdocs/assets/js/{cb8c3f08.bd7af12d.js → cb8c3f08.f669adda.js} +1 -1
- data/tools/staticdocs/assets/js/cd879be4.6ee752c7.js +1 -0
- data/tools/staticdocs/assets/js/d1b923aa.e7ee188a.js +1 -0
- data/tools/staticdocs/assets/js/d1bfc316.963c2477.js +1 -0
- data/tools/staticdocs/assets/js/{d24bf9b6.a8d698fc.js → d24bf9b6.31d82456.js} +1 -1
- data/tools/staticdocs/assets/js/{d57a4b5d.743b976b.js → d57a4b5d.905988ec.js} +1 -1
- data/tools/staticdocs/assets/js/{d5d77c37.cd2d8652.js → d5d77c37.80e1a28b.js} +1 -1
- data/tools/staticdocs/assets/js/{d797a795.9243eac2.js → d797a795.5725bf2b.js} +1 -1
- data/tools/staticdocs/assets/js/{d8ca4191.abd56e6c.js → d8ca4191.56c22a69.js} +1 -1
- data/tools/staticdocs/assets/js/{d9b92eba.d632d375.js → d9b92eba.16d983a0.js} +1 -1
- data/tools/staticdocs/assets/js/{db8fa1d0.b9ed5eb0.js → db8fa1d0.c35b153c.js} +1 -1
- data/tools/staticdocs/assets/js/dc5f7beb.88b0f00b.js +1 -0
- data/tools/staticdocs/assets/js/{e501b0d1.21aadf25.js → e501b0d1.3aa571ae.js} +1 -1
- data/tools/staticdocs/assets/js/{ebec1ccb.4fc9c662.js → ebec1ccb.a801549e.js} +1 -1
- data/tools/staticdocs/assets/js/{f15615f1.0d1e925a.js → f15615f1.0b19ae07.js} +1 -1
- data/tools/staticdocs/assets/js/fd886806.57eeb84b.js +1 -0
- data/tools/staticdocs/assets/js/main.a6fe34c0.js +2 -0
- data/tools/staticdocs/assets/js/runtime~main.256dc9a2.js +1 -0
- data/tools/staticdocs/docs/configuration/command.html +169 -75
- data/tools/staticdocs/docs/configuration/format.html +52 -23
- data/tools/staticdocs/docs/configuration/interfaces.html +90 -27
- data/tools/staticdocs/docs/configuration/plugins.html +163 -114
- data/tools/staticdocs/docs/configuration/protocols.html +87 -47
- data/tools/staticdocs/docs/configuration/ssl-tls.html +103 -32
- data/tools/staticdocs/docs/configuration/table.html +114 -49
- data/tools/staticdocs/docs/configuration/target.html +31 -23
- data/tools/staticdocs/docs/configuration/telemetry-screens.html +442 -184
- data/tools/staticdocs/docs/configuration/telemetry.html +176 -76
- data/tools/staticdocs/docs/configuration.html +3 -3
- data/tools/staticdocs/docs/development/curl.html +55 -12
- data/tools/staticdocs/docs/development/developing.html +84 -72
- data/tools/staticdocs/docs/development/host-install.html +21 -8
- data/tools/staticdocs/docs/development/json-api.html +31 -19
- data/tools/staticdocs/docs/development/log-structure.html +12 -12
- data/tools/staticdocs/docs/development/roadmap.html +32 -6
- data/tools/staticdocs/docs/development/streaming-api.html +82 -10
- data/tools/staticdocs/docs/development/testing.html +24 -15
- data/tools/staticdocs/docs/development.html +4 -4
- data/tools/staticdocs/docs/getting-started/generators.html +108 -34
- data/tools/staticdocs/docs/getting-started/gettingstarted.html +71 -23
- data/tools/staticdocs/docs/getting-started/installation.html +34 -23
- data/tools/staticdocs/docs/getting-started/key_concepts.html +34 -34
- data/tools/staticdocs/docs/getting-started/podman.html +55 -24
- data/tools/staticdocs/docs/getting-started/requirements.html +19 -19
- data/tools/staticdocs/docs/getting-started/upgrading.html +15 -10
- data/tools/staticdocs/docs/getting-started.html +3 -3
- data/tools/staticdocs/docs/guides/bridges.html +62 -18
- data/tools/staticdocs/docs/guides/cfs.html +183 -43
- data/tools/staticdocs/docs/guides/custom-widgets.html +45 -18
- data/tools/staticdocs/docs/guides/little-endian-bitfields.html +13 -4
- data/tools/staticdocs/docs/guides/local-mode.html +19 -14
- data/tools/staticdocs/docs/guides/logging.html +11 -11
- data/tools/staticdocs/docs/guides/monitoring.html +136 -21
- data/tools/staticdocs/docs/guides/performance.html +25 -16
- data/tools/staticdocs/docs/guides/raspberrypi.html +23 -8
- data/tools/staticdocs/docs/guides/script-writing.html +388 -83
- data/tools/staticdocs/docs/guides/scripting-api.html +1340 -477
- data/tools/staticdocs/docs/guides.html +3 -3
- data/tools/staticdocs/docs/meta/contributing.html +18 -13
- data/tools/staticdocs/docs/meta/licenses.html +29 -11
- data/tools/staticdocs/docs/meta/philosophy.html +3 -3
- data/tools/staticdocs/docs/meta/xtce.html +15 -13
- data/tools/staticdocs/docs/meta.html +3 -3
- data/tools/staticdocs/docs/privacy.html +18 -18
- data/tools/staticdocs/docs/tools/autonomic.html +21 -21
- data/tools/staticdocs/docs/tools/bucket-explorer.html +12 -12
- data/tools/staticdocs/docs/tools/calendar.html +20 -20
- data/tools/staticdocs/docs/tools/cmd-sender.html +14 -14
- data/tools/staticdocs/docs/tools/cmd-tlm-server.html +22 -22
- data/tools/staticdocs/docs/tools/data-extractor.html +25 -25
- data/tools/staticdocs/docs/tools/data-viewer.html +12 -12
- data/tools/staticdocs/docs/tools/handbooks.html +5 -5
- data/tools/staticdocs/docs/tools/limits-monitor.html +18 -18
- data/tools/staticdocs/docs/tools/packet-viewer.html +14 -14
- data/tools/staticdocs/docs/tools/script-runner.html +73 -34
- data/tools/staticdocs/docs/tools/table-manager.html +47 -12
- data/tools/staticdocs/docs/tools/tlm-grapher.html +21 -21
- data/tools/staticdocs/docs/tools/tlm-viewer.html +16 -16
- data/tools/staticdocs/docs/tools.html +3 -3
- data/tools/staticdocs/docs.html +13 -13
- data/tools/staticdocs/index.html +3 -3
- data/tools/staticdocs/lunr-index-1710043920959.json +1 -0
- data/tools/staticdocs/lunr-index.json +1 -1
- data/tools/staticdocs/markdown-page.html +4 -4
- data/tools/staticdocs/search-doc-1710043920959.json +1 -0
- data/tools/staticdocs/search-doc.json +1 -1
- metadata +87 -87
- data/tools/staticdocs/assets/css/styles.dd31dbff.css +0 -1
- data/tools/staticdocs/assets/js/0686a885.b4118c45.js +0 -1
- data/tools/staticdocs/assets/js/078dbab0.d34d0a8f.js +0 -1
- data/tools/staticdocs/assets/js/0f5d161c.d4d5d4dc.js +0 -1
- data/tools/staticdocs/assets/js/103cc3be.53ec680c.js +0 -1
- data/tools/staticdocs/assets/js/12.afe230eb.js +0 -1
- data/tools/staticdocs/assets/js/13c1b4e4.a9ce7463.js +0 -1
- data/tools/staticdocs/assets/js/1670.3df3e214.js +0 -1
- data/tools/staticdocs/assets/js/2624.ae6ba6f0.js +0 -1
- data/tools/staticdocs/assets/js/26b8abb2.98364dbd.js +0 -1
- data/tools/staticdocs/assets/js/3dd7ef3b.5133eebe.js +0 -1
- data/tools/staticdocs/assets/js/40365d27.b31cf9ac.js +0 -1
- data/tools/staticdocs/assets/js/43652efd.f9ce2508.js +0 -1
- data/tools/staticdocs/assets/js/4657.780d60d2.js +0 -2
- data/tools/staticdocs/assets/js/53ca7c5b.5ba66d69.js +0 -1
- data/tools/staticdocs/assets/js/54d0d530.29eb7035.js +0 -1
- data/tools/staticdocs/assets/js/55cdbca5.9562da85.js +0 -1
- data/tools/staticdocs/assets/js/5b233ba7.b7a30c7f.js +0 -1
- data/tools/staticdocs/assets/js/5e3ed378.c40da631.js +0 -1
- data/tools/staticdocs/assets/js/5fe211ef.9938cdb0.js +0 -1
- data/tools/staticdocs/assets/js/64630c4f.d3aaa17e.js +0 -1
- data/tools/staticdocs/assets/js/6831b732.176e2062.js +0 -1
- data/tools/staticdocs/assets/js/696b4199.68411c90.js +0 -1
- data/tools/staticdocs/assets/js/6b65133b.3b600a13.js +0 -1
- data/tools/staticdocs/assets/js/6f92e431.0e99b0f7.js +0 -1
- data/tools/staticdocs/assets/js/75373ac0.f2ff00fb.js +0 -1
- data/tools/staticdocs/assets/js/75e64983.6078b2bb.js +0 -1
- data/tools/staticdocs/assets/js/89e76475.76286adb.js +0 -1
- data/tools/staticdocs/assets/js/8f7843ee.7aaf5f45.js +0 -1
- data/tools/staticdocs/assets/js/9424f0b3.d0685f0f.js +0 -1
- data/tools/staticdocs/assets/js/97535711.7354a61a.js +0 -1
- data/tools/staticdocs/assets/js/99581c43.9077ef97.js +0 -1
- data/tools/staticdocs/assets/js/9d6e81d0.48e17a84.js +0 -1
- data/tools/staticdocs/assets/js/9fb6059a.709498de.js +0 -1
- data/tools/staticdocs/assets/js/a677c089.759b7b09.js +0 -1
- data/tools/staticdocs/assets/js/aa6b6c1b.c81fb740.js +0 -1
- data/tools/staticdocs/assets/js/b4596165.0d43540a.js +0 -1
- data/tools/staticdocs/assets/js/b6d70f94.67e3cf1e.js +0 -1
- data/tools/staticdocs/assets/js/b9f60ba6.4f87cb90.js +0 -1
- data/tools/staticdocs/assets/js/bd0034eb.caedd00a.js +0 -1
- data/tools/staticdocs/assets/js/c24eae19.541e6a95.js +0 -1
- data/tools/staticdocs/assets/js/cd879be4.5d8c0503.js +0 -1
- data/tools/staticdocs/assets/js/d1b923aa.2c753a51.js +0 -1
- data/tools/staticdocs/assets/js/d1bfc316.3ba6fac4.js +0 -1
- data/tools/staticdocs/assets/js/dc5f7beb.002b1519.js +0 -1
- data/tools/staticdocs/assets/js/fd886806.823bd757.js +0 -1
- data/tools/staticdocs/assets/js/main.89007ebb.js +0 -2
- data/tools/staticdocs/assets/js/runtime~main.8f84aa81.js +0 -1
- data/tools/staticdocs/lunr-index-1706136992441.json +0 -1
- data/tools/staticdocs/search-doc-1706136992441.json +0 -1
- /data/tools/staticdocs/assets/js/{4657.780d60d2.js.LICENSE.txt → 7760.7f593c4f.js.LICENSE.txt} +0 -0
- /data/tools/staticdocs/assets/js/{main.89007ebb.js.LICENSE.txt → main.a6fe34c0.js.LICENSE.txt} +0 -0
@@ -3,9 +3,9 @@
|
|
3
3
|
<head>
|
4
4
|
<meta charset="UTF-8">
|
5
5
|
<meta name="generator" content="Docusaurus v3.1.0">
|
6
|
-
<title data-rh="true">Getting Started | OpenC3 Docs</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.openc3.com/tools/staticdocs/docs/getting-started/gettingstarted"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Getting Started | OpenC3 Docs"><meta data-rh="true" name="description" content="Welcome to the OpenC3 COSMOS system... Let's get started! This guide is a high level overview that will help with setting up your first COSMOS project."><meta data-rh="true" property="og:description" content="Welcome to the OpenC3 COSMOS system... Let's get started! This guide is a high level overview that will help with setting up your first COSMOS project."><link data-rh="true" rel="icon" href="/tools/staticdocs/img/favicon.png"><link data-rh="true" rel="canonical" href="https://docs.openc3.com/tools/staticdocs/docs/getting-started/gettingstarted"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/getting-started/gettingstarted" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/getting-started/gettingstarted" hreflang="x-default"><link rel="stylesheet" href="/tools/staticdocs/assets/css/styles.
|
7
|
-
<script src="/tools/staticdocs/assets/js/runtime~main.
|
8
|
-
<script src="/tools/staticdocs/assets/js/main.
|
6
|
+
<title data-rh="true">Getting Started | OpenC3 Docs</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.openc3.com/tools/staticdocs/docs/getting-started/gettingstarted"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Getting Started | OpenC3 Docs"><meta data-rh="true" name="description" content="Welcome to the OpenC3 COSMOS system... Let's get started! This guide is a high level overview that will help with setting up your first COSMOS project."><meta data-rh="true" property="og:description" content="Welcome to the OpenC3 COSMOS system... Let's get started! This guide is a high level overview that will help with setting up your first COSMOS project."><link data-rh="true" rel="icon" href="/tools/staticdocs/img/favicon.png"><link data-rh="true" rel="canonical" href="https://docs.openc3.com/tools/staticdocs/docs/getting-started/gettingstarted"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/getting-started/gettingstarted" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/getting-started/gettingstarted" hreflang="x-default"><link rel="stylesheet" href="/tools/staticdocs/assets/css/styles.a4426211.css">
|
7
|
+
<script src="/tools/staticdocs/assets/js/runtime~main.256dc9a2.js" defer="defer"></script>
|
8
|
+
<script src="/tools/staticdocs/assets/js/main.a6fe34c0.js" defer="defer"></script>
|
9
9
|
</head>
|
10
10
|
<body class="navigation-with-keyboard">
|
11
11
|
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return localStorage.getItem("theme")}catch(t){}}();t(null!==e?e:"dark")}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_G6ar" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/tools/staticdocs/"><div class="navbar__logo"><img src="/tools/staticdocs/img/logo.svg" alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--light_DIHH"><img src="/tools/staticdocs/img/logo.svg" alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--dark_Bv2M"></div><b class="navbar__title text--truncate">OpenC3 Docs</b></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/tools/staticdocs/docs">Documentation</a><a href="https://openc3.com/enterprise/" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Enterprise</a></div><div class="navbar__items navbar__items--right"><div class="navbarSearchContainer_bmvg"><div class="navbar__search"><span aria-label="expand searchbar" role="button" class="search-icon" tabindex="0"></span><input id="search_input_react" type="search" placeholder="Loading..." aria-label="Search" class="navbar__search-input search-bar" disabled=""></div></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_UyTV"><div class="docsWrapper_XLvK"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_z1FD" type="button"></button><div class="docRoot_HciC"><aside class="theme-doc-sidebar-container docSidebarContainer_e5ai"><div class="sidebarViewport_N8x0"><div class="sidebar_vJCc"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_qiME"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/tools/staticdocs/docs">Introduction</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--active" aria-expanded="true" href="/tools/staticdocs/docs/getting-started">Getting Started</a><button aria-label="Collapse sidebar category 'Getting Started'" type="button" class="clean-btn menu__caret"></button></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/installation">Installation</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/tools/staticdocs/docs/getting-started/gettingstarted">Getting Started</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/generators">Code Generators</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/upgrading">Upgrading</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/key_concepts">Key Concepts</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/requirements">Requirements and Design</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/podman">Podman</a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/configuration">Configuration</a><button aria-label="Expand sidebar category 'Configuration'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/tools">Tools</a><button aria-label="Expand sidebar category 'Tools'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/guides">Guides</a><button aria-label="Expand sidebar category 'Guides'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/development">Development</a><button aria-label="Expand sidebar category 'Development'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/meta">Meta</a><button aria-label="Expand sidebar category 'Meta'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/tools/staticdocs/docs/privacy">OpenC3, Inc. Privacy Policy</a></li></ul></nav></div></div></aside><main class="docMainContainer_namt"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_YAwJ"><div class="docItemContainer_Rv5Z"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_zCmv" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/tools/staticdocs/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_JFrk"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item"><a class="breadcrumbs__link" itemprop="item" href="/tools/staticdocs/docs/getting-started"><span itemprop="name">Getting Started</span></a><meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Getting Started</span><meta itemprop="position" content="2"></li></ul></nav><div class="tocCollapsible_O_Qc theme-doc-toc-mobile tocMobile_tjDr"><button type="button" class="clean-btn tocCollapsibleButton_htYj">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Getting Started</h1></header><p>Welcome to the OpenC3 COSMOS system... Let's get started! This guide is a high level overview that will help with setting up your first COSMOS project.</p>
|
@@ -15,7 +15,7 @@
|
|
15
15
|
<li>You should now have COSMOS installed and a Demo project available that we can make changes to.</li>
|
16
16
|
</ul>
|
17
17
|
</li>
|
18
|
-
<li>Browse to <a href="http://localhost:2900"
|
18
|
+
<li>Browse to <a href="http://localhost:2900">http://localhost:2900</a>
|
19
19
|
<ul>
|
20
20
|
<li>The COSMOS Command and Telemetry Server will appear. This tool provides real-time information about each "target" in the system. Targets are external systems that receive commands and generate telemetry, often over ethernet or serial connections.</li>
|
21
21
|
</ul>
|
@@ -33,35 +33,47 @@
|
|
33
33
|
</ul>
|
34
34
|
</li>
|
35
35
|
</ol>
|
36
|
-
<
|
37
|
-
|
36
|
+
<admonition title="Browser Version Issue" type="info"><p>When you try to load the page and it fails to load, check with the built-in web development tools / DevTools. We have seen some strange things with version of browsers. You can build to a version of browser if you need to by reading about the <a href="https://github.com/browserslist/browserslist">browserslist</a>. A typical failure results in:</p><pre><code>unexpected token ||=
|
37
|
+
</code></pre><p>To fix this make sure your browsers is compliant with the current settings in the <a href="https://github.com/OpenC3/cosmos/blob/main/openc3-cosmos-init/plugins/openc3-tool-base/.browserslistrc">.browserlistrc</a> file. You can change this and rebuild the image. Note: This can cause build speeds to increase or decrease.</p></admonition>
|
38
|
+
<h2 id="interfacing-with-your-hardware">Interfacing with Your Hardware</h2>
|
38
39
|
<p>Playing with the COSMOS Demo is fun and all, but now you want to talk to your own real hardware? Let's do it!</p>
|
39
|
-
<
|
40
|
+
<admonition title="Install and Platform" type="info"><p>This guide assumes we're on Windows and COSMOS is installed in C:\COSMOS. Adjust scripts and paths as necessary to match your platform and COSMOS installation directory.</p></admonition>
|
40
41
|
<ol>
|
41
42
|
<li>
|
42
43
|
<p>Before creating your own configuration you should uninstall the COSMOS Demo so you're working with a clean COSMOS system. Click the Admin button and the PLUGINS tab. Then click the Trash can icon next to openc3-cosmos-demo to delete it. When you go back to the Command and Telemetry Server you should have a blank table with no interfaces.</p>
|
43
44
|
</li>
|
44
45
|
<li>
|
45
|
-
<p>If you followed the <a href="/tools/staticdocs/docs/getting-started/installation">Installation Guide</a> you should already be inside a cloned <a href="https://github.com/OpenC3/cosmos-project"
|
46
|
+
<p>If you followed the <a href="/tools/staticdocs/docs/getting-started/installation">Installation Guide</a> you should already be inside a cloned <a href="https://github.com/OpenC3/cosmos-project">openc3-project</a> which is in your PATH (necessary for openc3.bat / openc3.sh to be resolved). Inside this project it's recommended to edit the README.md (<a href="https://www.markdownguide.org/">Markdown</a>) to describe your program / project.</p>
|
46
47
|
</li>
|
47
48
|
<li>
|
48
49
|
<p>Now we need to create a plugin. Plugins are how we add targets and microservices to COSMOS. Our plugin will contain a single target which contains all the information defining the packets (command and telemetry) that are needed to communicate with the target. Use the COSMOS plugin generator to create the correct structure:</p>
|
49
|
-
<
|
50
|
+
<pre><code class="language-batch">C:\openc3-project> openc3.bat cli generate plugin BOB
|
51
|
+
</code></pre>
|
50
52
|
<p>This should create a new directory called "openc3-cosmos-bob" with a bunch of files in it. The full description of all the files is explained by the <a href="/tools/staticdocs/docs/configuration/plugins#plugin-directory-structure">Plugin Structure</a> page.</p>
|
51
53
|
</li>
|
52
54
|
</ol>
|
53
|
-
<
|
55
|
+
<admonition title="Run as the Root user" type="info"><p>The cli runs as the default COSMOS container user which is the recommended practice. If you're having issues running as that user you can run as the root user (effectively <code>docker run --user=root</code> ) by running <code>cliroot</code> instead of <code>cli</code> in any of the examples.</p></admonition>
|
54
56
|
<ol>
|
55
57
|
<li>
|
56
|
-
<p>Starting with <a href="https://openc3.com/news/2023/02/23/openc3-cosmos-5-5-0-released/"
|
57
|
-
<
|
58
|
+
<p>Starting with <a href="https://openc3.com/news/2023/02/23/openc3-cosmos-5-5-0-released/">COSMOS v5.5.0</a>, the plugin generator creates just the plugin framework (previously it would also create a target). From within the newly created plugin directory, we generate a target.</p>
|
59
|
+
<pre><code class="language-batch">C:\openc3-project> cd openc3-cosmos-bob
|
60
|
+
openc3-cosmos-bob> openc3.bat cli generate target BOB
|
61
|
+
</code></pre>
|
58
62
|
</li>
|
59
63
|
</ol>
|
60
|
-
<
|
64
|
+
<admonition title="Generators" type="info"><p>There are a number of generators available. Run <code>openc3.bat cli generate</code> to see all the avilable options.</p></admonition>
|
61
65
|
<ol>
|
62
66
|
<li>
|
63
67
|
<p>The target generator creates a single target named BOB. Best practice is to create a single target per plugin to make it easier to share targets and upgrade them individually. Lets see what the target generator created for us. Open the openc3-cosmos-bob/targets/BOB/cmd_tlm/cmd.txt:</p>
|
64
|
-
<
|
68
|
+
<pre><code class="language-ruby">COMMAND BOB EXAMPLE BIG_ENDIAN "Packet description"
|
69
|
+
# Keyword Name BitSize Type Min Max Default Description
|
70
|
+
APPEND_ID_PARAMETER ID 16 INT 1 1 1 "Identifier"
|
71
|
+
APPEND_PARAMETER VALUE 32 FLOAT 0 10.5 2.5 "Value"
|
72
|
+
APPEND_PARAMETER BOOL 8 UINT MIN MAX 0 "Boolean"
|
73
|
+
STATE FALSE 0
|
74
|
+
STATE TRUE 1
|
75
|
+
APPEND_PARAMETER LABEL 0 STRING "OpenC3" "The label to apply"
|
76
|
+
</code></pre>
|
65
77
|
<p>What does this all mean?</p>
|
66
78
|
<ul>
|
67
79
|
<li>We created a COMMAND for target BOB named EXAMPLE.</li>
|
@@ -75,7 +87,15 @@
|
|
75
87
|
</li>
|
76
88
|
<li>
|
77
89
|
<p>Now open the openc3-cosmos-bob/targets/BOB/cmd_tlm/tlm.txt:</p>
|
78
|
-
<
|
90
|
+
<pre><code class="language-ruby">TELEMETRY BOB STATUS BIG_ENDIAN "Telemetry description"
|
91
|
+
# Keyword Name BitSize Type ID Description
|
92
|
+
APPEND_ID_ITEM ID 16 INT 1 "Identifier"
|
93
|
+
APPEND_ITEM VALUE 32 FLOAT "Value"
|
94
|
+
APPEND_ITEM BOOL 8 UINT "Boolean"
|
95
|
+
STATE FALSE 0
|
96
|
+
STATE TRUE 1
|
97
|
+
APPEND_ITEM LABEL 0 STRING "The label to apply"
|
98
|
+
</code></pre>
|
79
99
|
<ul>
|
80
100
|
<li>This time we created a TELEMETRY packet for target BOB called STATUS that contains BIG_ENDIAN items and is described as "Telemetry description".</li>
|
81
101
|
<li>We start by defininig an ID_ITEM called ID that is a 16-bit signed integer (INT) with an id value of 1 and described as "Identifier". Id items are used to take unidentified blobs of bytes and determine which packet they are. In this case if a blob comes in with a value of 1, at bit offset 0 (since we APPEND this item first), interpreted as a 16-bit integer, then this packet will be "identified" as STATUS. Note the first packet defined without any ID_ITEMS is a "catch-all" packet that matches all incoming data (even if the data lengths don't match).</li>
|
@@ -88,7 +108,16 @@
|
|
88
108
|
</li>
|
89
109
|
<li>
|
90
110
|
<p>Now we need to tell COSMOS how to connect to our BOB target. Open the openc3-cosmos-bob/plugin.txt file:</p>
|
91
|
-
<
|
111
|
+
<pre><code class="language-ruby"># Set VARIABLEs here to allow variation in your plugin
|
112
|
+
# See [Plugins](../configuration/plugins.md) for more information
|
113
|
+
VARIABLE bob_target_name BOB
|
114
|
+
|
115
|
+
# Modify this according to your actual target connection
|
116
|
+
# See [Interfaces](../configuration/interfaces.md) for more information
|
117
|
+
TARGET BOB <%= bob_target_name %>
|
118
|
+
INTERFACE <%= bob_target_name %>_INT tcpip_client_interface.rb host.docker.internal 8080 8081 10.0 nil BURST
|
119
|
+
MAP_TARGET <%= bob_target_name %>
|
120
|
+
</code></pre>
|
92
121
|
<ul>
|
93
122
|
<li>This configures the plugin with a VARIABLE called bob_target_name with a default of "BOB". When you install this plugin you will have the option to change the name of this target to something other than "BOB". This is useful to avoid name conflicts and allows you to have multiple copies of the BOB target in your COSMOS system.</li>
|
94
123
|
<li>The TARGET line declares the new BOB target using the name from the variable. The <%= %> syntax is called ERB (embedded Ruby) and allows us to put variables into our text files, in this case referencing our bob_target_name.</li>
|
@@ -96,14 +125,20 @@
|
|
96
125
|
</ul>
|
97
126
|
</li>
|
98
127
|
</ol>
|
99
|
-
<
|
100
|
-
<h2
|
128
|
+
<admonition title="Variables Support Reusability" type="note"><p>In a plugin that you plan to reuse you should make things like hostnames and ports variables</p></admonition>
|
129
|
+
<h2 id="building-your-plugin">Building Your Plugin</h2>
|
101
130
|
<ol>
|
102
131
|
<li>
|
103
132
|
<p>Now we need to build our plugin and upload it to COSMOS.</p>
|
104
|
-
<
|
133
|
+
<pre><code class="language-batch">C:\cosmos-project> cd openc3-cosmos-bob
|
134
|
+
C:\cosmos-project\openc3-cosmos-bob> ..\openc3.bat cli rake build VERSION=1.0.0
|
135
|
+
Successfully built RubyGem
|
136
|
+
Name: openc3-cosmos-bob
|
137
|
+
Version: 1.0.0.20210618174517
|
138
|
+
File: openc3-cosmos-bob-1.0.0.20210618174517.gem
|
139
|
+
</code></pre>
|
105
140
|
<ul>
|
106
|
-
<li>Note that the VERSION is required to specify the version to build. We recommend <a href="https://semver.org/"
|
141
|
+
<li>Note that the VERSION is required to specify the version to build. We recommend <a href="https://semver.org/">sematic versioning</a> when building your plugin so people using your plugin (including you) know when there are breaking changes.</li>
|
107
142
|
</ul>
|
108
143
|
</li>
|
109
144
|
<li>
|
@@ -111,17 +146,30 @@
|
|
111
146
|
</li>
|
112
147
|
<li>
|
113
148
|
<p>Let's modify our BOB target and then update the copy in COSMOS. If you open Command Sender in COSMOS to BOB EXAMPLE you should see the VALUE parameter has value 2.5. Open the openc3-cosmos-bob/targets/BOB/cmd_tlm/cmd.txt and change the Default value for VALUE to 5 and the description to "New Value".</p>
|
114
|
-
<
|
149
|
+
<pre><code class="language-ruby">COMMAND BOB EXAMPLE BIG_ENDIAN "Packet description"
|
150
|
+
# Keyword Name BitSize Type Min Max Default Description
|
151
|
+
APPEND_ID_PARAMETER ID 16 INT 1 1 1 "Identifier"
|
152
|
+
APPEND_PARAMETER VALUE 32 FLOAT 0 10.5 5 "New Value"
|
153
|
+
APPEND_PARAMETER BOOL 8 UINT MIN MAX 0 "Boolean"
|
154
|
+
STATE FALSE 0
|
155
|
+
STATE TRUE 1
|
156
|
+
APPEND_PARAMETER LABEL 0 STRING "OpenC3" "The label to apply"
|
157
|
+
</code></pre>
|
115
158
|
</li>
|
116
159
|
<li>
|
117
160
|
<p>Rebuild the plugin with a new VERSION number. Since we didn't make any breaking changes we simply bump the patch release number:</p>
|
118
|
-
<
|
161
|
+
<pre><code class="language-batch">C:\cosmos-project\openc3-cosmos-bob> ..\openc3.bat cli rake build VERSION=1.0.1
|
162
|
+
Successfully built RubyGem
|
163
|
+
Name: openc3-cosmos-bob
|
164
|
+
Version: 1.0.1.20210618202504
|
165
|
+
File: openc3-cosmos-bob-1.0.1.20210618202504.gem
|
166
|
+
</code></pre>
|
119
167
|
</li>
|
120
168
|
<li>
|
121
169
|
<p>Go back to the Admin page and click the Plugins Tab. This time click the clock icon next to openc3-cosmos-bob-1.0.0 to Upgrade the plugin. Browse to the newly built plugin gem and select it. This will re-prompt for the plugin variables (bob_target_name) so don't change the name and just click OK. You should see a message about the plugin being installed at which point the plugins list will change to openc3-cosmos-bob-1.0.1.20210618202504.gem. Go back to Command Sender and you should see the new Default value for VALUE is 5 and the description is "New Value". We have upgraded our plugin!</p>
|
122
170
|
</li>
|
123
171
|
<li>
|
124
|
-
<p>At this point you can create a new plugin named after your real target and start modifying the interface and command and telemetry definitions to enable COSMOS to connect to and drive your target. If you run into trouble look for solutions on our <a href="https://github.com/OpenC3/cosmos/issues"
|
172
|
+
<p>At this point you can create a new plugin named after your real target and start modifying the interface and command and telemetry definitions to enable COSMOS to connect to and drive your target. If you run into trouble look for solutions on our <a href="https://github.com/OpenC3/cosmos/issues">Github Issues</a> page. If you would like to enquire about support contracts or professional COSMOS development please contact us at <a href="mailto:support@openc3.com">support@openc3.com</a>.</p>
|
125
173
|
</li>
|
126
174
|
</ol></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="theme-doc-footer-edit-meta-row row"><div class="col"><a href="https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/getting-started/gettingstarted.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_UohW" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_T23F"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/tools/staticdocs/docs/getting-started/installation"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Installation</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/tools/staticdocs/docs/getting-started/generators"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Code Generators</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_TN1Q thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#interfacing-with-your-hardware" class="table-of-contents__link toc-highlight">Interfacing with Your Hardware</a></li><li><a href="#building-your-plugin" class="table-of-contents__link toc-highlight">Building Your Plugin</a></li></ul></div></div></div></div></main></div></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Homepage</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://openc3.com" target="_blank" rel="noopener noreferrer" class="footer__link-item">Home</a></li></ul></div><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/tools/staticdocs/docs">Documentation</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://www.linkedin.com/company/openc3" target="_blank" rel="noopener noreferrer" class="footer__link-item">LinkedIn<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_awgD"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://github.com/OpenC3/cosmos" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_awgD"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a class="footer__link-item" href="/tools/staticdocs/docs/privacy">Privacy</a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2024 OpenC3, Inc.</div></div></div></footer></div>
|
127
175
|
</body>
|
@@ -3,16 +3,16 @@
|
|
3
3
|
<head>
|
4
4
|
<meta charset="UTF-8">
|
5
5
|
<meta name="generator" content="Docusaurus v3.1.0">
|
6
|
-
<title data-rh="true">Installation | OpenC3 Docs</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.openc3.com/tools/staticdocs/docs/getting-started/installation"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Installation | OpenC3 Docs"><meta data-rh="true" name="description" content="Installing OpenC3 COSMOS"><meta data-rh="true" property="og:description" content="Installing OpenC3 COSMOS"><link data-rh="true" rel="icon" href="/tools/staticdocs/img/favicon.png"><link data-rh="true" rel="canonical" href="https://docs.openc3.com/tools/staticdocs/docs/getting-started/installation"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/getting-started/installation" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/getting-started/installation" hreflang="x-default"><link rel="stylesheet" href="/tools/staticdocs/assets/css/styles.
|
7
|
-
<script src="/tools/staticdocs/assets/js/runtime~main.
|
8
|
-
<script src="/tools/staticdocs/assets/js/main.
|
6
|
+
<title data-rh="true">Installation | OpenC3 Docs</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.openc3.com/tools/staticdocs/docs/getting-started/installation"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Installation | OpenC3 Docs"><meta data-rh="true" name="description" content="Installing OpenC3 COSMOS"><meta data-rh="true" property="og:description" content="Installing OpenC3 COSMOS"><link data-rh="true" rel="icon" href="/tools/staticdocs/img/favicon.png"><link data-rh="true" rel="canonical" href="https://docs.openc3.com/tools/staticdocs/docs/getting-started/installation"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/getting-started/installation" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/getting-started/installation" hreflang="x-default"><link rel="stylesheet" href="/tools/staticdocs/assets/css/styles.a4426211.css">
|
7
|
+
<script src="/tools/staticdocs/assets/js/runtime~main.256dc9a2.js" defer="defer"></script>
|
8
|
+
<script src="/tools/staticdocs/assets/js/main.a6fe34c0.js" defer="defer"></script>
|
9
9
|
</head>
|
10
10
|
<body class="navigation-with-keyboard">
|
11
|
-
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return localStorage.getItem("theme")}catch(t){}}();t(null!==e?e:"dark")}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_G6ar" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/tools/staticdocs/"><div class="navbar__logo"><img src="/tools/staticdocs/img/logo.svg" alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--light_DIHH"><img src="/tools/staticdocs/img/logo.svg" alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--dark_Bv2M"></div><b class="navbar__title text--truncate">OpenC3 Docs</b></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/tools/staticdocs/docs">Documentation</a><a href="https://openc3.com/enterprise/" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Enterprise</a></div><div class="navbar__items navbar__items--right"><div class="navbarSearchContainer_bmvg"><div class="navbar__search"><span aria-label="expand searchbar" role="button" class="search-icon" tabindex="0"></span><input id="search_input_react" type="search" placeholder="Loading..." aria-label="Search" class="navbar__search-input search-bar" disabled=""></div></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_UyTV"><div class="docsWrapper_XLvK"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_z1FD" type="button"></button><div class="docRoot_HciC"><aside class="theme-doc-sidebar-container docSidebarContainer_e5ai"><div class="sidebarViewport_N8x0"><div class="sidebar_vJCc"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_qiME"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/tools/staticdocs/docs">Introduction</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--active" aria-expanded="true" href="/tools/staticdocs/docs/getting-started">Getting Started</a><button aria-label="Collapse sidebar category 'Getting Started'" type="button" class="clean-btn menu__caret"></button></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/tools/staticdocs/docs/getting-started/installation">Installation</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/gettingstarted">Getting Started</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/generators">Code Generators</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/upgrading">Upgrading</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/key_concepts">Key Concepts</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/requirements">Requirements and Design</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/podman">Podman</a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/configuration">Configuration</a><button aria-label="Expand sidebar category 'Configuration'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/tools">Tools</a><button aria-label="Expand sidebar category 'Tools'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/guides">Guides</a><button aria-label="Expand sidebar category 'Guides'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/development">Development</a><button aria-label="Expand sidebar category 'Development'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/meta">Meta</a><button aria-label="Expand sidebar category 'Meta'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/tools/staticdocs/docs/privacy">OpenC3, Inc. Privacy Policy</a></li></ul></nav></div></div></aside><main class="docMainContainer_namt"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_YAwJ"><div class="docItemContainer_Rv5Z"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_zCmv" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/tools/staticdocs/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_JFrk"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item"><a class="breadcrumbs__link" itemprop="item" href="/tools/staticdocs/docs/getting-started"><span itemprop="name">Getting Started</span></a><meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Installation</span><meta itemprop="position" content="2"></li></ul></nav><div class="tocCollapsible_O_Qc theme-doc-toc-mobile tocMobile_tjDr"><button type="button" class="clean-btn tocCollapsibleButton_htYj">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Installation</h1></header><h2
|
11
|
+
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return localStorage.getItem("theme")}catch(t){}}();t(null!==e?e:"dark")}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_G6ar" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/tools/staticdocs/"><div class="navbar__logo"><img src="/tools/staticdocs/img/logo.svg" alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--light_DIHH"><img src="/tools/staticdocs/img/logo.svg" alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--dark_Bv2M"></div><b class="navbar__title text--truncate">OpenC3 Docs</b></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/tools/staticdocs/docs">Documentation</a><a href="https://openc3.com/enterprise/" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Enterprise</a></div><div class="navbar__items navbar__items--right"><div class="navbarSearchContainer_bmvg"><div class="navbar__search"><span aria-label="expand searchbar" role="button" class="search-icon" tabindex="0"></span><input id="search_input_react" type="search" placeholder="Loading..." aria-label="Search" class="navbar__search-input search-bar" disabled=""></div></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_UyTV"><div class="docsWrapper_XLvK"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_z1FD" type="button"></button><div class="docRoot_HciC"><aside class="theme-doc-sidebar-container docSidebarContainer_e5ai"><div class="sidebarViewport_N8x0"><div class="sidebar_vJCc"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_qiME"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/tools/staticdocs/docs">Introduction</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--active" aria-expanded="true" href="/tools/staticdocs/docs/getting-started">Getting Started</a><button aria-label="Collapse sidebar category 'Getting Started'" type="button" class="clean-btn menu__caret"></button></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/tools/staticdocs/docs/getting-started/installation">Installation</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/gettingstarted">Getting Started</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/generators">Code Generators</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/upgrading">Upgrading</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/key_concepts">Key Concepts</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/requirements">Requirements and Design</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/podman">Podman</a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/configuration">Configuration</a><button aria-label="Expand sidebar category 'Configuration'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/tools">Tools</a><button aria-label="Expand sidebar category 'Tools'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/guides">Guides</a><button aria-label="Expand sidebar category 'Guides'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/development">Development</a><button aria-label="Expand sidebar category 'Development'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/meta">Meta</a><button aria-label="Expand sidebar category 'Meta'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/tools/staticdocs/docs/privacy">OpenC3, Inc. Privacy Policy</a></li></ul></nav></div></div></aside><main class="docMainContainer_namt"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_YAwJ"><div class="docItemContainer_Rv5Z"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_zCmv" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/tools/staticdocs/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_JFrk"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item"><a class="breadcrumbs__link" itemprop="item" href="/tools/staticdocs/docs/getting-started"><span itemprop="name">Getting Started</span></a><meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Installation</span><meta itemprop="position" content="2"></li></ul></nav><div class="tocCollapsible_O_Qc theme-doc-toc-mobile tocMobile_tjDr"><button type="button" class="clean-btn tocCollapsibleButton_htYj">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Installation</h1></header><h2 id="installing-openc3-cosmos">Installing OpenC3 COSMOS</h2>
|
12
12
|
<p>The following sections describe how to get OpenC3 COSMOS installed on various operating systems. This document should help you setup you host machine to allow you to have a running version of COSMOS in no time.</p>
|
13
|
-
<h2
|
14
|
-
<h3
|
15
|
-
<p>Install <a href="https://docs.docker.com/get-docker/"
|
13
|
+
<h2 id="installing-openc3-cosmos-on-host-machines">Installing OpenC3 COSMOS on Host Machines</h2>
|
14
|
+
<h3 id="prerequisites">PREREQUISITES</h3>
|
15
|
+
<p>Install <a href="https://docs.docker.com/get-docker/">Docker</a> and install <a href="https://docs.docker.com/compose/install/">Docker Compose</a>.</p>
|
16
16
|
<ul>
|
17
17
|
<li>
|
18
18
|
<p>Minimum Resources allocated to Docker: 8GB RAM, 1 CPU, 80GB Disk</p>
|
@@ -27,7 +27,7 @@
|
|
27
27
|
<p>WSL2 consumes 50% of total memory on Windows or 8GB, whichever is less. However, on Windows builds before 20175 (use <code>winver</code> to check) it consumes 80% of your total memory. This can have a negative effect on Windows performance!</p>
|
28
28
|
</li>
|
29
29
|
<li>
|
30
|
-
<p>On Windows builds < 20175 or for more fine grained control, create C:\Users\<username>\<a href="https://docs.microsoft.com/en-us/windows/wsl/wsl-config"
|
30
|
+
<p>On Windows builds < 20175 or for more fine grained control, create C:\Users\<username>\<a href="https://docs.microsoft.com/en-us/windows/wsl/wsl-config">.wslconfig</a>. Suggested contents on a 32GB machine:</p>
|
31
31
|
<p>[wsl2]
|
32
32
|
memory=16GB
|
33
33
|
swap=0</p>
|
@@ -35,32 +35,43 @@ swap=0</p>
|
|
35
35
|
</ul>
|
36
36
|
</li>
|
37
37
|
</ul>
|
38
|
-
<
|
38
|
+
<admonition title="Important: Modify Docker Connection Timeouts" type="warning"><p>Docker by default will break idle (no data) connections after a period of 5 minutes. This "feature" will eventually cause you problems if you don't adjust the Docker settings. This may manifest as idle connections dropping or simplying failing to resume after data should have started flowing again. Find the file at C:\Users\username\AppData\Roaming\Docker\settings.json on Windows or ~/Library/Group Containers/group.com.docker/settings.json on MacOS. Modify the value <code>vpnKitMaxPortIdleTime</code> to change the timeout (recommend setting to 0). <strong>Note:</strong> 0 means no timeout (idle connections not dropped)</p></admonition>
|
39
39
|
<p><strong>Note:</strong> As of December 2021 the COSMOS Docker containers are based on the Alpine Docker image.</p>
|
40
|
-
<h3
|
40
|
+
<h3 id="clone-project">CLONE PROJECT</h3>
|
41
41
|
<p>Since the COSMOS 5.0.9 release we recommend using the project template to get started.</p>
|
42
|
-
<
|
43
|
-
|
44
|
-
|
42
|
+
<pre><code class="language-bash">git clone https://github.com/OpenC3/cosmos-project.git
|
43
|
+
git clone https://github.com/OpenC3/cosmos-enterprise-project.git
|
44
|
+
</code></pre>
|
45
|
+
<admonition title="Offline Installation" type="info"><p style="margin-bottom:20px">If you need to install in an offline environment you should first see if you're able to directly use the COSMOS containers. If so you can first save the containers:</p><p style="margin-bottom:20px"><code>./openc3.sh util save</code></p><p style="margin-bottom:20px">By default this will download the 'latest' images and create tar files in the 'tmp' directory which you can transfer to your offline environment. You can pass a release after 'save' to download a specific release (e.g. util save 5.12.0). Transfer the tar files to your offline environment's project 'tmp' dir and import them with:</p><p style="margin-bottom:20px"><code>./openc3.sh util load</code></p></admonition>
|
46
|
+
<h3 id="certificates">CERTIFICATES</h3>
|
45
47
|
<p>The COSMOS containers are designed to work and be built in the presence of an SSL Decryption device. To support this a cacert.pem file can be placed at the base of the COSMOS 5 project that includes any certificates needed by your organization. <strong>Note</strong>: If you set the path to the ssl file in the <code>SSL_CERT_FILE</code> environment variables the openc3 setup script will copy it and place it for the docker container to load.</p>
|
46
|
-
<
|
48
|
+
<admonition title="SSL Issues" type="warning"><p>Increasingly organizations are using some sort of SSL decryptor device which can cause curl and other command line tools like git to have SSL certificate problems. If installation fails with messages that involve "certificate", "SSL", "self-signed", or "secure" this is the problem. IT typically sets up browsers to work correctly but not command line applications. Note that the file extension might not be .pem, it could be .pem, crt, .ca-bundle, .cer, .p7b, .p7s, or potentially something else.</p><p>The workaround is to get a proper local certificate file from your IT department that can be used by tools like curl (for example C:\Shared\Ball.pem). Doesn't matter just somewhere with no spaces.</p><p>Then set the following environment variables to that path (ie. C:\Shared\Ball.pem)</p><p>SSL_CERT_FILE<br>
|
47
49
|
CURL_CA_BUNDLE<br>
|
48
|
-
REQUESTS_CA_BUNDLE<br></p><p>Here are some directions on environment variables in Windows: <a href="https://www.computerhope.com/issues/ch000549.htm"
|
49
|
-
<h3
|
50
|
+
REQUESTS_CA_BUNDLE<br></p><p>Here are some directions on environment variables in Windows: <a href="https://www.computerhope.com/issues/ch000549.htm">Windows Environment Variables</a></p><p>You will need to create new ones with the names above and set their value to the full path to the certificate file.</p></admonition>
|
51
|
+
<h3 id="run">RUN</h3>
|
50
52
|
<p>Add the locally cloned project directory to your path so you can directly use the batch file or shell script. In Windows this would be adding "C:\openc3-project" to the PATH. In Linux you would edit your shell's rc file and export the PATH. For example, on a Mac add the following to ~/.zshrc: <code>export PATH=~/cosmos-project:$PATH</code>.</p>
|
51
53
|
<p>Run <code>openc3.bat run</code> (Windows), or <code>./openc3.sh run</code> (linux/Mac).</p>
|
52
54
|
<p>Note, you can edit the .env file and change OPENC3_TAG to a specific release (e.g. 5.0.9) rather than 'latest'.</p>
|
53
55
|
<p>If you see an error indicating docker daemon is not running ensure Docker and Docker compose is installed and running. If it errors please try to run <code>docker --version</code> or <code>docker-compose --version</code> and try to run the start command again. If the error continues please include the version in your issue if you choose to create one.</p>
|
54
56
|
<p>Running <code>docker ps</code> can help show the running containers.</p>
|
55
57
|
<p><code>openc3.*</code> takes multiple arguments. Run with no arguments for help. An example run of openc3.sh with no arguments will show a usage guide.</p>
|
56
|
-
<
|
57
|
-
|
58
|
-
|
59
|
-
|
58
|
+
<pre><code>./openc3.sh
|
59
|
+
Usage: ./openc3.sh [cli, cliroot, start, stop, cleanup, run, util]
|
60
|
+
* cli: run a cli command as the default user ('cli help' for more info)
|
61
|
+
* cliroot: run a cli command as the root user ('cli help' for more info)
|
62
|
+
* start: start the docker-compose openc3
|
63
|
+
* stop: stop the running dockers for openc3
|
64
|
+
* cleanup: cleanup network and volumes for openc3
|
65
|
+
* run: run the prebuilt containers for openc3
|
66
|
+
* util: various helper commands
|
67
|
+
</code></pre>
|
68
|
+
<h3 id="connect">CONNECT</h3>
|
69
|
+
<p>Connect a web browser to <a href="http://localhost:2900">http://localhost:2900</a>. Set the password to whatever you want.</p>
|
70
|
+
<h3 id="next-steps">NEXT STEPS</h3>
|
60
71
|
<p>Continue to <a href="/tools/staticdocs/docs/getting-started/gettingstarted">Getting Started</a>.</p>
|
61
72
|
<hr>
|
62
|
-
<h3
|
63
|
-
<
|
64
|
-
GitHub describing what we can do to make it better.</p></
|
73
|
+
<h3 id="feedback">Feedback</h3>
|
74
|
+
<admonition title="Find a problem in the documentation?" type="note"><p>Please [create an issue](<a href="https://github.com/OpenC3/cosmos/issues/new/choose%22%3Ecreate">https://github.com/OpenC3/cosmos/issues/new/choose">create</a> an issue) on
|
75
|
+
GitHub describing what we can do to make it better.</p></admonition></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="theme-doc-footer-edit-meta-row row"><div class="col"><a href="https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/getting-started/installation.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_UohW" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_T23F"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/tools/staticdocs/docs/getting-started"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Getting Started</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/tools/staticdocs/docs/getting-started/gettingstarted"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Getting Started</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_TN1Q thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#installing-openc3-cosmos" class="table-of-contents__link toc-highlight">Installing OpenC3 COSMOS</a></li><li><a href="#installing-openc3-cosmos-on-host-machines" class="table-of-contents__link toc-highlight">Installing OpenC3 COSMOS on Host Machines</a><ul><li><a href="#prerequisites" class="table-of-contents__link toc-highlight">PREREQUISITES</a></li><li><a href="#clone-project" class="table-of-contents__link toc-highlight">CLONE PROJECT</a></li><li><a href="#certificates" class="table-of-contents__link toc-highlight">CERTIFICATES</a></li><li><a href="#run" class="table-of-contents__link toc-highlight">RUN</a></li><li><a href="#connect" class="table-of-contents__link toc-highlight">CONNECT</a></li><li><a href="#next-steps" class="table-of-contents__link toc-highlight">NEXT STEPS</a></li><li><a href="#feedback" class="table-of-contents__link toc-highlight">Feedback</a></li></ul></li></ul></div></div></div></div></main></div></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Homepage</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://openc3.com" target="_blank" rel="noopener noreferrer" class="footer__link-item">Home</a></li></ul></div><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/tools/staticdocs/docs">Documentation</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://www.linkedin.com/company/openc3" target="_blank" rel="noopener noreferrer" class="footer__link-item">LinkedIn<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_awgD"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://github.com/OpenC3/cosmos" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_awgD"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a class="footer__link-item" href="/tools/staticdocs/docs/privacy">Privacy</a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2024 OpenC3, Inc.</div></div></div></footer></div>
|
65
76
|
</body>
|
66
77
|
</html>
|