openc3-cosmos-tool-docs 6.4.1 → 6.4.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/tools/staticdocs/404.html +4 -1
- data/tools/staticdocs/assets/css/styles.1a361da6.css +1 -0
- data/tools/staticdocs/assets/images/cmd-processing-f279f2a9798a3000e07540ec5d4eaf095a84b312cd673285b595eebf901f4663.png +0 -0
- data/tools/staticdocs/assets/images/docker-security-bb6d4bdd60a5cd7df87a572159c6369b67bee5735be5a501b25786cabdcd4228.png +0 -0
- data/tools/staticdocs/assets/images/tlm-processing-ce5d4cc16e4a19d9c4f799cc8af975e93eb1c54ba0d43acbc31cc048667b223d.png +0 -0
- data/tools/staticdocs/assets/js/019369f3.5dd06a57.js +1 -0
- data/tools/staticdocs/assets/js/058ffc22.ed3ac5fa.js +1 -0
- data/tools/staticdocs/assets/js/0686a885.ef66a55c.js +1 -0
- data/tools/staticdocs/assets/js/078dbab0.43788fd9.js +1 -0
- data/tools/staticdocs/assets/js/0f5d161c.7aacaf90.js +1 -0
- data/tools/staticdocs/assets/js/0ff569c9.7aa50138.js +1 -0
- data/tools/staticdocs/assets/js/103cc3be.ff33b528.js +1 -0
- data/tools/staticdocs/assets/js/13196248.14de6ce1.js +1 -0
- data/tools/staticdocs/assets/js/13c1b4e4.2dafa283.js +1 -0
- data/tools/staticdocs/assets/js/1602.502ef9b1.js +1 -0
- data/tools/staticdocs/assets/js/1e02e6a3.d99a363c.js +1 -0
- data/tools/staticdocs/assets/js/2047b354.d91543a5.js +1 -0
- data/tools/staticdocs/assets/js/2124.545702e0.js +1 -0
- data/tools/staticdocs/assets/js/22b3ac48.5eb8d876.js +1 -0
- data/tools/staticdocs/assets/js/2368.fd1bb46a.js +4 -0
- data/tools/staticdocs/assets/js/26b8abb2.021651f5.js +1 -0
- data/tools/staticdocs/assets/js/2bb7bf90.1eee5bcb.js +1 -0
- data/tools/staticdocs/assets/js/2c15ad40.7f30b517.js +1 -0
- data/tools/staticdocs/assets/js/35398c5c.4f30c5da.js +1 -0
- data/tools/staticdocs/assets/js/3687.8bc61ef3.js +101 -0
- data/tools/staticdocs/assets/js/3dd7ef3b.dfbe9bb7.js +1 -0
- data/tools/staticdocs/assets/js/40365d27.42b05c12.js +1 -0
- data/tools/staticdocs/assets/js/411898ad.e55efd5d.js +1 -0
- data/tools/staticdocs/assets/js/42170351.2de491d4.js +1 -0
- data/tools/staticdocs/assets/js/43652efd.f7c95691.js +1 -0
- data/tools/staticdocs/assets/js/53ca7c5b.2da36c11.js +1 -0
- data/tools/staticdocs/assets/js/54d0d530.7cc2c5cc.js +1 -0
- data/tools/staticdocs/assets/js/5b233ba7.29533a03.js +1 -0
- data/tools/staticdocs/assets/js/5bc719f6.62d9a8b8.js +1 -0
- data/tools/staticdocs/assets/js/5c6ce5ec.40e0caf8.js +1 -0
- data/tools/staticdocs/assets/js/5e3ed378.64ea5a52.js +1 -0
- data/tools/staticdocs/assets/js/5fe211ef.2d29f3fb.js +1 -0
- data/tools/staticdocs/assets/js/6831b732.ec0009ac.js +1 -0
- data/tools/staticdocs/assets/js/696b4199.1c205c60.js +1 -0
- data/tools/staticdocs/assets/js/6b210247.32ded6d5.js +1 -0
- data/tools/staticdocs/assets/js/6b65133b.b2a62736.js +1 -0
- data/tools/staticdocs/assets/js/6f92e431.7bd2a1f1.js +1 -0
- data/tools/staticdocs/assets/js/72c6d8a8.21321ecc.js +1 -0
- data/tools/staticdocs/assets/js/75e64983.e0eb7741.js +1 -0
- data/tools/staticdocs/assets/js/7690.fc05b8e6.js +1 -0
- data/tools/staticdocs/assets/js/7719.0d312792.js +1 -0
- data/tools/staticdocs/assets/js/80c97f38.a0dfbdf7.js +1 -0
- data/tools/staticdocs/assets/js/867640d5.32ca371f.js +1 -0
- data/tools/staticdocs/assets/js/{89e76475.e1b0dbdb.js → 89e76475.20b3a636.js} +1 -1
- data/tools/staticdocs/assets/js/8f7843ee.6d7c9cd4.js +1 -0
- data/tools/staticdocs/assets/js/9424f0b3.75b12400.js +1 -0
- data/tools/staticdocs/assets/js/964eb012.0eee94ba.js +1 -0
- data/tools/staticdocs/assets/js/97535711.630cee4d.js +1 -0
- data/tools/staticdocs/assets/js/99581c43.73b5cd90.js +1 -0
- data/tools/staticdocs/assets/js/9d6e81d0.6b6404ff.js +1 -0
- data/tools/staticdocs/assets/js/9fb6059a.715fc441.js +1 -0
- data/tools/staticdocs/assets/js/a677c089.76d13f14.js +1 -0
- data/tools/staticdocs/assets/js/a9987364.3b3e7379.js +1 -0
- data/tools/staticdocs/assets/js/a9b2dc27.da1da6f1.js +1 -0
- data/tools/staticdocs/assets/js/aa6b6c1b.bc122746.js +1 -0
- data/tools/staticdocs/assets/js/b062d239.4e8142cb.js +1 -0
- data/tools/staticdocs/assets/js/b38a6d74.4a10f506.js +1 -0
- data/tools/staticdocs/assets/js/b4596165.08749f15.js +1 -0
- data/tools/staticdocs/assets/js/b6d70f94.776bc00f.js +1 -0
- data/tools/staticdocs/assets/js/b9f60ba6.ce400445.js +1 -0
- data/tools/staticdocs/assets/js/bd0034eb.a201a4a7.js +1 -0
- data/tools/staticdocs/assets/js/c24eae19.77326c08.js +1 -0
- data/tools/staticdocs/assets/js/{c2598f55.812cdcd1.js → c2598f55.85419dc8.js} +1 -1
- data/tools/staticdocs/assets/js/cb8c3f08.73cefada.js +1 -0
- data/tools/staticdocs/assets/js/cd879be4.dc2adfcc.js +1 -0
- data/tools/staticdocs/assets/js/d1b923aa.57f5e162.js +1 -0
- data/tools/staticdocs/assets/js/d1bfc316.73bb876f.js +1 -0
- data/tools/staticdocs/assets/js/d24bf9b6.e348c06d.js +1 -0
- data/tools/staticdocs/assets/js/d57a4b5d.885590b1.js +1 -0
- data/tools/staticdocs/assets/js/d5d77c37.1143a9d4.js +1 -0
- data/tools/staticdocs/assets/js/d66bf9c0.0ffb9759.js +1 -0
- data/tools/staticdocs/assets/js/d8ca4191.fe602968.js +1 -0
- data/tools/staticdocs/assets/js/d9b92eba.a115a366.js +1 -0
- data/tools/staticdocs/assets/js/db8fa1d0.1aefa4e7.js +1 -0
- data/tools/staticdocs/assets/js/dbe31111.9c957b0c.js +1 -0
- data/tools/staticdocs/assets/js/dc5f7beb.ddc630ca.js +1 -0
- data/tools/staticdocs/assets/js/e501b0d1.f9c2d1fc.js +1 -0
- data/tools/staticdocs/assets/js/f15615f1.a4d98d69.js +1 -0
- data/tools/staticdocs/assets/js/fd886806.656b4fa3.js +1 -0
- data/tools/staticdocs/assets/js/main.ba1fa268.js +38 -0
- data/tools/staticdocs/assets/js/runtime~main.ca894d1e.js +1 -0
- data/tools/staticdocs/docs/configuration/accessors.html +21 -18
- data/tools/staticdocs/docs/configuration/command.html +35 -35
- data/tools/staticdocs/docs/configuration/conversions.html +156 -0
- data/tools/staticdocs/docs/configuration/format.html +18 -15
- data/tools/staticdocs/docs/configuration/interfaces.html +34 -31
- data/tools/staticdocs/docs/configuration/plugins.html +39 -36
- data/tools/staticdocs/docs/configuration/protocols.html +28 -25
- data/tools/staticdocs/docs/configuration/ssl-tls.html +10 -6
- data/tools/staticdocs/docs/configuration/table.html +19 -22
- data/tools/staticdocs/docs/configuration/target.html +11 -8
- data/tools/staticdocs/docs/configuration/telemetry-screens.html +72 -69
- data/tools/staticdocs/docs/configuration/telemetry.html +40 -40
- data/tools/staticdocs/docs/configuration.html +4 -1
- data/tools/staticdocs/docs/development/curl.html +12 -9
- data/tools/staticdocs/docs/development/developing.html +15 -12
- data/tools/staticdocs/docs/development/json-api.html +8 -5
- data/tools/staticdocs/docs/development/log-structure.html +5 -2
- data/tools/staticdocs/docs/development/roadmap.html +5 -2
- data/tools/staticdocs/docs/development/streaming-api.html +13 -10
- data/tools/staticdocs/docs/development/testing.html +15 -12
- data/tools/staticdocs/docs/development.html +4 -1
- data/tools/staticdocs/docs/getting-started/cli.html +16 -13
- data/tools/staticdocs/docs/getting-started/generators.html +19 -16
- data/tools/staticdocs/docs/getting-started/gettingstarted.html +15 -12
- data/tools/staticdocs/docs/getting-started/installation.html +7 -4
- data/tools/staticdocs/docs/getting-started/key-concepts.html +6 -3
- data/tools/staticdocs/docs/getting-started/podman.html +19 -16
- data/tools/staticdocs/docs/getting-started/requirements.html +7 -4
- data/tools/staticdocs/docs/getting-started/upgrading.html +23 -15
- data/tools/staticdocs/docs/getting-started.html +4 -1
- data/tools/staticdocs/docs/guides/bridges.html +7 -4
- data/tools/staticdocs/docs/guides/cfs.html +19 -16
- data/tools/staticdocs/docs/guides/custom-widgets.html +54 -16
- data/tools/staticdocs/docs/guides/dynamic-packets.html +9 -6
- data/tools/staticdocs/docs/guides/exposing-microservices.html +9 -6
- data/tools/staticdocs/docs/guides/little-endian-bitfields.html +6 -3
- data/tools/staticdocs/docs/guides/local-mode.html +6 -3
- data/tools/staticdocs/docs/guides/logging.html +5 -2
- data/tools/staticdocs/docs/guides/monitoring.html +11 -8
- data/tools/staticdocs/docs/guides/performance.html +6 -3
- data/tools/staticdocs/docs/guides/raspberrypi.html +6 -3
- data/tools/staticdocs/docs/guides/reference-architectures.html +35 -0
- data/tools/staticdocs/docs/guides/script-writing.html +46 -43
- data/tools/staticdocs/docs/guides/scripting-api.html +627 -433
- data/tools/staticdocs/docs/guides.html +4 -1
- data/tools/staticdocs/docs/meta/contributing.html +10 -7
- data/tools/staticdocs/docs/meta/licenses.html +6 -3
- data/tools/staticdocs/docs/meta/philosophy.html +5 -2
- data/tools/staticdocs/docs/meta/xtce.html +7 -4
- data/tools/staticdocs/docs/meta.html +4 -1
- data/tools/staticdocs/docs/privacy.html +5 -2
- data/tools/staticdocs/docs/tools/admin.html +5 -2
- data/tools/staticdocs/docs/tools/autonomic.html +5 -2
- data/tools/staticdocs/docs/tools/bucket-explorer.html +5 -2
- data/tools/staticdocs/docs/tools/calendar.html +5 -2
- data/tools/staticdocs/docs/tools/cmd-sender.html +5 -2
- data/tools/staticdocs/docs/tools/cmd-tlm-server.html +5 -2
- data/tools/staticdocs/docs/tools/command_history.html +5 -2
- data/tools/staticdocs/docs/tools/data-extractor.html +5 -2
- data/tools/staticdocs/docs/tools/data-viewer.html +5 -2
- data/tools/staticdocs/docs/tools/handbooks.html +5 -2
- data/tools/staticdocs/docs/tools/limits-monitor.html +5 -2
- data/tools/staticdocs/docs/tools/packet-viewer.html +5 -2
- data/tools/staticdocs/docs/tools/script-runner.html +9 -6
- data/tools/staticdocs/docs/tools/table-manager.html +6 -3
- data/tools/staticdocs/docs/tools/tlm-grapher.html +5 -2
- data/tools/staticdocs/docs/tools/tlm-viewer.html +5 -2
- data/tools/staticdocs/docs/tools.html +4 -1
- data/tools/staticdocs/docs.html +6 -8
- data/tools/staticdocs/img/cmd-processing.png +0 -0
- data/tools/staticdocs/img/docker-local-security.png +0 -0
- data/tools/staticdocs/img/docker-security.png +0 -0
- data/tools/staticdocs/img/tlm-processing.png +0 -0
- data/tools/staticdocs/index.html +4 -1
- data/tools/staticdocs/lunr-index-1748640055686.json +1 -0
- data/tools/staticdocs/lunr-index.json +1 -1
- data/tools/staticdocs/markdown-page.html +5 -2
- data/tools/staticdocs/search-doc-1748640055686.json +1 -0
- data/tools/staticdocs/search-doc.json +1 -1
- data/tools/staticdocs/sitemap.xml +1 -1
- metadata +94 -83
- data/tools/staticdocs/assets/css/styles.1de6b959.css +0 -1
- data/tools/staticdocs/assets/js/019369f3.43fd7635.js +0 -1
- data/tools/staticdocs/assets/js/058ffc22.5cfabd67.js +0 -1
- data/tools/staticdocs/assets/js/0686a885.0e2ea47d.js +0 -1
- data/tools/staticdocs/assets/js/078dbab0.5515d5e3.js +0 -1
- data/tools/staticdocs/assets/js/0f5d161c.7697df48.js +0 -1
- data/tools/staticdocs/assets/js/0ff569c9.f81b787b.js +0 -1
- data/tools/staticdocs/assets/js/103cc3be.e7943c80.js +0 -1
- data/tools/staticdocs/assets/js/13196248.ea83002e.js +0 -1
- data/tools/staticdocs/assets/js/13c1b4e4.eb5250f4.js +0 -1
- data/tools/staticdocs/assets/js/1e02e6a3.12bdc98d.js +0 -1
- data/tools/staticdocs/assets/js/2047b354.d91f6c3e.js +0 -1
- data/tools/staticdocs/assets/js/22b3ac48.0df9587b.js +0 -1
- data/tools/staticdocs/assets/js/26b8abb2.7f8d4cb0.js +0 -1
- data/tools/staticdocs/assets/js/2bb7bf90.1772f030.js +0 -1
- data/tools/staticdocs/assets/js/35398c5c.fcf47881.js +0 -1
- data/tools/staticdocs/assets/js/3969.afdd070b.js +0 -1
- data/tools/staticdocs/assets/js/3dd7ef3b.c3455b97.js +0 -1
- data/tools/staticdocs/assets/js/40365d27.5ed2e9b5.js +0 -1
- data/tools/staticdocs/assets/js/411898ad.f7b3ff17.js +0 -1
- data/tools/staticdocs/assets/js/42170351.fbc05869.js +0 -1
- data/tools/staticdocs/assets/js/43652efd.60fa883f.js +0 -1
- data/tools/staticdocs/assets/js/5205.c6f31e57.js +0 -1
- data/tools/staticdocs/assets/js/5328.3e2a53eb.js +0 -1
- data/tools/staticdocs/assets/js/53ca7c5b.fe331a71.js +0 -1
- data/tools/staticdocs/assets/js/54d0d530.ef91ba12.js +0 -1
- data/tools/staticdocs/assets/js/5761.e7fabbc9.js +0 -4
- data/tools/staticdocs/assets/js/5b233ba7.9d6ba314.js +0 -1
- data/tools/staticdocs/assets/js/5bc719f6.6d27292c.js +0 -1
- data/tools/staticdocs/assets/js/5c6ce5ec.652b922b.js +0 -1
- data/tools/staticdocs/assets/js/5e3ed378.8b51f7c0.js +0 -1
- data/tools/staticdocs/assets/js/5fe211ef.63b46202.js +0 -1
- data/tools/staticdocs/assets/js/651.a043d7b1.js +0 -1
- data/tools/staticdocs/assets/js/6831b732.1318b398.js +0 -1
- data/tools/staticdocs/assets/js/696b4199.1e950fcb.js +0 -1
- data/tools/staticdocs/assets/js/6b210247.6a77064a.js +0 -1
- data/tools/staticdocs/assets/js/6b65133b.0376a397.js +0 -1
- data/tools/staticdocs/assets/js/6f92e431.6439052e.js +0 -1
- data/tools/staticdocs/assets/js/72c6d8a8.b6fcfc30.js +0 -1
- data/tools/staticdocs/assets/js/75e64983.324643a8.js +0 -1
- data/tools/staticdocs/assets/js/80c97f38.607160d3.js +0 -1
- data/tools/staticdocs/assets/js/867640d5.27d9d599.js +0 -1
- data/tools/staticdocs/assets/js/8f7843ee.abe30983.js +0 -1
- data/tools/staticdocs/assets/js/9357.9a7e89b5.js +0 -101
- data/tools/staticdocs/assets/js/9424f0b3.3683501c.js +0 -1
- data/tools/staticdocs/assets/js/964eb012.0e04c58d.js +0 -1
- data/tools/staticdocs/assets/js/97535711.e595488c.js +0 -1
- data/tools/staticdocs/assets/js/99581c43.841b4a2e.js +0 -1
- data/tools/staticdocs/assets/js/9d6e81d0.36405219.js +0 -1
- data/tools/staticdocs/assets/js/9fb6059a.821f7504.js +0 -1
- data/tools/staticdocs/assets/js/a677c089.cfa50691.js +0 -1
- data/tools/staticdocs/assets/js/a9987364.b418f772.js +0 -1
- data/tools/staticdocs/assets/js/a9b2dc27.805dc1ba.js +0 -1
- data/tools/staticdocs/assets/js/aa6b6c1b.ef9b0f38.js +0 -1
- data/tools/staticdocs/assets/js/b062d239.57d6e194.js +0 -1
- data/tools/staticdocs/assets/js/b4596165.c648533a.js +0 -1
- data/tools/staticdocs/assets/js/b6d70f94.a9228642.js +0 -1
- data/tools/staticdocs/assets/js/b9f60ba6.4c0bb1dd.js +0 -1
- data/tools/staticdocs/assets/js/bd0034eb.8ad39448.js +0 -1
- data/tools/staticdocs/assets/js/c24eae19.0575c394.js +0 -1
- data/tools/staticdocs/assets/js/cb8c3f08.07d1c9e9.js +0 -1
- data/tools/staticdocs/assets/js/cd879be4.59af1749.js +0 -1
- data/tools/staticdocs/assets/js/d1b923aa.da892cde.js +0 -1
- data/tools/staticdocs/assets/js/d1bfc316.a58b9bbd.js +0 -1
- data/tools/staticdocs/assets/js/d24bf9b6.9fef8263.js +0 -1
- data/tools/staticdocs/assets/js/d57a4b5d.c74b62b1.js +0 -1
- data/tools/staticdocs/assets/js/d5d77c37.e812e6e7.js +0 -1
- data/tools/staticdocs/assets/js/d66bf9c0.80a50660.js +0 -1
- data/tools/staticdocs/assets/js/d8ca4191.8df86c99.js +0 -1
- data/tools/staticdocs/assets/js/d9b92eba.5db8667e.js +0 -1
- data/tools/staticdocs/assets/js/db8fa1d0.f1eed806.js +0 -1
- data/tools/staticdocs/assets/js/dbe31111.75e9fc53.js +0 -1
- data/tools/staticdocs/assets/js/dc5f7beb.9e4e6681.js +0 -1
- data/tools/staticdocs/assets/js/e501b0d1.d3a1e4bc.js +0 -1
- data/tools/staticdocs/assets/js/f15615f1.49804e96.js +0 -1
- data/tools/staticdocs/assets/js/fd886806.124ffe26.js +0 -1
- data/tools/staticdocs/assets/js/main.b1edeb65.js +0 -36
- data/tools/staticdocs/assets/js/runtime~main.3629ffb4.js +0 -1
- data/tools/staticdocs/lunr-index-1747245438937.json +0 -1
- data/tools/staticdocs/search-doc-1747245438937.json +0 -1
@@ -1,21 +1,29 @@
|
|
1
|
-
<!doctype html><html lang=en dir=ltr class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-getting-started/upgrading" data-has-hydrated=false><meta charset=UTF-8><meta name=generator content="Docusaurus v3.7.0"><title data-rh=true>Upgrading | OpenC3 Docs</title><meta data-rh=true name=viewport content="width=device-width, initial-scale=1.0"><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/upgrading><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="Upgrading | OpenC3 Docs"><meta data-rh=true name=description content="How to upgrade and migrate COSMOS"><meta data-rh=true property=og:description content="How to upgrade and migrate 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/upgrading><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/getting-started/upgrading hreflang=en><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/getting-started/upgrading hreflang=x-default><link rel=stylesheet href=/tools/staticdocs/assets/css/styles.1de6b959.css><script src=/tools/staticdocs/assets/js/runtime~main.3629ffb4.js defer></script><script src=/tools/staticdocs/assets/js/main.b1edeb65.js defer></script><body class=navigation-with-keyboard><script>!function(){var t,e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();t=null!==e?e:"dark",document.documentElement.setAttribute("data-theme",t)}(),function(){try{for(var[t,e]of new URLSearchParams(window.location.search).entries())if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id=__docusaurus><link rel=preload as=image href=/tools/staticdocs/img/logo.svg><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"/></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 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" href=/tools/staticdocs/docs/getting-started>Getting Started</a><button aria-label="Collapse sidebar category 'Getting Started'" aria-expanded=true 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/key-concepts>Key Concepts</a><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 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 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/upgrading>Upgrading</a><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/cli>Command Line Interface</a><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 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 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></ul><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" href=/tools/staticdocs/docs/configuration>Configuration</a><button aria-label="Expand sidebar category 'Configuration'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><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" href=/tools/staticdocs/docs/tools>Tools</a><button aria-label="Expand sidebar category 'Tools'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><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" href=/tools/staticdocs/docs/guides>Guides</a><button aria-label="Expand sidebar category 'Guides'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><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" href=/tools/staticdocs/docs/development>Development</a><button aria-label="Expand sidebar category 'Development'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><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" href=/tools/staticdocs/docs/meta>Meta</a><button aria-label="Expand sidebar category 'Meta'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><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></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 /></svg></a><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 itemscope itemprop=itemListElement itemtype=https://schema.org/ListItem class="breadcrumbs__item breadcrumbs__item--active"><span class=breadcrumbs__link itemprop=name>Upgrading</span><meta itemprop=position content=2></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>Upgrading</h1></header><h2 class="anchor anchorWithStickyNavbar_fF9Z" id=cosmos-upgrades>COSMOS Upgrades<a href=#cosmos-upgrades class=hash-link aria-label="Direct link to COSMOS Upgrades" title="Direct link to COSMOS Upgrades"></a></h2>
|
1
|
+
<!doctype html><html lang=en dir=ltr class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-getting-started/upgrading" data-has-hydrated=false><meta charset=UTF-8><meta name=generator content="Docusaurus v3.8.0"><title data-rh=true>Upgrading | OpenC3 Docs</title><meta data-rh=true name=viewport content="width=device-width, initial-scale=1.0"><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/upgrading><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="Upgrading | OpenC3 Docs"><meta data-rh=true name=description content="How to upgrade and migrate COSMOS"><meta data-rh=true property=og:description content="How to upgrade and migrate 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/upgrading><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/getting-started/upgrading hreflang=en><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/getting-started/upgrading hreflang=x-default><script data-rh=true type=application/ld+json>{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","item":"https://docs.openc3.com/tools/staticdocs/docs/getting-started","name":"Getting Started","position":1},{"@type":"ListItem","item":"https://docs.openc3.com/tools/staticdocs/docs/getting-started/upgrading","name":"Upgrading","position":2}]}</script><link rel=stylesheet href=/tools/staticdocs/assets/css/styles.1a361da6.css><script src=/tools/staticdocs/assets/js/runtime~main.ca894d1e.js defer></script><script src=/tools/staticdocs/assets/js/main.ba1fa268.js defer></script><body class=navigation-with-keyboard><svg xmlns=http://www.w3.org/2000/svg style="display: none;"><defs>
|
2
|
+
<symbol id=theme-svg-external-link viewBox="0 0 24 24"><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"/></symbol>
|
3
|
+
</defs></svg>
|
4
|
+
<script>!function(){var t="dark",e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();document.documentElement.setAttribute("data-theme",e||t),document.documentElement.setAttribute("data-theme-choice",e||t)}(),function(){try{for(var[t,e]of new URLSearchParams(window.location.search).entries())if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id=__docusaurus><link rel=preload as=image href=/tools/staticdocs/img/logo.svg><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="theme-layout-navbar navbar navbar--fixed-top"><div class=navbar__inner><div class="theme-layout-navbar-left 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"/></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="theme-layout-navbar-right 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="theme-layout-main 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 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" href=/tools/staticdocs/docs/getting-started>Getting Started</a><button aria-label="Collapse sidebar category 'Getting Started'" aria-expanded=true type=button class="clean-btn menu__caret"></button></div><ul 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/key-concepts>Key Concepts</a><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 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 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/upgrading>Upgrading</a><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/cli>Command Line Interface</a><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 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 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></ul><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" href=/tools/staticdocs/docs/configuration>Configuration</a><button aria-label="Expand sidebar category 'Configuration'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><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" href=/tools/staticdocs/docs/tools>Tools</a><button aria-label="Expand sidebar category 'Tools'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><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" href=/tools/staticdocs/docs/guides>Guides</a><button aria-label="Expand sidebar category 'Guides'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><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" href=/tools/staticdocs/docs/development>Development</a><button aria-label="Expand sidebar category 'Development'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><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" href=/tools/staticdocs/docs/meta>Meta</a><button aria-label="Expand sidebar category 'Meta'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><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></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><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 /></svg></a><li class=breadcrumbs__item><a class=breadcrumbs__link href=/tools/staticdocs/docs/getting-started><span>Getting Started</span></a><li class="breadcrumbs__item breadcrumbs__item--active"><span class=breadcrumbs__link>Upgrading</span></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>Upgrading</h1></header><h2 class="anchor anchorWithStickyNavbar_fF9Z" id=cosmos-upgrades>COSMOS Upgrades<a href=#cosmos-upgrades class=hash-link aria-label="Direct link to COSMOS Upgrades" title="Direct link to COSMOS Upgrades"></a></h2>
|
5
|
+
<p>OpenC3 releases new versions of COSMOS on a monthy or better cadence. This is done for several reasons: to incorporate new features, fix existing bugs, update dependencies, and close CVEs. We extensively test each release at both the unit level, API level, and system level using Playwright against a deployed COSMOS. Thus we recommend upgrading COSMOS as quickly as possible when new releases become available. While COSMOS itself is tested extensively, we obviously can not test against customer plugins and custom deployments. We recommend having another installation of COSMOS which you can upgrade with your own plugins and verify functionality before upgrading your production environment.</p>
|
2
6
|
<p>COSMOS is released as Docker containers. Since we're using Docker containers and volumes we can simply stop the existing COSMOS application, then download and run the new release.</p>
|
3
7
|
<div class="theme-admonition theme-admonition-info admonition_IZjC alert alert--info"><div class=admonitionHeading_uVvU><span class=admonitionIcon_HiR3><svg viewBox="0 0 14 16"><path fill-rule=evenodd d="M7 2.3c3.14 0 5.7 2.56 5.7 5.7s-2.56 5.7-5.7 5.7A5.71 5.71 0 0 1 1.3 8c0-3.14 2.56-5.7 5.7-5.7zM7 1C3.14 1 0 4.14 0 8s3.14 7 7 7 7-3.14 7-7-3.14-7-7-7zm1 3H6v5h2V4zm0 6H6v2h2v-2z"/></svg></span>Release Notes</div><div class=admonitionContent_bl22><p>Always check the release notes associated with the release on the <a href=https://github.com/OpenC3/cosmos/releases target=_blank rel="noopener noreferrer">releases</a> page. Sometimes there are migration notes.</div></div>
|
4
8
|
<p>This example assumes an existing COSMOS project at C:\cosmos-project.</p>
|
5
9
|
<ol>
|
6
10
|
<li>
|
7
11
|
<p>Stop the current COSMOS application</p>
|
8
|
-
<div class="language-batch codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
12
|
+
<div class="language-batch codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-batch codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">C:\cosmos-project> openc3.bat stop</span><br></span></code></pre></div></div>
|
9
13
|
</li>
|
10
14
|
<li>
|
11
15
|
<p>Change the release in the .env file to the desired release</p>
|
12
|
-
<div class="language-batch codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
16
|
+
<div class="language-batch codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-batch codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">OPENC3_TAG=6.4.1</span><br></span></code></pre></div></div>
|
13
17
|
</li>
|
14
18
|
<li>
|
15
19
|
<p>Run the new COSMOS application</p>
|
16
|
-
<div class="language-batch codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
20
|
+
<div class="language-batch codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-batch codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">C:\cosmos-project> openc3.bat run</span><br></span></code></pre></div></div>
|
17
21
|
</li>
|
18
22
|
</ol>
|
23
|
+
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=upgrade-migration-process>Upgrade Migration Process<a href=#upgrade-migration-process class=hash-link aria-label="Direct link to Upgrade Migration Process" title="Direct link to Upgrade Migration Process"></a></h3>
|
24
|
+
<p>COSMOS doesn't use strict <a href=https://semver.org/ target=_blank rel="noopener noreferrer">semantic versioning</a> for our releases. Our major releases (5.0.0, 6.0.0, etc) are for major architectural changes and backward incompatibilities. Minor releases (6.1.0, 6.2.0, etc) add functionality but can also modify our configuration files. Thus certain minor releases are more important than others when skipping releases.</p>
|
25
|
+
<p>The following table identifies key release milestones which should be incrementally upgraded to by following the linked release notes. Versions not listed can be safely skipped while upgrading. For example, upgrading COSMOS 5.9.0 can go straight to 5.13.0 at which point the release notes should be carefully followed to avoid breaking changes.</p>
|
26
|
+
<table><thead><tr><th style=text-align:left>Version<th style=text-align:left>Summary<tbody><tr><td style=text-align:left><a href=https://github.com/OpenC3/cosmos/releases/tag/v5.13.0 target=_blank rel="noopener noreferrer">5.13.0</a><td style=text-align:left>Breaking change to non-root containers and renamed minio volume. Requires running the migration script and updating compose.yaml and traefik configuration.<tr><td style=text-align:left><a href=https://github.com/OpenC3/cosmos/releases/tag/v5.15.0 target=_blank rel="noopener noreferrer">5.15.0</a><td style=text-align:left>The internal Traefik port was changed to 2900 to match our standard external port and to better support unprivileged runtime environments. Requires updating .env, compose.yaml, and traefik configuration.<tr><td style=text-align:left><a href=https://github.com/OpenC3/cosmos/releases/tag/v6.0.0 target=_blank rel="noopener noreferrer">6.0.0</a><td style=text-align:left>May require no changes but follow the <a href=/tools/staticdocs/docs/getting-started/upgrading#migrating-from-cosmos-5-to-cosmos-6>COSMOS 6 migration guide</a> for custom GUI tools.<tr><td style=text-align:left><a href=https://github.com/OpenC3/cosmos/releases/tag/v6.1.0 target=_blank rel="noopener noreferrer">6.1.0</a><td style=text-align:left>Changed from ActionCable to AnyCable which requires updates to compose.yaml, redis.acl, and traefik configuration. We also broke apart the COSMOS helm charts from a single chart to 3 charts.</table>
|
19
27
|
<div class="theme-admonition theme-admonition-warning admonition_IZjC alert alert--warning"><div class=admonitionHeading_uVvU><span class=admonitionIcon_HiR3><svg viewBox="0 0 16 16"><path fill-rule=evenodd d="M8.893 1.5c-.183-.31-.52-.5-.887-.5s-.703.19-.886.5L.138 13.499a.98.98 0 0 0 0 1.001c.193.31.53.501.886.501h13.964c.367 0 .704-.19.877-.5a1.03 1.03 0 0 0 .01-1.002L8.893 1.5zm.133 11.497H6.987v-2.003h2.039v2.003zm0-3.004H6.987V5.987h2.039v4.006z"/></svg></span>Downgrades</div><div class=admonitionContent_bl22><p>Downgrades are not necessarily supported. When upgrading COSMOS we need to upgrade databases and sometimes migrate internal data structures. While we perform a full regression test on every release, we recommend upgrading an individual machine with your specific plugins and do local testing before rolling out the upgrade to your production system.<p>In general, patch releases (x.y.Z) can be downgraded, minor releases (x.Y.z) <em>might</em> be able to be downgraded and major releases (X.y.z) are NOT able to be downgraded.</div></div>
|
20
28
|
<h2 class="anchor anchorWithStickyNavbar_fF9Z" id=migrating-from-cosmos-5-to-cosmos-6>Migrating From COSMOS 5 to COSMOS 6<a href=#migrating-from-cosmos-5-to-cosmos-6 class=hash-link aria-label="Direct link to Migrating From COSMOS 5 to COSMOS 6" title="Direct link to Migrating From COSMOS 5 to COSMOS 6"></a></h2>
|
21
29
|
<div class="theme-admonition theme-admonition-info admonition_IZjC alert alert--info"><div class=admonitionHeading_uVvU><span class=admonitionIcon_HiR3><svg viewBox="0 0 14 16"><path fill-rule=evenodd d="M7 2.3c3.14 0 5.7 2.56 5.7 5.7s-2.56 5.7-5.7 5.7A5.71 5.71 0 0 1 1.3 8c0-3.14 2.56-5.7 5.7-5.7zM7 1C3.14 1 0 4.14 0 8s3.14 7 7 7 7-3.14 7-7-3.14-7-7-7zm1 3H6v5h2V4zm0 6H6v2h2v-2z"/></svg></span>Developers Only</div><div class=admonitionContent_bl22><p>If you haven't written any custom tools or widgets, there are no special changes required to upgrade from COSMOS 5 to COSMOS 6. Simply follow the normal upgrade instructions above including following the release notes.</div></div>
|
@@ -48,12 +56,12 @@
|
|
48
56
|
<p>If you modified your package.json file manually, don't forget to <code>yarn</code> or <code>npm install</code> at your project's root to apply the changes.</p>
|
49
57
|
<h5 class="anchor anchorWithStickyNavbar_fF9Z" id=1b-update-the-vue-config-file-vueconfigjs>(1.b) Update the Vue config file (<code>vue.config.js</code>)<a href=#1b-update-the-vue-config-file-vueconfigjs class=hash-link aria-label="Direct link to 1b-update-the-vue-config-file-vueconfigjs" title="Direct link to 1b-update-the-vue-config-file-vueconfigjs"></a></h5>
|
50
58
|
<p>You likely have a <code>chainWebpack</code> property in the object that's exported by this file which looks something like this (though your contents might vary)</p>
|
51
|
-
<div class="language-js codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
59
|
+
<div class="language-js codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-js codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token function-variable function" style="color:rgb(130, 170, 255)">chainWebpack</span><span class="token operator" style="color:rgb(127, 219, 202)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token parameter">config</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"> </span><span class="token arrow operator" style="color:rgb(127, 219, 202)">=></span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> config</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token property-access">module</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token method function property-access" style="color:rgb(130, 170, 255)">rule</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string" style="color:rgb(173, 219, 103)">'vue'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token method function property-access" style="color:rgb(130, 170, 255)">use</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string" style="color:rgb(173, 219, 103)">'vue-loader'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token method function property-access" style="color:rgb(130, 170, 255)">tap</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token parameter">options</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"> </span><span class="token arrow operator" style="color:rgb(127, 219, 202)">=></span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token keyword control-flow" style="color:rgb(127, 219, 202)">return</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token literal-property property" style="color:rgb(128, 203, 196)">prettify</span><span class="token operator" style="color:rgb(127, 219, 202)">:</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">false</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><br></span></code></pre></div></div>
|
52
60
|
<p>Add a resolution alias for <code>@vue/compat</code> to the top of this block and set the compiler to use the Vue 2 compat mode:</p>
|
53
|
-
<div class="language-js codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
61
|
+
<div class="language-js codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-js codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token function-variable function" style="color:rgb(130, 170, 255)">chainWebpack</span><span class="token operator" style="color:rgb(127, 219, 202)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token parameter">config</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"> </span><span class="token arrow operator" style="color:rgb(127, 219, 202)">=></span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> config</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token property-access">resolve</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token property-access">alias</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token method function property-access" style="color:rgb(130, 170, 255)">set</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string" style="color:rgb(173, 219, 103)">'vue'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">'@vue/compat'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic">// Add this line</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> config</span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token property-access">module</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token method function property-access" style="color:rgb(130, 170, 255)">rule</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string" style="color:rgb(173, 219, 103)">'vue'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token method function property-access" style="color:rgb(130, 170, 255)">use</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string" style="color:rgb(173, 219, 103)">'vue-loader'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">.</span><span class="token method function property-access" style="color:rgb(130, 170, 255)">tap</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token parameter">options</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"> </span><span class="token arrow operator" style="color:rgb(127, 219, 202)">=></span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token keyword control-flow" style="color:rgb(127, 219, 202)">return</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token literal-property property" style="color:rgb(128, 203, 196)">prettify</span><span class="token operator" style="color:rgb(127, 219, 202)">:</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">false</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token literal-property property" style="color:rgb(128, 203, 196)">compilerOptions</span><span class="token operator" style="color:rgb(127, 219, 202)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic">// Add this block</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token literal-property property" style="color:rgb(128, 203, 196)">compatConfig</span><span class="token operator" style="color:rgb(127, 219, 202)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic">//</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token constant" style="color:rgb(130, 170, 255)">MODE</span><span class="token operator" style="color:rgb(127, 219, 202)">:</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">2</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic">//</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic">//</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic">// to here</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><br></span></code></pre></div></div>
|
54
62
|
<h5 class="anchor anchorWithStickyNavbar_fF9Z" id=1c-update-the-eslint-config-file-eslintrc>(1.c) Update the eslint config file (<code>.eslintrc</code>)<a href=#1c-update-the-eslint-config-file-eslintrc class=hash-link aria-label="Direct link to 1c-update-the-eslint-config-file-eslintrc" title="Direct link to 1c-update-the-eslint-config-file-eslintrc"></a></h5>
|
55
63
|
<p>Find the string <code>'plugin:vue/essential'</code> in your <code>extends</code> block and change it to <code>'plugin:vue/vue3-essential'</code>. If you don't have that plugin in your <code>extends</code> block, or you're missing that block entirely, then add this. It will help find breaking changes in how your code is using the Vue API.</p>
|
56
|
-
<div class="language-js codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
64
|
+
<div class="language-js codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-js codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token keyword" style="color:rgb(127, 219, 202)">extends</span><span class="token operator" style="color:rgb(127, 219, 202)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">'plugin:vue/vue3-essential'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic">// change this from plugin:vue/essential</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">'plugin:prettier/recommended'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">'@vue/prettier'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><br></span></code></pre></div></div>
|
57
65
|
<h5 class="anchor anchorWithStickyNavbar_fF9Z" id=1d-fix-build-and-runtime-warnings-and-errors>(1.d) Fix build and runtime warnings and errors<a href=#1d-fix-build-and-runtime-warnings-and-errors class=hash-link aria-label="Direct link to (1.d) Fix build and runtime warnings and errors" title="Direct link to (1.d) Fix build and runtime warnings and errors"></a></h5>
|
58
66
|
<p>Run your linting and build scripts (e.g. <code>yarn lint</code> and <code>yarn build</code>). The eslint plugin and Vue's compat mode will find the first set of code changes you need to address. Fix these lint/build errors until your project builds successfully.</p>
|
59
67
|
<p>Once it builds, run your project like you would for development. It's recommended to serve it from a local dev server with <code>yarn serve</code> and add it to the import map overrides in the browser. Test the functionality of your tool and address any Vue errors and warnings that get printed to the browser console in the dev tools. <em>(NOTE: On <code>MODE: 2</code> - your first pass through this section - it's ok if your tool doesn't completely work yet. Just address the warnings and errors that are logged to the browser console. You'll get your tool completely working in the next step.)</em></p>
|
@@ -63,13 +71,13 @@
|
|
63
71
|
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=step-3-update-vuetify>Step 3: Update Vuetify<a href=#step-3-update-vuetify class=hash-link aria-label="Direct link to Step 3: Update Vuetify" title="Direct link to Step 3: Update Vuetify"></a></h4>
|
64
72
|
<p><em>If you're not using Vuetify, you can skip this step.</em></p>
|
65
73
|
<p>Modify your eslint config (<code>.eslintrc</code>) again to add the Vuetify plugin:</p>
|
66
|
-
<div class="language-js codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
74
|
+
<div class="language-js codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-js codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token keyword" style="color:rgb(127, 219, 202)">extends</span><span class="token operator" style="color:rgb(127, 219, 202)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">'plugin:vue/vue3-essential'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">'plugin:vuetify/base'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic">// Add this line</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">'plugin:prettier/recommended'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">'@vue/prettier'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><br></span></code></pre></div></div>
|
67
75
|
<p><strong>Note:</strong> The Vuetify eslint plugin is only designed for migrating projects from Vuetify 2 to Vuetify 3 and can cause linting performance issues, so it should be removed once your tool migration is complete.</p>
|
68
76
|
<p>Again in <code>.eslintrc</code>, find your <code>parserOptions</code> block and add the <code>parser</code> property above it:</p>
|
69
|
-
<div class="language-js codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
77
|
+
<div class="language-js codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-js codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token literal-property property" style="color:rgb(128, 203, 196)">parser</span><span class="token operator" style="color:rgb(127, 219, 202)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">'vue-eslint-parser'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic">// Add this line</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token literal-property property" style="color:rgb(128, 203, 196)">parserOptions</span><span class="token operator" style="color:rgb(127, 219, 202)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token spread operator" style="color:rgb(127, 219, 202)">...</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><br></span></code></pre></div></div>
|
70
78
|
<p>Now when you run eslint, it can tell you about any changes you'll need to address regarding how your code is using the Vuetify API. To find these changes, run eslint on your Vue files (e.g. <code>yarn eslint . --ext .vue</code>). You can address these manually, or if you trust eslint or have good version control, you can have the plugin fix most of them automatically with <code>yarn eslint . --ext .vue --fix</code></p>
|
71
79
|
<p>Lastly, if you are using the Astro UXDS icons via Vuetify from COSMOS - or any custom icon packs for that matter - then you'll need to change their pack alias format from <code>$packName-</code> to <code>packName:</code>. Here's an example for the <code>antenna-transmit</code> Astro icon:</p>
|
72
|
-
<div class="language-html codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
80
|
+
<div class="language-html codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-html codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"><!-- Vue 2 / Vuetify 2 (old) --></span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token tag punctuation" style="color:rgb(199, 146, 234)"><</span><span class="token tag" style="color:rgb(127, 219, 202)">v-icon</span><span class="token tag punctuation" style="color:rgb(199, 146, 234)">></span><span class="token plain"> $astro-antenna-transmit </span><span class="token tag punctuation" style="color:rgb(199, 146, 234)"></</span><span class="token tag" style="color:rgb(127, 219, 202)">v-icon</span><span class="token tag punctuation" style="color:rgb(199, 146, 234)">></span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain" style=display:inline-block></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"><!-- Vue 3 / Vuetify 3 (new) --></span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token tag punctuation" style="color:rgb(199, 146, 234)"><</span><span class="token tag" style="color:rgb(127, 219, 202)">v-icon</span><span class="token tag punctuation" style="color:rgb(199, 146, 234)">></span><span class="token plain"> astro:antenna-transmit </span><span class="token tag punctuation" style="color:rgb(199, 146, 234)"></</span><span class="token tag" style="color:rgb(127, 219, 202)">v-icon</span><span class="token tag punctuation" style="color:rgb(199, 146, 234)">></span><br></span></code></pre></div></div>
|
73
81
|
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=step-4-clean-up>Step 4: Clean up<a href=#step-4-clean-up class=hash-link aria-label="Direct link to Step 4: Clean up" title="Direct link to Step 4: Clean up"></a></h4>
|
74
82
|
<ul>
|
75
83
|
<li>Remove the <code>@vue/compat</code> and <code>eslint-plugin-vuetify</code> dependencies you added in step 1.a</li>
|
@@ -120,7 +128,7 @@
|
|
120
128
|
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=openc3js-common><code>@openc3/js-common</code><a href=#openc3js-common class=hash-link aria-label="Direct link to openc3js-common" title="Direct link to openc3js-common"></a></h4>
|
121
129
|
<p>This package contains things previously under <code>@openc3/tool-common/src/services</code>. Anything not from that path will be in the <code>vue-common</code> package discussed below.</p>
|
122
130
|
<p>Update any of your imports from that path accordingly. Here's an example:</p>
|
123
|
-
<div class="language-js codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
131
|
+
<div class="language-js codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-js codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic">// COSMOS 5 (old)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token keyword module" style="color:rgb(127, 219, 202)">import</span><span class="token plain"> </span><span class="token imports maybe-class-name">Api</span><span class="token plain"> </span><span class="token keyword module" style="color:rgb(127, 219, 202)">from</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">"@openc3/tool-common/src/services/api"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">;</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token keyword module" style="color:rgb(127, 219, 202)">import</span><span class="token plain"> </span><span class="token imports maybe-class-name">Cable</span><span class="token plain"> </span><span class="token keyword module" style="color:rgb(127, 219, 202)">from</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">"@openc3/tool-common/src/services/cable"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">;</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token keyword module" style="color:rgb(127, 219, 202)">import</span><span class="token plain"> </span><span class="token imports punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token imports"> </span><span class="token imports maybe-class-name">OpenC3Api</span><span class="token imports"> </span><span class="token imports punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token plain"> </span><span class="token keyword module" style="color:rgb(127, 219, 202)">from</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">"@openc3/tool-common/src/services/openc3Api"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">;</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain" style=display:inline-block></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic">// COSMOS 6 (new)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token keyword module" style="color:rgb(127, 219, 202)">import</span><span class="token plain"> </span><span class="token imports punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token imports"> </span><span class="token imports maybe-class-name">Api</span><span class="token imports punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token imports"> </span><span class="token imports maybe-class-name">Cable</span><span class="token imports punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token imports"> </span><span class="token imports maybe-class-name">OpenC3Api</span><span class="token imports"> </span><span class="token imports punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token plain"> </span><span class="token keyword module" style="color:rgb(127, 219, 202)">from</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">"@openc3/js-common/services"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">;</span><br></span></code></pre></div></div>
|
124
132
|
<p>This package also provides a couple more top-level imports which you likely will not need, but they might be useful, so I'll call them out here:</p>
|
125
133
|
<ul>
|
126
134
|
<li>
|
@@ -132,7 +140,7 @@
|
|
132
140
|
</ul>
|
133
141
|
<h4 class="anchor anchorWithStickyNavbar_fF9Z" id=openc3vue-common><code>@openc3/vue-common</code><a href=#openc3vue-common class=hash-link aria-label="Direct link to openc3vue-common" title="Direct link to openc3vue-common"></a></h4>
|
134
142
|
<p>This package provides all the shared Vue components we use to build our first-party tools. The main top-level exports are <code>components</code>, <code>icons</code>, <code>plugins</code>, <code>util</code>, and <code>widgets</code>. There are also some tool-specific exports that we built for code sharing with COSMOS Enterprise, which you might find useful: <code>tool/base</code>, <code>tool/admin</code>, and <code>tool/calendar</code>. Here's an example, but again, reference the pattern mentioned above.</p>
|
135
|
-
<div class="language-js codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
143
|
+
<div class="language-js codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-js codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic">// COSMOS 5 (old)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token keyword module" style="color:rgb(127, 219, 202)">import</span><span class="token plain"> </span><span class="token imports maybe-class-name">DetailsDialog</span><span class="token plain"> </span><span class="token keyword module" style="color:rgb(127, 219, 202)">from</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">"@openc3/tool-common/src/components/DetailsDialog"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">;</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token keyword module" style="color:rgb(127, 219, 202)">import</span><span class="token plain"> </span><span class="token imports maybe-class-name">Graph</span><span class="token plain"> </span><span class="token keyword module" style="color:rgb(127, 219, 202)">from</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">"@openc3/tool-common/src/components/Graph"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">;</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token keyword module" style="color:rgb(127, 219, 202)">import</span><span class="token plain"> </span><span class="token imports maybe-class-name">Notify</span><span class="token plain"> </span><span class="token keyword module" style="color:rgb(127, 219, 202)">from</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">"@openc3/tool-common/src/plugins/notify"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">;</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token keyword module" style="color:rgb(127, 219, 202)">import</span><span class="token plain"> </span><span class="token imports maybe-class-name">TimeFilters</span><span class="token plain"> </span><span class="token keyword module" style="color:rgb(127, 219, 202)">from</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">"@openc3/tool-common/src/tools/base/util/timeFilters"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">;</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token keyword module" style="color:rgb(127, 219, 202)">import</span><span class="token plain"> </span><span class="token imports maybe-class-name">VWidget</span><span class="token plain"> </span><span class="token keyword module" style="color:rgb(127, 219, 202)">from</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">"@openc3/tool-common/src/components/widgets/VWidget"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">;</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain" style=display:inline-block></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic">// COSMOS 6 (new)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token keyword module" style="color:rgb(127, 219, 202)">import</span><span class="token plain"> </span><span class="token imports punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token imports"> </span><span class="token imports maybe-class-name">DetailsDialog</span><span class="token imports punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token imports"> </span><span class="token imports maybe-class-name">Graph</span><span class="token imports"> </span><span class="token imports punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token plain"> </span><span class="token keyword module" style="color:rgb(127, 219, 202)">from</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">"@openc3/vue-common/components"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">;</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token keyword module" style="color:rgb(127, 219, 202)">import</span><span class="token plain"> </span><span class="token imports punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token imports"> </span><span class="token imports maybe-class-name">Notify</span><span class="token imports"> </span><span class="token imports punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token plain"> </span><span class="token keyword module" style="color:rgb(127, 219, 202)">from</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">"@openc3/vue-common/plugins"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">;</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token keyword module" style="color:rgb(127, 219, 202)">import</span><span class="token plain"> </span><span class="token imports punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token imports"> </span><span class="token imports maybe-class-name">TimeFilters</span><span class="token imports"> </span><span class="token imports punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token plain"> </span><span class="token keyword module" style="color:rgb(127, 219, 202)">from</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">"@openc3/vue-common/util"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">;</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token keyword module" style="color:rgb(127, 219, 202)">import</span><span class="token plain"> </span><span class="token imports punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token imports"> </span><span class="token imports maybe-class-name">VWidget</span><span class="token imports"> </span><span class="token imports punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token plain"> </span><span class="token keyword module" style="color:rgb(127, 219, 202)">from</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">"@openc3/vue-common/widgets"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">;</span><br></span></code></pre></div></div>
|
136
144
|
<h2 class="anchor anchorWithStickyNavbar_fF9Z" id=migrating-from-cosmos-4-to-cosmos-5>Migrating From COSMOS 4 to COSMOS 5<a href=#migrating-from-cosmos-4-to-cosmos-5 class=hash-link aria-label="Direct link to Migrating From COSMOS 4 to COSMOS 5" title="Direct link to Migrating From COSMOS 4 to COSMOS 5"></a></h2>
|
137
145
|
<div class="theme-admonition theme-admonition-info admonition_IZjC alert alert--info"><div class=admonitionHeading_uVvU><span class=admonitionIcon_HiR3><svg viewBox="0 0 14 16"><path fill-rule=evenodd d="M7 2.3c3.14 0 5.7 2.56 5.7 5.7s-2.56 5.7-5.7 5.7A5.71 5.71 0 0 1 1.3 8c0-3.14 2.56-5.7 5.7-5.7zM7 1C3.14 1 0 4.14 0 8s3.14 7 7 7 7-3.14 7-7-3.14-7-7-7zm1 3H6v5h2V4zm0 6H6v2h2v-2z"/></svg></span>All COSMOS Users</div><div class=admonitionContent_bl22><p>All COSMOS 4 users must upgrade their configuration to 5. However, the command, telemetry and screen definitions (keywords and syntax) have remained the same.</div></div>
|
138
146
|
<p>COSMOS 5 is a new architecture and treats targets as independent <a href=/tools/staticdocs/docs/configuration/plugins>plugins</a>. Thus the primary effort in porting from COSMOS 4 to COSMOS 5 is converting targets to plugins. We recommend creating plugins for each independent target (with its own interface) but targets which share an interface will need to be part of the same plugin. The reason for independent plugins is it allows the plugin to be versioned separately and more easily shared outside your specific project. If you have very project specific targets (e.g. custom hardware) those can potentially be combined for ease of deployment.</p>
|
@@ -141,9 +149,9 @@
|
|
141
149
|
<ol>
|
142
150
|
<li>
|
143
151
|
<p>Change to the existing COSMOS 4 configuration directory. You should see the config, lib, procedures, outputs directory. You can then run the migration tool by specifying the absolute path to the COSMOS 5 installation.</p>
|
144
|
-
<div class="language-batch codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
152
|
+
<div class="language-batch codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-batch codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">C:\COSMOS> C:\cosmos-project\openc3.bat cli migrate -a demo</span><br></span></code></pre></div></div>
|
145
153
|
<p>This creates a new COSMOS 5 plugin called openc3-cosmos-demo with a target named DEMO containing the existing lib and procedures files as well as all the existing targets.</p>
|
146
|
-
<div class="language-batch codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=
|
154
|
+
<div class="language-batch codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-batch codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">C:\COSMOS> C:\cosmos-project\openc3.bat cli migrate demo-part INST</span><br></span></code></pre></div></div>
|
147
155
|
<p>This would create a new COSMOS 5 plugin called openc3-cosmos-demo-part with a target named DEMO_PART containing the existing lib and procedures files as well as the INST target (but no others).</p>
|
148
156
|
</li>
|
149
157
|
<li>
|
@@ -155,4 +163,4 @@
|
|
155
163
|
</ol>
|
156
164
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=upgrading-custom-tools>Upgrading Custom Tools<a href=#upgrading-custom-tools class=hash-link aria-label="Direct link to Upgrading Custom Tools" title="Direct link to Upgrading Custom Tools"></a></h3>
|
157
165
|
<p>COSMOS 4 was a Qt Desktop based application. COSMOS 5 is a completely new architecture which runs natively in the browser using <a href=https://vuejs.org/ target=_blank rel="noopener noreferrer">Vue.js</a> as the Javascript framework and <a href=https://vuetifyjs.com/en/ target=_blank rel="noopener noreferrer">Vuetify</a> as the GUI library. We utilize <a href=https://single-spa.js.org/ target=_blank rel="noopener noreferrer">single-spa</a> to allow you to write COSMOS tool plugins in any language and provide <a href=https://github.com/OpenC3/cosmos/tree/main/openc3/templates target=_blank rel="noopener noreferrer">templates</a> for Vue.js (recommended), Angular, React and Svelte. Any COSMOS 4 custom tools will have to be completely re-written to run in COSMOS 5. We recommend using the native COSMOS <a href=https://github.com/OpenC3/cosmos/tree/main/openc3-cosmos-init/plugins/packages target=_blank rel="noopener noreferrer">tools</a> and finding GUI concepts and functionality that best match the tool you're trying to re-create.</p>
|
158
|
-
<p>If you need custom development get in touch at <a href=mailto:sales@openc3.com target=_blank rel="noopener noreferrer">sales@openc3.com</a>.</div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class=col><a href=https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/getting-started/upgrading.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"/></g></svg>Edit this page</a></div><div class="col lastUpdated_g62E"></div></div></footer></article><nav class="
|
166
|
+
<p>If you need custom development get in touch at <a href=mailto:sales@openc3.com target=_blank rel="noopener noreferrer">sales@openc3.com</a>.</div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class=col><a href=https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/getting-started/upgrading.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"/></g></svg>Edit this page</a></div><div class="col lastUpdated_g62E"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href=/tools/staticdocs/docs/getting-started/gettingstarted><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/cli><div class=pagination-nav__sublabel>Next</div><div class=pagination-nav__label>Command Line Interface</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=#cosmos-upgrades class="table-of-contents__link toc-highlight">COSMOS Upgrades</a><ul><li><a href=#upgrade-migration-process class="table-of-contents__link toc-highlight">Upgrade Migration Process</a></ul><li><a href=#migrating-from-cosmos-5-to-cosmos-6 class="table-of-contents__link toc-highlight">Migrating From COSMOS 5 to COSMOS 6</a><ul><li><a href=#updating-vue class="table-of-contents__link toc-highlight">Updating Vue</a><ul><li><a href=#the-quick-and-dirty-way class="table-of-contents__link toc-highlight">The quick and dirty way</a><li><a href=#step-1-vue-compat-mode class="table-of-contents__link toc-highlight">Step 1: Vue compat mode</a><ul><li><a href=#1a-update-dependencies class="table-of-contents__link toc-highlight">(1.a) Update dependencies</a><li><a href=#1b-update-the-vue-config-file-vueconfigjs class="table-of-contents__link toc-highlight">(1.b) Update the Vue config file (<code>vue.config.js</code>)</a><li><a href=#1c-update-the-eslint-config-file-eslintrc class="table-of-contents__link toc-highlight">(1.c) Update the eslint config file (<code>.eslintrc</code>)</a><li><a href=#1d-fix-build-and-runtime-warnings-and-errors class="table-of-contents__link toc-highlight">(1.d) Fix build and runtime warnings and errors</a></ul><li><a href=#step-2-bump-compat-mode-from-2-to-3 class="table-of-contents__link toc-highlight">Step 2: Bump compat mode from 2 to 3</a><li><a href=#step-3-update-vuetify class="table-of-contents__link toc-highlight">Step 3: Update Vuetify</a><li><a href=#step-4-clean-up class="table-of-contents__link toc-highlight">Step 4: Clean up</a></ul><li><a href=#migrating-to-the-new-openc3-common-packages class="table-of-contents__link toc-highlight">Migrating to the new OpenC3 common packages</a><ul><li><a href=#step-1-update-dependencies class="table-of-contents__link toc-highlight">Step 1: Update dependencies</a><li><a href=#step-2-update-imports-in-your-code class="table-of-contents__link toc-highlight">Step 2: Update imports in your code</a><li><a href=#openc3js-common class="table-of-contents__link toc-highlight"><code>@openc3/js-common</code></a><li><a href=#openc3vue-common class="table-of-contents__link toc-highlight"><code>@openc3/vue-common</code></a></ul></ul><li><a href=#migrating-from-cosmos-4-to-cosmos-5 class="table-of-contents__link toc-highlight">Migrating From COSMOS 4 to COSMOS 5</a><ul><li><a href=#configuration-migration-tool class="table-of-contents__link toc-highlight">Configuration Migration Tool</a><li><a href=#upgrading-custom-tools class="table-of-contents__link toc-highlight">Upgrading Custom Tools</a></ul></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column 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></ul></div><div class="theme-layout-footer-column 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></ul></div><div class="theme-layout-footer-column 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 class=iconExternalLink_awgD><use href=#theme-svg-external-link /></svg></a></ul></div><div class="theme-layout-footer-column 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 class=iconExternalLink_awgD><use href=#theme-svg-external-link /></svg></a><li class=footer__item><a class=footer__link-item href=/tools/staticdocs/docs/privacy>Privacy</a></ul></div></div><div class="footer__bottom text--center"><div class=footer__copyright>Copyright © 2025 OpenC3, Inc.</div></div></div></footer></div>
|
@@ -1 +1,4 @@
|
|
1
|
-
<!doctype html><html lang=en dir=ltr class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page" data-has-hydrated=false><meta charset=UTF-8><meta name=generator content="Docusaurus v3.7.0"><title data-rh=true>Getting Started | OpenC3 Docs</title><meta data-rh=true name=viewport content="width=device-width, initial-scale=1.0"><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><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="Get started with OpenC3 COSMOS"><meta data-rh=true property=og:description content="Get started with 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><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/getting-started hreflang=en><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/getting-started hreflang=x-default><link rel=stylesheet href=/tools/staticdocs/assets/css/styles.1de6b959.css><script src=/tools/staticdocs/assets/js/runtime~main.3629ffb4.js defer></script><script src=/tools/staticdocs/assets/js/main.b1edeb65.js defer></script><body class=navigation-with-keyboard><script>!function(){var t,e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();t=null!==e?e:"dark",document.documentElement.setAttribute("data-theme",t)}(),function(){try{for(var[t,e]of new URLSearchParams(window.location.search).entries())if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id=__docusaurus><link rel=preload as=image href=/tools/staticdocs/img/logo.svg><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"/></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 class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible menu__list-item-collapsible--active"><a class="menu__link menu__link--sublist menu__link--active" aria-current=page href=/tools/staticdocs/docs/getting-started>Getting Started</a><button aria-label="Collapse sidebar category 'Getting Started'" aria-expanded=true 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/key-concepts>Key Concepts</a><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 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 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 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/cli>Command Line Interface</a><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 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 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></ul><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" href=/tools/staticdocs/docs/configuration>Configuration</a><button aria-label="Expand sidebar category 'Configuration'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><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" href=/tools/staticdocs/docs/tools>Tools</a><button aria-label="Expand sidebar category 'Tools'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><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" href=/tools/staticdocs/docs/guides>Guides</a><button aria-label="Expand sidebar category 'Guides'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><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" href=/tools/staticdocs/docs/development>Development</a><button aria-label="Expand sidebar category 'Development'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><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" href=/tools/staticdocs/docs/meta>Meta</a><button aria-label="Expand sidebar category 'Meta'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><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></ul></nav></div></div></aside><main class=docMainContainer_namt><div class="container padding-top--md padding-bottom--lg"><div class=generatedIndexPage_ak01><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 /></svg></a><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=1></ul></nav><header><h1 class=title_AulG>Getting Started</h1><p>Get started with OpenC3 COSMOS</header><article class=margin-top--lg><section class="row list_iQEt"><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/getting-started/key-concepts><h2 class="text--truncate cardTitle_HoSo" title="Key Concepts">💡<!-- --> <!-- -->Key Concepts</h2><p class="text--truncate cardDescription_c27F" title="Projects, Containerization, Frontend, Backend">Projects, Containerization, Frontend, Backend</p></a></article><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/getting-started/installation><h2 class="text--truncate cardTitle_HoSo" title=Installation>💾<!-- --> <!-- -->Installation</h2><p class="text--truncate cardDescription_c27F" title="Installing OpenC3 COSMOS">Installing OpenC3 COSMOS</p></a></article><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/getting-started/gettingstarted><h2 class="text--truncate cardTitle_HoSo" title="Getting Started">🧑💻<!-- --> <!-- -->Getting Started</h2><p class="text--truncate cardDescription_c27F" title="Getting starting with COSMOS">Getting starting with COSMOS</p></a></article><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/getting-started/upgrading><h2 class="text--truncate cardTitle_HoSo" title=Upgrading>⬆️<!-- --> <!-- -->Upgrading</h2><p class="text--truncate cardDescription_c27F" title="How to upgrade and migrate COSMOS">How to upgrade and migrate COSMOS</p></a></article><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/getting-started/cli><h2 class="text--truncate cardTitle_HoSo" title="Command Line Interface">⌨️<!-- --> <!-- -->Command Line Interface</h2><p class="text--truncate cardDescription_c27F" title="Using openc3.sh">Using openc3.sh</p></a></article><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/getting-started/generators><h2 class="text--truncate cardTitle_HoSo" title="Code Generators">🏭<!-- --> <!-- -->Code Generators</h2><p class="text--truncate cardDescription_c27F" title="Using openc3.sh to generate code">Using openc3.sh to generate code</p></a></article><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/getting-started/podman><h2 class="text--truncate cardTitle_HoSo" title=Podman>🫛<!-- --> <!-- -->Podman</h2><p class="text--truncate cardDescription_c27F" title="Installing and running COSMOS with Podman">Installing and running COSMOS with Podman</p></a></article><article class="col col--6 margin-bottom--lg"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/getting-started/requirements><h2 class="text--truncate cardTitle_HoSo" title="Requirements and Design">📑<!-- --> <!-- -->Requirements and Design</h2><p class="text--truncate cardDescription_c27F" title="COSMOS Requirements and Design">COSMOS Requirements and Design</p></a></article></section></article><footer class=margin-top--lg><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href=/tools/staticdocs/docs><div class=pagination-nav__sublabel>Previous</div><div class=pagination-nav__label>Introduction</div></a><a class="pagination-nav__link pagination-nav__link--next" href=/tools/staticdocs/docs/getting-started/key-concepts><div class=pagination-nav__sublabel>Next</div><div class=pagination-nav__label>Key Concepts</div></a></nav></footer></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></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></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"/></svg></a></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"/></svg></a><li class=footer__item><a class=footer__link-item href=/tools/staticdocs/docs/privacy>Privacy</a></ul></div></div><div class="footer__bottom text--center"><div class=footer__copyright>Copyright © 2025 OpenC3, Inc.</div></div></div></footer></div>
|
1
|
+
<!doctype html><html lang=en dir=ltr class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page" data-has-hydrated=false><meta charset=UTF-8><meta name=generator content="Docusaurus v3.8.0"><title data-rh=true>Getting Started | OpenC3 Docs</title><meta data-rh=true name=viewport content="width=device-width, initial-scale=1.0"><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><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="Get started with OpenC3 COSMOS"><meta data-rh=true property=og:description content="Get started with 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><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/getting-started hreflang=en><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/getting-started hreflang=x-default><script data-rh=true type=application/ld+json>{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","item":"https://docs.openc3.com/tools/staticdocs/docs/getting-started","name":"Getting Started","position":1}]}</script><link rel=stylesheet href=/tools/staticdocs/assets/css/styles.1a361da6.css><script src=/tools/staticdocs/assets/js/runtime~main.ca894d1e.js defer></script><script src=/tools/staticdocs/assets/js/main.ba1fa268.js defer></script><body class=navigation-with-keyboard><svg xmlns=http://www.w3.org/2000/svg style="display: none;"><defs>
|
2
|
+
<symbol id=theme-svg-external-link viewBox="0 0 24 24"><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"/></symbol>
|
3
|
+
</defs></svg>
|
4
|
+
<script>!function(){var t="dark",e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();document.documentElement.setAttribute("data-theme",e||t),document.documentElement.setAttribute("data-theme-choice",e||t)}(),function(){try{for(var[t,e]of new URLSearchParams(window.location.search).entries())if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id=__docusaurus><link rel=preload as=image href=/tools/staticdocs/img/logo.svg><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="theme-layout-navbar navbar navbar--fixed-top"><div class=navbar__inner><div class="theme-layout-navbar-left 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"/></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="theme-layout-navbar-right 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="theme-layout-main 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 class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible menu__list-item-collapsible--active"><a class="menu__link menu__link--sublist menu__link--active" aria-current=page href=/tools/staticdocs/docs/getting-started>Getting Started</a><button aria-label="Collapse sidebar category 'Getting Started'" aria-expanded=true type=button class="clean-btn menu__caret"></button></div><ul 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/key-concepts>Key Concepts</a><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 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 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 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/cli>Command Line Interface</a><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 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 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></ul><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" href=/tools/staticdocs/docs/configuration>Configuration</a><button aria-label="Expand sidebar category 'Configuration'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><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" href=/tools/staticdocs/docs/tools>Tools</a><button aria-label="Expand sidebar category 'Tools'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><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" href=/tools/staticdocs/docs/guides>Guides</a><button aria-label="Expand sidebar category 'Guides'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><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" href=/tools/staticdocs/docs/development>Development</a><button aria-label="Expand sidebar category 'Development'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><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" href=/tools/staticdocs/docs/meta>Meta</a><button aria-label="Expand sidebar category 'Meta'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><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></ul></nav></div></div></aside><main class=docMainContainer_namt><div class="container padding-top--md padding-bottom--lg"><div class=generatedIndexPage_ak01><nav class="theme-doc-breadcrumbs breadcrumbsContainer_zCmv" aria-label=Breadcrumbs><ul class=breadcrumbs><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 /></svg></a><li class="breadcrumbs__item breadcrumbs__item--active"><span class=breadcrumbs__link>Getting Started</span></ul></nav><header><h1 class=title_AulG>Getting Started</h1><p>Get started with OpenC3 COSMOS</header><article class=margin-top--lg><section class=row><article class="docCardListItem_h8oi col col--6"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/getting-started/key-concepts><h2 class="text--truncate cardTitle_HoSo" title="Key Concepts">💡<!-- --> <!-- -->Key Concepts</h2><p class="text--truncate cardDescription_c27F" title="Projects, Containerization, Frontend, Backend">Projects, Containerization, Frontend, Backend</p></a></article><article class="docCardListItem_h8oi col col--6"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/getting-started/installation><h2 class="text--truncate cardTitle_HoSo" title=Installation>💾<!-- --> <!-- -->Installation</h2><p class="text--truncate cardDescription_c27F" title="Installing OpenC3 COSMOS">Installing OpenC3 COSMOS</p></a></article><article class="docCardListItem_h8oi col col--6"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/getting-started/gettingstarted><h2 class="text--truncate cardTitle_HoSo" title="Getting Started">🧑💻<!-- --> <!-- -->Getting Started</h2><p class="text--truncate cardDescription_c27F" title="Getting starting with COSMOS">Getting starting with COSMOS</p></a></article><article class="docCardListItem_h8oi col col--6"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/getting-started/upgrading><h2 class="text--truncate cardTitle_HoSo" title=Upgrading>⬆️<!-- --> <!-- -->Upgrading</h2><p class="text--truncate cardDescription_c27F" title="How to upgrade and migrate COSMOS">How to upgrade and migrate COSMOS</p></a></article><article class="docCardListItem_h8oi col col--6"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/getting-started/cli><h2 class="text--truncate cardTitle_HoSo" title="Command Line Interface">⌨️<!-- --> <!-- -->Command Line Interface</h2><p class="text--truncate cardDescription_c27F" title="Using openc3.sh">Using openc3.sh</p></a></article><article class="docCardListItem_h8oi col col--6"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/getting-started/generators><h2 class="text--truncate cardTitle_HoSo" title="Code Generators">🏭<!-- --> <!-- -->Code Generators</h2><p class="text--truncate cardDescription_c27F" title="Using openc3.sh to generate code">Using openc3.sh to generate code</p></a></article><article class="docCardListItem_h8oi col col--6"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/getting-started/podman><h2 class="text--truncate cardTitle_HoSo" title=Podman>🫛<!-- --> <!-- -->Podman</h2><p class="text--truncate cardDescription_c27F" title="Installing and running COSMOS with Podman">Installing and running COSMOS with Podman</p></a></article><article class="docCardListItem_h8oi col col--6"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/getting-started/requirements><h2 class="text--truncate cardTitle_HoSo" title="Requirements and Design">📑<!-- --> <!-- -->Requirements and Design</h2><p class="text--truncate cardDescription_c27F" title="COSMOS Requirements and Design">COSMOS Requirements and Design</p></a></article></section></article><footer class=margin-top--md><nav class=pagination-nav aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href=/tools/staticdocs/docs><div class=pagination-nav__sublabel>Previous</div><div class=pagination-nav__label>Introduction</div></a><a class="pagination-nav__link pagination-nav__link--next" href=/tools/staticdocs/docs/getting-started/key-concepts><div class=pagination-nav__sublabel>Next</div><div class=pagination-nav__label>Key Concepts</div></a></nav></footer></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column 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></ul></div><div class="theme-layout-footer-column 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></ul></div><div class="theme-layout-footer-column 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 class=iconExternalLink_awgD><use href=#theme-svg-external-link /></svg></a></ul></div><div class="theme-layout-footer-column 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 class=iconExternalLink_awgD><use href=#theme-svg-external-link /></svg></a><li class=footer__item><a class=footer__link-item href=/tools/staticdocs/docs/privacy>Privacy</a></ul></div></div><div class="footer__bottom text--center"><div class=footer__copyright>Copyright © 2025 OpenC3, Inc.</div></div></div></footer></div>
|