openc3-cosmos-tool-docs 5.16.1 → 5.16.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (109) hide show
  1. checksums.yaml +4 -4
  2. data/tools/staticdocs/404.html +4 -4
  3. data/tools/staticdocs/assets/css/styles.8a0f1b26.css +1 -0
  4. data/tools/staticdocs/assets/js/{0f5d161c.dda04dbb.js → 0f5d161c.3dbf9f60.js} +1 -1
  5. data/tools/staticdocs/assets/js/3b6e6f8d.3eef0a1d.js +1 -0
  6. data/tools/staticdocs/assets/js/{42170351.15f2f1e3.js → 42170351.24db3d9a.js} +1 -1
  7. data/tools/staticdocs/assets/js/4650.292aca67.js +1 -0
  8. data/tools/staticdocs/assets/js/5e3ed378.77db7b87.js +1 -0
  9. data/tools/staticdocs/assets/js/{2923e883.ed90d0a7.js → 75897369.7b31b03e.js} +1 -1
  10. data/tools/staticdocs/assets/js/767ae34d.4ab04b1e.js +1 -0
  11. data/tools/staticdocs/assets/js/adf499b4.f7df5738.js +1 -0
  12. data/tools/staticdocs/assets/js/{d797a795.5725bf2b.js → c5388ca4.f526bb0c.js} +1 -1
  13. data/tools/staticdocs/assets/js/ca2c0ac4.adbecf86.js +1 -0
  14. data/tools/staticdocs/assets/js/{d1b923aa.e7ee188a.js → d1b923aa.dcb1dede.js} +1 -1
  15. data/tools/staticdocs/assets/js/d1bfc316.feddf1f3.js +1 -0
  16. data/tools/staticdocs/assets/js/d394346f.e3f500eb.js +1 -0
  17. data/tools/staticdocs/assets/js/d52d6961.1d15c902.js +1 -0
  18. data/tools/staticdocs/assets/js/dc5f7beb.291f4b91.js +1 -0
  19. data/tools/staticdocs/assets/js/eb3c311a.1b6ccdde.js +1 -0
  20. data/tools/staticdocs/assets/js/fd886806.dc7cdf8e.js +1 -0
  21. data/tools/staticdocs/assets/js/main.eec2a1b0.js +2 -0
  22. data/tools/staticdocs/assets/js/runtime~main.14022dc5.js +1 -0
  23. data/tools/staticdocs/docs/configuration/command.html +6 -6
  24. data/tools/staticdocs/docs/configuration/format.html +6 -6
  25. data/tools/staticdocs/docs/configuration/interfaces.html +6 -6
  26. data/tools/staticdocs/docs/configuration/plugins.html +6 -6
  27. data/tools/staticdocs/docs/configuration/protocols.html +6 -6
  28. data/tools/staticdocs/docs/configuration/ssl-tls.html +6 -6
  29. data/tools/staticdocs/docs/configuration/table.html +6 -6
  30. data/tools/staticdocs/docs/configuration/target.html +6 -6
  31. data/tools/staticdocs/docs/configuration/telemetry-screens.html +6 -6
  32. data/tools/staticdocs/docs/configuration/telemetry.html +6 -6
  33. data/tools/staticdocs/docs/configuration.html +5 -5
  34. data/tools/staticdocs/docs/development/curl.html +6 -6
  35. data/tools/staticdocs/docs/development/developing.html +6 -6
  36. data/tools/staticdocs/docs/development/host-install.html +6 -6
  37. data/tools/staticdocs/docs/development/json-api.html +6 -6
  38. data/tools/staticdocs/docs/development/log-structure.html +6 -6
  39. data/tools/staticdocs/docs/development/roadmap.html +6 -6
  40. data/tools/staticdocs/docs/development/streaming-api.html +6 -6
  41. data/tools/staticdocs/docs/development/testing.html +6 -6
  42. data/tools/staticdocs/docs/development.html +5 -5
  43. data/tools/staticdocs/docs/getting-started/generators.html +6 -6
  44. data/tools/staticdocs/docs/getting-started/gettingstarted.html +6 -6
  45. data/tools/staticdocs/docs/getting-started/installation.html +6 -6
  46. data/tools/staticdocs/docs/getting-started/key_concepts.html +6 -6
  47. data/tools/staticdocs/docs/getting-started/podman.html +6 -6
  48. data/tools/staticdocs/docs/getting-started/requirements.html +6 -6
  49. data/tools/staticdocs/docs/getting-started/upgrading.html +6 -6
  50. data/tools/staticdocs/docs/getting-started.html +5 -5
  51. data/tools/staticdocs/docs/guides/bridges.html +6 -6
  52. data/tools/staticdocs/docs/guides/cfs.html +6 -6
  53. data/tools/staticdocs/docs/guides/custom-widgets.html +6 -6
  54. data/tools/staticdocs/docs/guides/little-endian-bitfields.html +6 -6
  55. data/tools/staticdocs/docs/guides/local-mode.html +6 -6
  56. data/tools/staticdocs/docs/guides/logging.html +6 -6
  57. data/tools/staticdocs/docs/guides/monitoring.html +6 -6
  58. data/tools/staticdocs/docs/guides/performance.html +7 -6
  59. data/tools/staticdocs/docs/guides/raspberrypi.html +6 -6
  60. data/tools/staticdocs/docs/guides/script-writing.html +19 -16
  61. data/tools/staticdocs/docs/guides/scripting-api.html +6 -6
  62. data/tools/staticdocs/docs/guides.html +5 -5
  63. data/tools/staticdocs/docs/meta/contributing.html +6 -6
  64. data/tools/staticdocs/docs/meta/licenses.html +6 -6
  65. data/tools/staticdocs/docs/meta/philosophy.html +6 -6
  66. data/tools/staticdocs/docs/meta/xtce.html +6 -6
  67. data/tools/staticdocs/docs/meta.html +5 -5
  68. data/tools/staticdocs/docs/privacy.html +6 -6
  69. data/tools/staticdocs/docs/tools/autonomic.html +6 -6
  70. data/tools/staticdocs/docs/tools/bucket-explorer.html +6 -6
  71. data/tools/staticdocs/docs/tools/calendar.html +6 -6
  72. data/tools/staticdocs/docs/tools/cmd-sender.html +6 -6
  73. data/tools/staticdocs/docs/tools/cmd-tlm-server.html +6 -6
  74. data/tools/staticdocs/docs/tools/data-extractor.html +6 -6
  75. data/tools/staticdocs/docs/tools/data-viewer.html +6 -6
  76. data/tools/staticdocs/docs/tools/handbooks.html +6 -6
  77. data/tools/staticdocs/docs/tools/limits-monitor.html +6 -6
  78. data/tools/staticdocs/docs/tools/packet-viewer.html +6 -6
  79. data/tools/staticdocs/docs/tools/script-runner.html +9 -9
  80. data/tools/staticdocs/docs/tools/table-manager.html +6 -6
  81. data/tools/staticdocs/docs/tools/tlm-grapher.html +6 -6
  82. data/tools/staticdocs/docs/tools/tlm-viewer.html +6 -6
  83. data/tools/staticdocs/docs/tools.html +5 -5
  84. data/tools/staticdocs/docs.html +6 -6
  85. data/tools/staticdocs/index.html +4 -4
  86. data/tools/staticdocs/lunr-index-1716490741709.json +1 -0
  87. data/tools/staticdocs/lunr-index.json +1 -1
  88. data/tools/staticdocs/markdown-page.html +4 -4
  89. data/tools/staticdocs/search-doc-1716490741709.json +1 -0
  90. data/tools/staticdocs/search-doc.json +1 -1
  91. metadata +25 -25
  92. data/tools/staticdocs/assets/css/styles.a9c55efa.css +0 -1
  93. data/tools/staticdocs/assets/js/07876b9c.b8d12431.js +0 -1
  94. data/tools/staticdocs/assets/js/1b2b4b61.2556cd65.js +0 -1
  95. data/tools/staticdocs/assets/js/3df159b4.ff98bfab.js +0 -1
  96. data/tools/staticdocs/assets/js/55cdbca5.695875ea.js +0 -1
  97. data/tools/staticdocs/assets/js/5e3ed378.91d6735f.js +0 -1
  98. data/tools/staticdocs/assets/js/64630c4f.a229ae1d.js +0 -1
  99. data/tools/staticdocs/assets/js/75373ac0.6a0a4fa2.js +0 -1
  100. data/tools/staticdocs/assets/js/7918.25ec42db.js +0 -1
  101. data/tools/staticdocs/assets/js/99b59eea.d4dd9989.js +0 -1
  102. data/tools/staticdocs/assets/js/d1bfc316.963c2477.js +0 -1
  103. data/tools/staticdocs/assets/js/dc5f7beb.88b0f00b.js +0 -1
  104. data/tools/staticdocs/assets/js/fd886806.57eeb84b.js +0 -1
  105. data/tools/staticdocs/assets/js/main.1b0c8317.js +0 -2
  106. data/tools/staticdocs/assets/js/runtime~main.49989116.js +0 -1
  107. data/tools/staticdocs/lunr-index-1715219995308.json +0 -1
  108. data/tools/staticdocs/search-doc-1715219995308.json +0 -1
  109. /data/tools/staticdocs/assets/js/{main.1b0c8317.js.LICENSE.txt → main.eec2a1b0.js.LICENSE.txt} +0 -0
data/tools/staticdocs/docs/configuration/plugins.html CHANGED
@@ -2,13 +2,13 @@
2
2
  <html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-configuration/plugins" data-has-hydrated="false">
3
3
  <head>
4
4
  <meta charset="UTF-8">
5
- <meta name="generator" content="Docusaurus v3.1.0">
6
- <title data-rh="true">Plugins | OpenC3 Docs</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.openc3.com/tools/staticdocs/docs/configuration/plugins"><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="Plugins | OpenC3 Docs"><meta data-rh="true" name="description" content="Introduction"><meta data-rh="true" property="og:description" content="Introduction"><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/configuration/plugins"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/configuration/plugins" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/configuration/plugins" hreflang="x-default"><link rel="stylesheet" href="/tools/staticdocs/assets/css/styles.a9c55efa.css">
7
- <script src="/tools/staticdocs/assets/js/runtime~main.49989116.js" defer="defer"></script>
8
- <script src="/tools/staticdocs/assets/js/main.1b0c8317.js" defer="defer"></script>
5
+ <meta name="generator" content="Docusaurus v3.3.2">
6
+ <title data-rh="true">Plugins | OpenC3 Docs</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.openc3.com/tools/staticdocs/docs/configuration/plugins"><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="Plugins | OpenC3 Docs"><meta data-rh="true" name="description" content="Introduction"><meta data-rh="true" property="og:description" content="Introduction"><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/configuration/plugins"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/configuration/plugins" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/configuration/plugins" hreflang="x-default"><link rel="stylesheet" href="/tools/staticdocs/assets/css/styles.8a0f1b26.css">
7
+ <script src="/tools/staticdocs/assets/js/runtime~main.14022dc5.js" defer="defer"></script>
8
+ <script src="/tools/staticdocs/assets/js/main.eec2a1b0.js" defer="defer"></script>
9
9
  </head>
10
10
  <body class="navigation-with-keyboard">
11
- <script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return localStorage.getItem("theme")}catch(t){}}();t(null!==e?e:"dark")}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_G6ar" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/tools/staticdocs/"><div class="navbar__logo"><img src="/tools/staticdocs/img/logo.svg" alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--light_DIHH"><img src="/tools/staticdocs/img/logo.svg" alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--dark_Bv2M"></div><b class="navbar__title text--truncate">OpenC3 Docs</b></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/tools/staticdocs/docs">Documentation</a><a href="https://openc3.com/enterprise/" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Enterprise</a></div><div class="navbar__items navbar__items--right"><div class="navbarSearchContainer_bmvg"><div class="navbar__search"><span aria-label="expand searchbar" role="button" class="search-icon" tabindex="0"></span><input id="search_input_react" type="search" placeholder="Loading..." aria-label="Search" class="navbar__search-input search-bar" disabled=""></div></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_UyTV"><div class="docsWrapper_XLvK"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_z1FD" type="button"></button><div class="docRoot_HciC"><aside class="theme-doc-sidebar-container docSidebarContainer_e5ai"><div class="sidebarViewport_N8x0"><div class="sidebar_vJCc"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_qiME"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/tools/staticdocs/docs">Introduction</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/getting-started">Getting Started</a><button aria-label="Expand sidebar category &#x27;Getting Started&#x27;" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--active" aria-expanded="true" href="/tools/staticdocs/docs/configuration">Configuration</a><button aria-label="Collapse sidebar category &#x27;Configuration&#x27;" 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/configuration/format">File Format</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/tools/staticdocs/docs/configuration/plugins">Plugins</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/target">Targets</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/command">Commands</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/telemetry">Telemetry</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/interfaces">Interfaces</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/protocols">Protocols</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/table">Tables</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/telemetry-screens">Screens</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/ssl-tls">SSL-TLS</a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/tools">Tools</a><button aria-label="Expand sidebar category &#x27;Tools&#x27;" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/guides">Guides</a><button aria-label="Expand sidebar category &#x27;Guides&#x27;" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/development">Development</a><button aria-label="Expand sidebar category &#x27;Development&#x27;" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/meta">Meta</a><button aria-label="Expand sidebar category &#x27;Meta&#x27;" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/tools/staticdocs/docs/privacy">OpenC3, Inc. Privacy Policy</a></li></ul></nav></div></div></aside><main class="docMainContainer_namt"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_YAwJ"><div class="docItemContainer_Rv5Z"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_zCmv" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/tools/staticdocs/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_JFrk"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item"><a class="breadcrumbs__link" itemprop="item" href="/tools/staticdocs/docs/configuration"><span itemprop="name">Configuration</span></a><meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Plugins</span><meta itemprop="position" content="2"></li></ul></nav><div class="tocCollapsible_O_Qc theme-doc-toc-mobile tocMobile_tjDr"><button type="button" class="clean-btn tocCollapsibleButton_htYj">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Plugins</h1></header><h2 id="introduction">Introduction</h2>
11
+ <script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return localStorage.getItem("theme")}catch(t){}}();t(null!==e?e:"dark")}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_G6ar" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/tools/staticdocs/"><div class="navbar__logo"><img src="/tools/staticdocs/img/logo.svg" alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--light_DIHH"><img src="/tools/staticdocs/img/logo.svg" alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--dark_Bv2M"></div><b class="navbar__title text--truncate">OpenC3 Docs</b></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/tools/staticdocs/docs">Documentation</a><a href="https://openc3.com/enterprise/" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Enterprise</a></div><div class="navbar__items navbar__items--right"><div class="navbarSearchContainer_bmvg"><div class="navbar__search"><span aria-label="expand searchbar" role="button" class="search-icon" tabindex="0"></span><input id="search_input_react" type="search" placeholder="Loading..." aria-label="Search" class="navbar__search-input search-bar" disabled=""></div></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_UyTV"><div class="docsWrapper_XLvK"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_z1FD" type="button"></button><div class="docRoot_HciC"><aside class="theme-doc-sidebar-container docSidebarContainer_e5ai"><div class="sidebarViewport_N8x0"><div class="sidebar_vJCc"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_qiME"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/tools/staticdocs/docs">Introduction</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/tools/staticdocs/docs/getting-started">Getting Started</a><button aria-label="Expand sidebar category &#x27;Getting Started&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--active" href="/tools/staticdocs/docs/configuration">Configuration</a><button aria-label="Collapse sidebar category &#x27;Configuration&#x27;" 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/configuration/format">File Format</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/tools/staticdocs/docs/configuration/plugins">Plugins</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/target">Targets</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/command">Commands</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/telemetry">Telemetry</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/interfaces">Interfaces</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/protocols">Protocols</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/table">Tables</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/telemetry-screens">Screens</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/ssl-tls">SSL-TLS</a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/tools/staticdocs/docs/tools">Tools</a><button aria-label="Expand sidebar category &#x27;Tools&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/tools/staticdocs/docs/guides">Guides</a><button aria-label="Expand sidebar category &#x27;Guides&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/tools/staticdocs/docs/development">Development</a><button aria-label="Expand sidebar category &#x27;Development&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/tools/staticdocs/docs/meta">Meta</a><button aria-label="Expand sidebar category &#x27;Meta&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/tools/staticdocs/docs/privacy">OpenC3, Inc. Privacy Policy</a></li></ul></nav></div></div></aside><main class="docMainContainer_namt"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_YAwJ"><div class="docItemContainer_Rv5Z"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_zCmv" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/tools/staticdocs/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_JFrk"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item"><a class="breadcrumbs__link" itemprop="item" href="/tools/staticdocs/docs/configuration"><span itemprop="name">Configuration</span></a><meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Plugins</span><meta itemprop="position" content="2"></li></ul></nav><div class="tocCollapsible_O_Qc theme-doc-toc-mobile tocMobile_tjDr"><button type="button" class="clean-btn tocCollapsibleButton_htYj">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Plugins</h1></header><h2 id="introduction">Introduction</h2>
12
12
  <p>This document provides the information necessary to configure a COSMOS plugin. Plugins are how you configure and extend COSMOS.</p>
13
13
  <p>Plugins are where you define targets (and their corresponding command and telemetry packet definitions), where you configure the interfaces needed to talk to targets, where you can define routers to stream raw data out of COSMOS, how you can add new tools to the COSMOS user interface, and how you can run additional microservices to provide new functionality.</p>
14
14
  <p>Each plugin is built as a Ruby gem and thus has a plugin.gemspec file which builds it. Plugins have a plugin.txt file which declares all the variables used by the plugin and how to interface to the target(s) it contains.</p>
@@ -385,6 +385,6 @@ SECRET FILE KEY &quot;/tmp/DATA/cert&quot;
385
385
  <h3 id="disable_erb-3">DISABLE_ERB</h3>
386
386
  <p></p><div class="right">(Since 5.12.0)</div><strong>Disable ERB processing</strong><p></p>
387
387
  <p>Disable ERB processing for the entire widget or a set of regular expressions over its filenames</p>
388
- <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Regex</td><td>Regex to match against filenames. If match, then no ERB processing</td><td>False</td></tr></tbody></table></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="theme-doc-footer-edit-meta-row row"><div class="col"><a href="https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/configuration/plugins.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_UohW" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_T23F"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/tools/staticdocs/docs/configuration/format"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">File Format</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/tools/staticdocs/docs/configuration/target"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Targets</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="#introduction" class="table-of-contents__link toc-highlight">Introduction</a></li><li><a href="#concepts" class="table-of-contents__link toc-highlight">Concepts</a><ul><li><a href="#target" class="table-of-contents__link toc-highlight">Target</a></li><li><a href="#interface" class="table-of-contents__link toc-highlight">Interface</a></li><li><a href="#router" class="table-of-contents__link toc-highlight">Router</a></li><li><a href="#tool" class="table-of-contents__link toc-highlight">Tool</a></li><li><a href="#microservice" class="table-of-contents__link toc-highlight">Microservice</a></li></ul></li><li><a href="#plugin-directory-structure" class="table-of-contents__link toc-highlight">Plugin Directory Structure</a></li><li><a href="#plugintxt-configuration-file" class="table-of-contents__link toc-highlight">plugin.txt Configuration File</a></li><li><a href="#variable" class="table-of-contents__link toc-highlight">VARIABLE</a></li><li><a href="#needs_dependencies" class="table-of-contents__link toc-highlight">NEEDS_DEPENDENCIES</a></li><li><a href="#interface-1" class="table-of-contents__link toc-highlight">INTERFACE</a></li><li><a href="#interface-modifiers" class="table-of-contents__link toc-highlight">INTERFACE Modifiers</a><ul><li><a href="#map_target" class="table-of-contents__link toc-highlight">MAP_TARGET</a></li><li><a href="#map_cmd_target" class="table-of-contents__link toc-highlight">MAP_CMD_TARGET</a></li><li><a href="#map_tlm_target" class="table-of-contents__link toc-highlight">MAP_TLM_TARGET</a></li><li><a href="#dont_connect" class="table-of-contents__link toc-highlight">DONT_CONNECT</a></li><li><a href="#dont_reconnect" class="table-of-contents__link toc-highlight">DONT_RECONNECT</a></li><li><a href="#reconnect_delay" class="table-of-contents__link toc-highlight">RECONNECT_DELAY</a></li><li><a href="#disable_disconnect" class="table-of-contents__link toc-highlight">DISABLE_DISCONNECT</a></li><li><a href="#log_raw" class="table-of-contents__link toc-highlight">LOG_RAW</a></li><li><a href="#log_stream" class="table-of-contents__link toc-highlight">LOG_STREAM</a></li><li><a href="#protocol" class="table-of-contents__link toc-highlight">PROTOCOL</a></li><li><a href="#option" class="table-of-contents__link toc-highlight">OPTION</a></li><li><a href="#secret" class="table-of-contents__link toc-highlight">SECRET</a></li><li><a href="#env" class="table-of-contents__link toc-highlight">ENV</a></li><li><a href="#work_dir" class="table-of-contents__link toc-highlight">WORK_DIR</a></li><li><a href="#port" class="table-of-contents__link toc-highlight">PORT</a></li><li><a href="#cmd" class="table-of-contents__link toc-highlight">CMD</a></li><li><a href="#container" class="table-of-contents__link toc-highlight">CONTAINER</a></li><li><a href="#route_prefix" class="table-of-contents__link toc-highlight">ROUTE_PREFIX</a></li></ul></li><li><a href="#router-1" class="table-of-contents__link toc-highlight">ROUTER</a></li><li><a href="#target-1" class="table-of-contents__link toc-highlight">TARGET</a></li><li><a href="#target-modifiers" class="table-of-contents__link toc-highlight">TARGET Modifiers</a><ul><li><a href="#cmd_buffer_depth" class="table-of-contents__link toc-highlight">CMD_BUFFER_DEPTH</a></li><li><a href="#cmd_log_cycle_time" class="table-of-contents__link toc-highlight">CMD_LOG_CYCLE_TIME</a></li><li><a href="#cmd_log_cycle_size" class="table-of-contents__link toc-highlight">CMD_LOG_CYCLE_SIZE</a></li><li><a href="#cmd_log_retain_time" class="table-of-contents__link toc-highlight">CMD_LOG_RETAIN_TIME</a></li><li><a href="#cmd_decom_log_cycle_time" class="table-of-contents__link toc-highlight">CMD_DECOM_LOG_CYCLE_TIME</a></li><li><a href="#cmd_decom_log_cycle_size" class="table-of-contents__link toc-highlight">CMD_DECOM_LOG_CYCLE_SIZE</a></li><li><a href="#cmd_decom_log_retain_time" class="table-of-contents__link toc-highlight">CMD_DECOM_LOG_RETAIN_TIME</a></li><li><a href="#tlm_buffer_depth" class="table-of-contents__link toc-highlight">TLM_BUFFER_DEPTH</a></li><li><a href="#tlm_log_cycle_time" class="table-of-contents__link toc-highlight">TLM_LOG_CYCLE_TIME</a></li><li><a href="#tlm_log_cycle_size" class="table-of-contents__link toc-highlight">TLM_LOG_CYCLE_SIZE</a></li><li><a href="#tlm_log_retain_time" class="table-of-contents__link toc-highlight">TLM_LOG_RETAIN_TIME</a></li><li><a href="#tlm_decom_log_cycle_time" class="table-of-contents__link toc-highlight">TLM_DECOM_LOG_CYCLE_TIME</a></li><li><a href="#tlm_decom_log_cycle_size" class="table-of-contents__link toc-highlight">TLM_DECOM_LOG_CYCLE_SIZE</a></li><li><a href="#tlm_decom_log_retain_time" class="table-of-contents__link toc-highlight">TLM_DECOM_LOG_RETAIN_TIME</a></li><li><a href="#reduced_minute_log_retain_time" class="table-of-contents__link toc-highlight">REDUCED_MINUTE_LOG_RETAIN_TIME</a></li><li><a href="#reduced_hour_log_retain_time" class="table-of-contents__link toc-highlight">REDUCED_HOUR_LOG_RETAIN_TIME</a></li><li><a href="#reduced_day_log_retain_time" class="table-of-contents__link toc-highlight">REDUCED_DAY_LOG_RETAIN_TIME</a></li><li><a href="#log_retain_time" class="table-of-contents__link toc-highlight">LOG_RETAIN_TIME</a></li><li><a href="#reduced_log_retain_time" class="table-of-contents__link toc-highlight">REDUCED_LOG_RETAIN_TIME</a></li><li><a href="#cleanup_poll_time" class="table-of-contents__link toc-highlight">CLEANUP_POLL_TIME</a></li><li><a href="#reducer_disable" class="table-of-contents__link toc-highlight">REDUCER_DISABLE</a></li><li><a href="#reducer_max_cpu_utilization" class="table-of-contents__link toc-highlight">REDUCER_MAX_CPU_UTILIZATION</a></li><li><a href="#target_microservice" class="table-of-contents__link toc-highlight">TARGET_MICROSERVICE</a></li><li><a href="#packet" class="table-of-contents__link toc-highlight">PACKET</a></li><li><a href="#disable_erb" class="table-of-contents__link toc-highlight">DISABLE_ERB</a></li></ul></li><li><a href="#microservice-1" class="table-of-contents__link toc-highlight">MICROSERVICE</a></li><li><a href="#microservice-modifiers" class="table-of-contents__link toc-highlight">MICROSERVICE Modifiers</a><ul><li><a href="#env-1" class="table-of-contents__link toc-highlight">ENV</a></li><li><a href="#work_dir-1" class="table-of-contents__link toc-highlight">WORK_DIR</a></li><li><a href="#port-1" class="table-of-contents__link toc-highlight">PORT</a></li><li><a href="#topic" class="table-of-contents__link toc-highlight">TOPIC</a></li><li><a href="#target_name" class="table-of-contents__link toc-highlight">TARGET_NAME</a></li><li><a href="#cmd-1" class="table-of-contents__link toc-highlight">CMD</a></li><li><a href="#option-1" class="table-of-contents__link toc-highlight">OPTION</a></li><li><a href="#container-1" class="table-of-contents__link toc-highlight">CONTAINER</a></li><li><a href="#secret-1" class="table-of-contents__link toc-highlight">SECRET</a></li><li><a href="#route_prefix-1" class="table-of-contents__link toc-highlight">ROUTE_PREFIX</a></li><li><a href="#disable_erb-1" class="table-of-contents__link toc-highlight">DISABLE_ERB</a></li></ul></li><li><a href="#tool-1" class="table-of-contents__link toc-highlight">TOOL</a></li><li><a href="#tool-modifiers" class="table-of-contents__link toc-highlight">TOOL Modifiers</a><ul><li><a href="#url" class="table-of-contents__link toc-highlight">URL</a></li><li><a href="#inline_url" class="table-of-contents__link toc-highlight">INLINE_URL</a></li><li><a href="#window" class="table-of-contents__link toc-highlight">WINDOW</a></li><li><a href="#icon" class="table-of-contents__link toc-highlight">ICON</a></li><li><a href="#category" class="table-of-contents__link toc-highlight">CATEGORY</a></li><li><a href="#shown" class="table-of-contents__link toc-highlight">SHOWN</a></li><li><a href="#position" class="table-of-contents__link toc-highlight">POSITION</a></li><li><a href="#disable_erb-2" class="table-of-contents__link toc-highlight">DISABLE_ERB</a></li></ul></li><li><a href="#widget" class="table-of-contents__link toc-highlight">WIDGET</a></li><li><a href="#widget-modifiers" class="table-of-contents__link toc-highlight">WIDGET Modifiers</a><ul><li><a href="#disable_erb-3" class="table-of-contents__link toc-highlight">DISABLE_ERB</a></li></ul></li></ul></div></div></div></div></main></div></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Homepage</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://openc3.com" target="_blank" rel="noopener noreferrer" class="footer__link-item">Home</a></li></ul></div><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/tools/staticdocs/docs">Documentation</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://www.linkedin.com/company/openc3" target="_blank" rel="noopener noreferrer" class="footer__link-item">LinkedIn<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_awgD"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://github.com/OpenC3/cosmos" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_awgD"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a class="footer__link-item" href="/tools/staticdocs/docs/privacy">Privacy</a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2024 OpenC3, Inc.</div></div></div></footer></div>
388
+ <table><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td>Regex</td><td>Regex to match against filenames. If match, then no ERB processing</td><td>False</td></tr></tbody></table></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/configuration/plugins.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_UohW" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_g62E"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/tools/staticdocs/docs/configuration/format"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">File Format</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/tools/staticdocs/docs/configuration/target"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Targets</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="#introduction" class="table-of-contents__link toc-highlight">Introduction</a></li><li><a href="#concepts" class="table-of-contents__link toc-highlight">Concepts</a><ul><li><a href="#target" class="table-of-contents__link toc-highlight">Target</a></li><li><a href="#interface" class="table-of-contents__link toc-highlight">Interface</a></li><li><a href="#router" class="table-of-contents__link toc-highlight">Router</a></li><li><a href="#tool" class="table-of-contents__link toc-highlight">Tool</a></li><li><a href="#microservice" class="table-of-contents__link toc-highlight">Microservice</a></li></ul></li><li><a href="#plugin-directory-structure" class="table-of-contents__link toc-highlight">Plugin Directory Structure</a></li><li><a href="#plugintxt-configuration-file" class="table-of-contents__link toc-highlight">plugin.txt Configuration File</a></li><li><a href="#variable" class="table-of-contents__link toc-highlight">VARIABLE</a></li><li><a href="#needs_dependencies" class="table-of-contents__link toc-highlight">NEEDS_DEPENDENCIES</a></li><li><a href="#interface-1" class="table-of-contents__link toc-highlight">INTERFACE</a></li><li><a href="#interface-modifiers" class="table-of-contents__link toc-highlight">INTERFACE Modifiers</a><ul><li><a href="#map_target" class="table-of-contents__link toc-highlight">MAP_TARGET</a></li><li><a href="#map_cmd_target" class="table-of-contents__link toc-highlight">MAP_CMD_TARGET</a></li><li><a href="#map_tlm_target" class="table-of-contents__link toc-highlight">MAP_TLM_TARGET</a></li><li><a href="#dont_connect" class="table-of-contents__link toc-highlight">DONT_CONNECT</a></li><li><a href="#dont_reconnect" class="table-of-contents__link toc-highlight">DONT_RECONNECT</a></li><li><a href="#reconnect_delay" class="table-of-contents__link toc-highlight">RECONNECT_DELAY</a></li><li><a href="#disable_disconnect" class="table-of-contents__link toc-highlight">DISABLE_DISCONNECT</a></li><li><a href="#log_raw" class="table-of-contents__link toc-highlight">LOG_RAW</a></li><li><a href="#log_stream" class="table-of-contents__link toc-highlight">LOG_STREAM</a></li><li><a href="#protocol" class="table-of-contents__link toc-highlight">PROTOCOL</a></li><li><a href="#option" class="table-of-contents__link toc-highlight">OPTION</a></li><li><a href="#secret" class="table-of-contents__link toc-highlight">SECRET</a></li><li><a href="#env" class="table-of-contents__link toc-highlight">ENV</a></li><li><a href="#work_dir" class="table-of-contents__link toc-highlight">WORK_DIR</a></li><li><a href="#port" class="table-of-contents__link toc-highlight">PORT</a></li><li><a href="#cmd" class="table-of-contents__link toc-highlight">CMD</a></li><li><a href="#container" class="table-of-contents__link toc-highlight">CONTAINER</a></li><li><a href="#route_prefix" class="table-of-contents__link toc-highlight">ROUTE_PREFIX</a></li></ul></li><li><a href="#router-1" class="table-of-contents__link toc-highlight">ROUTER</a></li><li><a href="#target-1" class="table-of-contents__link toc-highlight">TARGET</a></li><li><a href="#target-modifiers" class="table-of-contents__link toc-highlight">TARGET Modifiers</a><ul><li><a href="#cmd_buffer_depth" class="table-of-contents__link toc-highlight">CMD_BUFFER_DEPTH</a></li><li><a href="#cmd_log_cycle_time" class="table-of-contents__link toc-highlight">CMD_LOG_CYCLE_TIME</a></li><li><a href="#cmd_log_cycle_size" class="table-of-contents__link toc-highlight">CMD_LOG_CYCLE_SIZE</a></li><li><a href="#cmd_log_retain_time" class="table-of-contents__link toc-highlight">CMD_LOG_RETAIN_TIME</a></li><li><a href="#cmd_decom_log_cycle_time" class="table-of-contents__link toc-highlight">CMD_DECOM_LOG_CYCLE_TIME</a></li><li><a href="#cmd_decom_log_cycle_size" class="table-of-contents__link toc-highlight">CMD_DECOM_LOG_CYCLE_SIZE</a></li><li><a href="#cmd_decom_log_retain_time" class="table-of-contents__link toc-highlight">CMD_DECOM_LOG_RETAIN_TIME</a></li><li><a href="#tlm_buffer_depth" class="table-of-contents__link toc-highlight">TLM_BUFFER_DEPTH</a></li><li><a href="#tlm_log_cycle_time" class="table-of-contents__link toc-highlight">TLM_LOG_CYCLE_TIME</a></li><li><a href="#tlm_log_cycle_size" class="table-of-contents__link toc-highlight">TLM_LOG_CYCLE_SIZE</a></li><li><a href="#tlm_log_retain_time" class="table-of-contents__link toc-highlight">TLM_LOG_RETAIN_TIME</a></li><li><a href="#tlm_decom_log_cycle_time" class="table-of-contents__link toc-highlight">TLM_DECOM_LOG_CYCLE_TIME</a></li><li><a href="#tlm_decom_log_cycle_size" class="table-of-contents__link toc-highlight">TLM_DECOM_LOG_CYCLE_SIZE</a></li><li><a href="#tlm_decom_log_retain_time" class="table-of-contents__link toc-highlight">TLM_DECOM_LOG_RETAIN_TIME</a></li><li><a href="#reduced_minute_log_retain_time" class="table-of-contents__link toc-highlight">REDUCED_MINUTE_LOG_RETAIN_TIME</a></li><li><a href="#reduced_hour_log_retain_time" class="table-of-contents__link toc-highlight">REDUCED_HOUR_LOG_RETAIN_TIME</a></li><li><a href="#reduced_day_log_retain_time" class="table-of-contents__link toc-highlight">REDUCED_DAY_LOG_RETAIN_TIME</a></li><li><a href="#log_retain_time" class="table-of-contents__link toc-highlight">LOG_RETAIN_TIME</a></li><li><a href="#reduced_log_retain_time" class="table-of-contents__link toc-highlight">REDUCED_LOG_RETAIN_TIME</a></li><li><a href="#cleanup_poll_time" class="table-of-contents__link toc-highlight">CLEANUP_POLL_TIME</a></li><li><a href="#reducer_disable" class="table-of-contents__link toc-highlight">REDUCER_DISABLE</a></li><li><a href="#reducer_max_cpu_utilization" class="table-of-contents__link toc-highlight">REDUCER_MAX_CPU_UTILIZATION</a></li><li><a href="#target_microservice" class="table-of-contents__link toc-highlight">TARGET_MICROSERVICE</a></li><li><a href="#packet" class="table-of-contents__link toc-highlight">PACKET</a></li><li><a href="#disable_erb" class="table-of-contents__link toc-highlight">DISABLE_ERB</a></li></ul></li><li><a href="#microservice-1" class="table-of-contents__link toc-highlight">MICROSERVICE</a></li><li><a href="#microservice-modifiers" class="table-of-contents__link toc-highlight">MICROSERVICE Modifiers</a><ul><li><a href="#env-1" class="table-of-contents__link toc-highlight">ENV</a></li><li><a href="#work_dir-1" class="table-of-contents__link toc-highlight">WORK_DIR</a></li><li><a href="#port-1" class="table-of-contents__link toc-highlight">PORT</a></li><li><a href="#topic" class="table-of-contents__link toc-highlight">TOPIC</a></li><li><a href="#target_name" class="table-of-contents__link toc-highlight">TARGET_NAME</a></li><li><a href="#cmd-1" class="table-of-contents__link toc-highlight">CMD</a></li><li><a href="#option-1" class="table-of-contents__link toc-highlight">OPTION</a></li><li><a href="#container-1" class="table-of-contents__link toc-highlight">CONTAINER</a></li><li><a href="#secret-1" class="table-of-contents__link toc-highlight">SECRET</a></li><li><a href="#route_prefix-1" class="table-of-contents__link toc-highlight">ROUTE_PREFIX</a></li><li><a href="#disable_erb-1" class="table-of-contents__link toc-highlight">DISABLE_ERB</a></li></ul></li><li><a href="#tool-1" class="table-of-contents__link toc-highlight">TOOL</a></li><li><a href="#tool-modifiers" class="table-of-contents__link toc-highlight">TOOL Modifiers</a><ul><li><a href="#url" class="table-of-contents__link toc-highlight">URL</a></li><li><a href="#inline_url" class="table-of-contents__link toc-highlight">INLINE_URL</a></li><li><a href="#window" class="table-of-contents__link toc-highlight">WINDOW</a></li><li><a href="#icon" class="table-of-contents__link toc-highlight">ICON</a></li><li><a href="#category" class="table-of-contents__link toc-highlight">CATEGORY</a></li><li><a href="#shown" class="table-of-contents__link toc-highlight">SHOWN</a></li><li><a href="#position" class="table-of-contents__link toc-highlight">POSITION</a></li><li><a href="#disable_erb-2" class="table-of-contents__link toc-highlight">DISABLE_ERB</a></li></ul></li><li><a href="#widget" class="table-of-contents__link toc-highlight">WIDGET</a></li><li><a href="#widget-modifiers" class="table-of-contents__link toc-highlight">WIDGET Modifiers</a><ul><li><a href="#disable_erb-3" class="table-of-contents__link toc-highlight">DISABLE_ERB</a></li></ul></li></ul></div></div></div></div></main></div></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Homepage</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://openc3.com" target="_blank" rel="noopener noreferrer" class="footer__link-item">Home</a></li></ul></div><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/tools/staticdocs/docs">Documentation</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://www.linkedin.com/company/openc3" target="_blank" rel="noopener noreferrer" class="footer__link-item">LinkedIn<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_awgD"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://github.com/OpenC3/cosmos" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_awgD"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a class="footer__link-item" href="/tools/staticdocs/docs/privacy">Privacy</a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2024 OpenC3, Inc.</div></div></div></footer></div>
389
389
  </body>
390
390
  </html>
data/tools/staticdocs/docs/configuration/protocols.html CHANGED
@@ -2,13 +2,13 @@
2
2
  <html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-configuration/protocols" data-has-hydrated="false">
3
3
  <head>
4
4
  <meta charset="UTF-8">
5
- <meta name="generator" content="Docusaurus v3.1.0">
6
- <title data-rh="true">Protocols | OpenC3 Docs</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.openc3.com/tools/staticdocs/docs/configuration/protocols"><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="Protocols | OpenC3 Docs"><meta data-rh="true" name="description" content="Protocols process data on behalf of an Interface. They can modify the data being written, data being read, or both. Protocols can also mark a packet as stored instead of real-time which means COSMOS will not update the current value table with the packet data. Protocols can be layered and will be processed in order. For example, if you have a low-level encryption layer that must be first removed before processing a higher level buffer length protocol."><meta data-rh="true" property="og:description" content="Protocols process data on behalf of an Interface. They can modify the data being written, data being read, or both. Protocols can also mark a packet as stored instead of real-time which means COSMOS will not update the current value table with the packet data. Protocols can be layered and will be processed in order. For example, if you have a low-level encryption layer that must be first removed before processing a higher level buffer length protocol."><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/configuration/protocols"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/configuration/protocols" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/configuration/protocols" hreflang="x-default"><link rel="stylesheet" href="/tools/staticdocs/assets/css/styles.a9c55efa.css">
7
- <script src="/tools/staticdocs/assets/js/runtime~main.49989116.js" defer="defer"></script>
8
- <script src="/tools/staticdocs/assets/js/main.1b0c8317.js" defer="defer"></script>
5
+ <meta name="generator" content="Docusaurus v3.3.2">
6
+ <title data-rh="true">Protocols | OpenC3 Docs</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.openc3.com/tools/staticdocs/docs/configuration/protocols"><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="Protocols | OpenC3 Docs"><meta data-rh="true" name="description" content="Protocols process data on behalf of an Interface. They can modify the data being written, data being read, or both. Protocols can also mark a packet as stored instead of real-time which means COSMOS will not update the current value table with the packet data. Protocols can be layered and will be processed in order. For example, if you have a low-level encryption layer that must be first removed before processing a higher level buffer length protocol."><meta data-rh="true" property="og:description" content="Protocols process data on behalf of an Interface. They can modify the data being written, data being read, or both. Protocols can also mark a packet as stored instead of real-time which means COSMOS will not update the current value table with the packet data. Protocols can be layered and will be processed in order. For example, if you have a low-level encryption layer that must be first removed before processing a higher level buffer length protocol."><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/configuration/protocols"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/configuration/protocols" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/configuration/protocols" hreflang="x-default"><link rel="stylesheet" href="/tools/staticdocs/assets/css/styles.8a0f1b26.css">
7
+ <script src="/tools/staticdocs/assets/js/runtime~main.14022dc5.js" defer="defer"></script>
8
+ <script src="/tools/staticdocs/assets/js/main.eec2a1b0.js" defer="defer"></script>
9
9
  </head>
10
10
  <body class="navigation-with-keyboard">
11
- <script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return localStorage.getItem("theme")}catch(t){}}();t(null!==e?e:"dark")}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_G6ar" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/tools/staticdocs/"><div class="navbar__logo"><img src="/tools/staticdocs/img/logo.svg" alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--light_DIHH"><img src="/tools/staticdocs/img/logo.svg" alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--dark_Bv2M"></div><b class="navbar__title text--truncate">OpenC3 Docs</b></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/tools/staticdocs/docs">Documentation</a><a href="https://openc3.com/enterprise/" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Enterprise</a></div><div class="navbar__items navbar__items--right"><div class="navbarSearchContainer_bmvg"><div class="navbar__search"><span aria-label="expand searchbar" role="button" class="search-icon" tabindex="0"></span><input id="search_input_react" type="search" placeholder="Loading..." aria-label="Search" class="navbar__search-input search-bar" disabled=""></div></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_UyTV"><div class="docsWrapper_XLvK"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_z1FD" type="button"></button><div class="docRoot_HciC"><aside class="theme-doc-sidebar-container docSidebarContainer_e5ai"><div class="sidebarViewport_N8x0"><div class="sidebar_vJCc"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_qiME"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/tools/staticdocs/docs">Introduction</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/getting-started">Getting Started</a><button aria-label="Expand sidebar category &#x27;Getting Started&#x27;" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--active" aria-expanded="true" href="/tools/staticdocs/docs/configuration">Configuration</a><button aria-label="Collapse sidebar category &#x27;Configuration&#x27;" 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/configuration/format">File Format</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/plugins">Plugins</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/target">Targets</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/command">Commands</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/telemetry">Telemetry</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/interfaces">Interfaces</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/tools/staticdocs/docs/configuration/protocols">Protocols</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/table">Tables</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/telemetry-screens">Screens</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/ssl-tls">SSL-TLS</a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/tools">Tools</a><button aria-label="Expand sidebar category &#x27;Tools&#x27;" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/guides">Guides</a><button aria-label="Expand sidebar category &#x27;Guides&#x27;" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/development">Development</a><button aria-label="Expand sidebar category &#x27;Development&#x27;" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/meta">Meta</a><button aria-label="Expand sidebar category &#x27;Meta&#x27;" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/tools/staticdocs/docs/privacy">OpenC3, Inc. Privacy Policy</a></li></ul></nav></div></div></aside><main class="docMainContainer_namt"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_YAwJ"><div class="docItemContainer_Rv5Z"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_zCmv" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/tools/staticdocs/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_JFrk"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item"><a class="breadcrumbs__link" itemprop="item" href="/tools/staticdocs/docs/configuration"><span itemprop="name">Configuration</span></a><meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Protocols</span><meta itemprop="position" content="2"></li></ul></nav><div class="tocCollapsible_O_Qc theme-doc-toc-mobile tocMobile_tjDr"><button type="button" class="clean-btn tocCollapsibleButton_htYj">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Protocols</h1></header><p>Protocols process data on behalf of an Interface. They can modify the data being written, data being read, or both. Protocols can also mark a packet as stored instead of real-time which means COSMOS will not update the current value table with the packet data. Protocols can be layered and will be processed in order. For example, if you have a low-level encryption layer that must be first removed before processing a higher level buffer length protocol.</p>
11
+ <script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return localStorage.getItem("theme")}catch(t){}}();t(null!==e?e:"dark")}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_G6ar" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/tools/staticdocs/"><div class="navbar__logo"><img src="/tools/staticdocs/img/logo.svg" alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--light_DIHH"><img src="/tools/staticdocs/img/logo.svg" alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--dark_Bv2M"></div><b class="navbar__title text--truncate">OpenC3 Docs</b></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/tools/staticdocs/docs">Documentation</a><a href="https://openc3.com/enterprise/" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Enterprise</a></div><div class="navbar__items navbar__items--right"><div class="navbarSearchContainer_bmvg"><div class="navbar__search"><span aria-label="expand searchbar" role="button" class="search-icon" tabindex="0"></span><input id="search_input_react" type="search" placeholder="Loading..." aria-label="Search" class="navbar__search-input search-bar" disabled=""></div></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_UyTV"><div class="docsWrapper_XLvK"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_z1FD" type="button"></button><div class="docRoot_HciC"><aside class="theme-doc-sidebar-container docSidebarContainer_e5ai"><div class="sidebarViewport_N8x0"><div class="sidebar_vJCc"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_qiME"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/tools/staticdocs/docs">Introduction</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/tools/staticdocs/docs/getting-started">Getting Started</a><button aria-label="Expand sidebar category &#x27;Getting Started&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--active" href="/tools/staticdocs/docs/configuration">Configuration</a><button aria-label="Collapse sidebar category &#x27;Configuration&#x27;" 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/configuration/format">File Format</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/plugins">Plugins</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/target">Targets</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/command">Commands</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/telemetry">Telemetry</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/interfaces">Interfaces</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/tools/staticdocs/docs/configuration/protocols">Protocols</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/table">Tables</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/telemetry-screens">Screens</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/ssl-tls">SSL-TLS</a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/tools/staticdocs/docs/tools">Tools</a><button aria-label="Expand sidebar category &#x27;Tools&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/tools/staticdocs/docs/guides">Guides</a><button aria-label="Expand sidebar category &#x27;Guides&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/tools/staticdocs/docs/development">Development</a><button aria-label="Expand sidebar category &#x27;Development&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/tools/staticdocs/docs/meta">Meta</a><button aria-label="Expand sidebar category &#x27;Meta&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/tools/staticdocs/docs/privacy">OpenC3, Inc. Privacy Policy</a></li></ul></nav></div></div></aside><main class="docMainContainer_namt"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_YAwJ"><div class="docItemContainer_Rv5Z"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_zCmv" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/tools/staticdocs/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_JFrk"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item"><a class="breadcrumbs__link" itemprop="item" href="/tools/staticdocs/docs/configuration"><span itemprop="name">Configuration</span></a><meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Protocols</span><meta itemprop="position" content="2"></li></ul></nav><div class="tocCollapsible_O_Qc theme-doc-toc-mobile tocMobile_tjDr"><button type="button" class="clean-btn tocCollapsibleButton_htYj">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Protocols</h1></header><p>Protocols process data on behalf of an Interface. They can modify the data being written, data being read, or both. Protocols can also mark a packet as stored instead of real-time which means COSMOS will not update the current value table with the packet data. Protocols can be layered and will be processed in order. For example, if you have a low-level encryption layer that must be first removed before processing a higher level buffer length protocol.</p>
12
12
  <admonition title="Protocol Run Order" type="info"><p>Read protocols execute in the order specified (First specified runs first). Write protocols execute in the reverse order (Last specified executes first).</p></admonition>
13
13
  <p>Protocols are typically used to define the logic to delineate packets and manipulate data as it written to and read from Interfaces. COSMOS includes Interfaces for TCP/IP Client, TCP/IP Server, Udp Client / Server, and Serial connections. For 99% of use cases these Interfaces should not require any changes as they universally handle the low-level details of reading and writing from these types of connections. All unique behavior should now be defined in Protocols.</p>
14
14
  <p>At a minimum, any byte stream based Interface will require a Protocol to delineate packets. TCP/IP and Serial are examples of byte stream based Interfaces. A byte stream is just a simple stream of bytes and thus you need some way to know where packets begin and end within the stream.</p>
@@ -161,6 +161,6 @@ end
161
161
  <a href="https://github.com/OpenC3/cosmos/blob/main/openc3/lib/openc3/interfaces/protocols/terminated_protocol.rb">lib/openc3/interfaces/protocols/terminated_protocol.rb</a>
162
162
  <a href="https://github.com/OpenC3/cosmos/blob/main/openc3/lib/openc3/interfaces/protocols/template_protocol.rb">lib/openc3/interfaces/protocols/template_protocol.rb</a>
163
163
  <a href="https://github.com/OpenC3/cosmos/blob/main/openc3/lib/openc3/interfaces/protocols/crc_protocol.rb">lib/openc3/interfaces/protocols/crc_protocol.rb</a>
164
- <a href="https://github.com/OpenC3/cosmos/blob/main/openc3/lib/openc3/interfaces/protocols/preidentified_protocol.rb">lib/openc3/interfaces/protocols/preidentified_protocol.rb</a></p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="theme-doc-footer-edit-meta-row row"><div class="col"><a href="https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/configuration/protocols.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_UohW" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_T23F"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/tools/staticdocs/docs/configuration/interfaces"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Interfaces</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/tools/staticdocs/docs/configuration/table"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Tables</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="#packet-delineation-protocols" class="table-of-contents__link toc-highlight">Packet Delineation Protocols</a><ul><li><a href="#cobs-protocol" class="table-of-contents__link toc-highlight">COBS Protocol</a></li><li><a href="#slip-protocol" class="table-of-contents__link toc-highlight">SLIP Protocol</a></li><li><a href="#burst-protocol" class="table-of-contents__link toc-highlight">Burst Protocol</a></li><li><a href="#fixed-protocol" class="table-of-contents__link toc-highlight">Fixed Protocol</a></li><li><a href="#length-protocol" class="table-of-contents__link toc-highlight">Length Protocol</a></li><li><a href="#terminated-protocol" class="table-of-contents__link toc-highlight">Terminated Protocol</a></li><li><a href="#template-protocol" class="table-of-contents__link toc-highlight">Template Protocol</a></li><li><a href="#preidentified-protocol" class="table-of-contents__link toc-highlight">Preidentified Protocol</a></li></ul></li><li><a href="#helper-protocols" class="table-of-contents__link toc-highlight">Helper Protocols</a><ul><li><a href="#cmdresponse-protocol" class="table-of-contents__link toc-highlight">CmdResponse Protocol</a></li><li><a href="#crc-protocol" class="table-of-contents__link toc-highlight">CRC Protocol</a></li><li><a href="#ignore-packet-protocol" class="table-of-contents__link toc-highlight">Ignore Packet Protocol</a></li></ul></li><li><a href="#custom-protocols" class="table-of-contents__link toc-highlight">Custom Protocols</a></li><li><a href="#method-discussions" class="table-of-contents__link toc-highlight">Method discussions</a><ul><li><a href="#initialize" class="table-of-contents__link toc-highlight">initialize</a></li><li><a href="#reset" class="table-of-contents__link toc-highlight">reset</a></li><li><a href="#connect_reset" class="table-of-contents__link toc-highlight">connect_reset</a></li><li><a href="#disconnect_reset" class="table-of-contents__link toc-highlight">disconnect_reset</a></li><li><a href="#read_data" class="table-of-contents__link toc-highlight">read_data</a></li><li><a href="#read_packet" class="table-of-contents__link toc-highlight">read_packet</a></li><li><a href="#write_packet" class="table-of-contents__link toc-highlight">write_packet</a></li><li><a href="#write_data" class="table-of-contents__link toc-highlight">write_data</a></li><li><a href="#post_write_interface" class="table-of-contents__link toc-highlight">post_write_interface</a></li></ul></li><li><a href="#examples" class="table-of-contents__link toc-highlight">Examples</a></li></ul></div></div></div></div></main></div></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Homepage</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://openc3.com" target="_blank" rel="noopener noreferrer" class="footer__link-item">Home</a></li></ul></div><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/tools/staticdocs/docs">Documentation</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://www.linkedin.com/company/openc3" target="_blank" rel="noopener noreferrer" class="footer__link-item">LinkedIn<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_awgD"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://github.com/OpenC3/cosmos" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_awgD"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a class="footer__link-item" href="/tools/staticdocs/docs/privacy">Privacy</a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2024 OpenC3, Inc.</div></div></div></footer></div>
164
+ <a href="https://github.com/OpenC3/cosmos/blob/main/openc3/lib/openc3/interfaces/protocols/preidentified_protocol.rb">lib/openc3/interfaces/protocols/preidentified_protocol.rb</a></p></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/configuration/protocols.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_UohW" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_g62E"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/tools/staticdocs/docs/configuration/interfaces"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Interfaces</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/tools/staticdocs/docs/configuration/table"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Tables</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="#packet-delineation-protocols" class="table-of-contents__link toc-highlight">Packet Delineation Protocols</a><ul><li><a href="#cobs-protocol" class="table-of-contents__link toc-highlight">COBS Protocol</a></li><li><a href="#slip-protocol" class="table-of-contents__link toc-highlight">SLIP Protocol</a></li><li><a href="#burst-protocol" class="table-of-contents__link toc-highlight">Burst Protocol</a></li><li><a href="#fixed-protocol" class="table-of-contents__link toc-highlight">Fixed Protocol</a></li><li><a href="#length-protocol" class="table-of-contents__link toc-highlight">Length Protocol</a></li><li><a href="#terminated-protocol" class="table-of-contents__link toc-highlight">Terminated Protocol</a></li><li><a href="#template-protocol" class="table-of-contents__link toc-highlight">Template Protocol</a></li><li><a href="#preidentified-protocol" class="table-of-contents__link toc-highlight">Preidentified Protocol</a></li></ul></li><li><a href="#helper-protocols" class="table-of-contents__link toc-highlight">Helper Protocols</a><ul><li><a href="#cmdresponse-protocol" class="table-of-contents__link toc-highlight">CmdResponse Protocol</a></li><li><a href="#crc-protocol" class="table-of-contents__link toc-highlight">CRC Protocol</a></li><li><a href="#ignore-packet-protocol" class="table-of-contents__link toc-highlight">Ignore Packet Protocol</a></li></ul></li><li><a href="#custom-protocols" class="table-of-contents__link toc-highlight">Custom Protocols</a></li><li><a href="#method-discussions" class="table-of-contents__link toc-highlight">Method discussions</a><ul><li><a href="#initialize" class="table-of-contents__link toc-highlight">initialize</a></li><li><a href="#reset" class="table-of-contents__link toc-highlight">reset</a></li><li><a href="#connect_reset" class="table-of-contents__link toc-highlight">connect_reset</a></li><li><a href="#disconnect_reset" class="table-of-contents__link toc-highlight">disconnect_reset</a></li><li><a href="#read_data" class="table-of-contents__link toc-highlight">read_data</a></li><li><a href="#read_packet" class="table-of-contents__link toc-highlight">read_packet</a></li><li><a href="#write_packet" class="table-of-contents__link toc-highlight">write_packet</a></li><li><a href="#write_data" class="table-of-contents__link toc-highlight">write_data</a></li><li><a href="#post_write_interface" class="table-of-contents__link toc-highlight">post_write_interface</a></li></ul></li><li><a href="#examples" class="table-of-contents__link toc-highlight">Examples</a></li></ul></div></div></div></div></main></div></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Homepage</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://openc3.com" target="_blank" rel="noopener noreferrer" class="footer__link-item">Home</a></li></ul></div><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/tools/staticdocs/docs">Documentation</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://www.linkedin.com/company/openc3" target="_blank" rel="noopener noreferrer" class="footer__link-item">LinkedIn<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_awgD"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://github.com/OpenC3/cosmos" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_awgD"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a class="footer__link-item" href="/tools/staticdocs/docs/privacy">Privacy</a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2024 OpenC3, Inc.</div></div></div></footer></div>
165
165
  </body>
166
166
  </html>
data/tools/staticdocs/docs/configuration/ssl-tls.html CHANGED
@@ -2,13 +2,13 @@
2
2
  <html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-configuration/ssl-tls" data-has-hydrated="false">
3
3
  <head>
4
4
  <meta charset="UTF-8">
5
- <meta name="generator" content="Docusaurus v3.1.0">
6
- <title data-rh="true">SSL-TLS | OpenC3 Docs</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.openc3.com/tools/staticdocs/docs/configuration/ssl-tls"><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="SSL-TLS | OpenC3 Docs"><meta data-rh="true" name="description" content="COSMOS 5 is a container based service which does not use SSL/TLS out of the box. This guide will help you configure SSL and TLS. Learn more at the Traefik docs."><meta data-rh="true" property="og:description" content="COSMOS 5 is a container based service which does not use SSL/TLS out of the box. This guide will help you configure SSL and TLS. Learn more at the Traefik docs."><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/configuration/ssl-tls"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/configuration/ssl-tls" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/configuration/ssl-tls" hreflang="x-default"><link rel="stylesheet" href="/tools/staticdocs/assets/css/styles.a9c55efa.css">
7
- <script src="/tools/staticdocs/assets/js/runtime~main.49989116.js" defer="defer"></script>
8
- <script src="/tools/staticdocs/assets/js/main.1b0c8317.js" defer="defer"></script>
5
+ <meta name="generator" content="Docusaurus v3.3.2">
6
+ <title data-rh="true">SSL-TLS | OpenC3 Docs</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.openc3.com/tools/staticdocs/docs/configuration/ssl-tls"><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="SSL-TLS | OpenC3 Docs"><meta data-rh="true" name="description" content="COSMOS 5 is a container based service which does not use SSL/TLS out of the box. This guide will help you configure SSL and TLS. Learn more at the Traefik docs."><meta data-rh="true" property="og:description" content="COSMOS 5 is a container based service which does not use SSL/TLS out of the box. This guide will help you configure SSL and TLS. Learn more at the Traefik docs."><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/configuration/ssl-tls"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/configuration/ssl-tls" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/configuration/ssl-tls" hreflang="x-default"><link rel="stylesheet" href="/tools/staticdocs/assets/css/styles.8a0f1b26.css">
7
+ <script src="/tools/staticdocs/assets/js/runtime~main.14022dc5.js" defer="defer"></script>
8
+ <script src="/tools/staticdocs/assets/js/main.eec2a1b0.js" defer="defer"></script>
9
9
  </head>
10
10
  <body class="navigation-with-keyboard">
11
- <script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return localStorage.getItem("theme")}catch(t){}}();t(null!==e?e:"dark")}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_G6ar" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/tools/staticdocs/"><div class="navbar__logo"><img src="/tools/staticdocs/img/logo.svg" alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--light_DIHH"><img src="/tools/staticdocs/img/logo.svg" alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--dark_Bv2M"></div><b class="navbar__title text--truncate">OpenC3 Docs</b></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/tools/staticdocs/docs">Documentation</a><a href="https://openc3.com/enterprise/" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Enterprise</a></div><div class="navbar__items navbar__items--right"><div class="navbarSearchContainer_bmvg"><div class="navbar__search"><span aria-label="expand searchbar" role="button" class="search-icon" tabindex="0"></span><input id="search_input_react" type="search" placeholder="Loading..." aria-label="Search" class="navbar__search-input search-bar" disabled=""></div></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_UyTV"><div class="docsWrapper_XLvK"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_z1FD" type="button"></button><div class="docRoot_HciC"><aside class="theme-doc-sidebar-container docSidebarContainer_e5ai"><div class="sidebarViewport_N8x0"><div class="sidebar_vJCc"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_qiME"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/tools/staticdocs/docs">Introduction</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/getting-started">Getting Started</a><button aria-label="Expand sidebar category &#x27;Getting Started&#x27;" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--active" aria-expanded="true" href="/tools/staticdocs/docs/configuration">Configuration</a><button aria-label="Collapse sidebar category &#x27;Configuration&#x27;" 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/configuration/format">File Format</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/plugins">Plugins</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/target">Targets</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/command">Commands</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/telemetry">Telemetry</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/interfaces">Interfaces</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/protocols">Protocols</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/table">Tables</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/telemetry-screens">Screens</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/tools/staticdocs/docs/configuration/ssl-tls">SSL-TLS</a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/tools">Tools</a><button aria-label="Expand sidebar category &#x27;Tools&#x27;" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/guides">Guides</a><button aria-label="Expand sidebar category &#x27;Guides&#x27;" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/development">Development</a><button aria-label="Expand sidebar category &#x27;Development&#x27;" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/tools/staticdocs/docs/meta">Meta</a><button aria-label="Expand sidebar category &#x27;Meta&#x27;" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/tools/staticdocs/docs/privacy">OpenC3, Inc. Privacy Policy</a></li></ul></nav></div></div></aside><main class="docMainContainer_namt"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_YAwJ"><div class="docItemContainer_Rv5Z"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_zCmv" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/tools/staticdocs/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_JFrk"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item"><a class="breadcrumbs__link" itemprop="item" href="/tools/staticdocs/docs/configuration"><span itemprop="name">Configuration</span></a><meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">SSL-TLS</span><meta itemprop="position" content="2"></li></ul></nav><div class="tocCollapsible_O_Qc theme-doc-toc-mobile tocMobile_tjDr"><button type="button" class="clean-btn tocCollapsibleButton_htYj">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>SSL-TLS</h1></header><p>COSMOS 5 is a container based service which does not use SSL/TLS out of the box. This guide will help you configure SSL and TLS. Learn more at the Traefik <a href="https://doc.traefik.io/traefik/routing/entrypoints/#tls">docs</a>.</p>
11
+ <script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return localStorage.getItem("theme")}catch(t){}}();t(null!==e?e:"dark")}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_G6ar" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/tools/staticdocs/"><div class="navbar__logo"><img src="/tools/staticdocs/img/logo.svg" alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--light_DIHH"><img src="/tools/staticdocs/img/logo.svg" alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--dark_Bv2M"></div><b class="navbar__title text--truncate">OpenC3 Docs</b></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/tools/staticdocs/docs">Documentation</a><a href="https://openc3.com/enterprise/" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Enterprise</a></div><div class="navbar__items navbar__items--right"><div class="navbarSearchContainer_bmvg"><div class="navbar__search"><span aria-label="expand searchbar" role="button" class="search-icon" tabindex="0"></span><input id="search_input_react" type="search" placeholder="Loading..." aria-label="Search" class="navbar__search-input search-bar" disabled=""></div></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_UyTV"><div class="docsWrapper_XLvK"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_z1FD" type="button"></button><div class="docRoot_HciC"><aside class="theme-doc-sidebar-container docSidebarContainer_e5ai"><div class="sidebarViewport_N8x0"><div class="sidebar_vJCc"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_qiME"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/tools/staticdocs/docs">Introduction</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/tools/staticdocs/docs/getting-started">Getting Started</a><button aria-label="Expand sidebar category &#x27;Getting Started&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--active" href="/tools/staticdocs/docs/configuration">Configuration</a><button aria-label="Collapse sidebar category &#x27;Configuration&#x27;" 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/configuration/format">File Format</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/plugins">Plugins</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/target">Targets</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/command">Commands</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/telemetry">Telemetry</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/interfaces">Interfaces</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/protocols">Protocols</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/table">Tables</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/configuration/telemetry-screens">Screens</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/tools/staticdocs/docs/configuration/ssl-tls">SSL-TLS</a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/tools/staticdocs/docs/tools">Tools</a><button aria-label="Expand sidebar category &#x27;Tools&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/tools/staticdocs/docs/guides">Guides</a><button aria-label="Expand sidebar category &#x27;Guides&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/tools/staticdocs/docs/development">Development</a><button aria-label="Expand sidebar category &#x27;Development&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/tools/staticdocs/docs/meta">Meta</a><button aria-label="Expand sidebar category &#x27;Meta&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/tools/staticdocs/docs/privacy">OpenC3, Inc. Privacy Policy</a></li></ul></nav></div></div></aside><main class="docMainContainer_namt"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_YAwJ"><div class="docItemContainer_Rv5Z"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_zCmv" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/tools/staticdocs/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_JFrk"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item"><a class="breadcrumbs__link" itemprop="item" href="/tools/staticdocs/docs/configuration"><span itemprop="name">Configuration</span></a><meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">SSL-TLS</span><meta itemprop="position" content="2"></li></ul></nav><div class="tocCollapsible_O_Qc theme-doc-toc-mobile tocMobile_tjDr"><button type="button" class="clean-btn tocCollapsibleButton_htYj">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>SSL-TLS</h1></header><p>COSMOS 5 is a container based service which does not use SSL/TLS out of the box. This guide will help you configure SSL and TLS. Learn more at the Traefik <a href="https://doc.traefik.io/traefik/routing/entrypoints/#tls">docs</a>.</p>
12
12
  <h3 id="generate-the-certificate">Generate the certificate</h3>
13
13
  <blockquote>
14
14
  <p>Note: Self-signed certificates are considered insecure for the Internet. Firefox will treat the site as having an invalid certificate, while Chrome will act as if the connection was plain HTTP.</p>
@@ -163,6 +163,6 @@ The .crt file and the decrypted and encrypted .key files are available in the pa
163
163
  - TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
164
164
  - TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
165
165
  - TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256
166
- </code></pre></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="theme-doc-footer-edit-meta-row row"><div class="col"><a href="https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/configuration/ssl-tls.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_UohW" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_T23F"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/tools/staticdocs/docs/configuration/telemetry-screens"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Screens</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/tools/staticdocs/docs/tools"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Tools</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="#generate-the-certificate" class="table-of-contents__link toc-highlight">Generate the certificate</a></li><li><a href="#updating-the-openc3-traefik-dockerfile" class="table-of-contents__link toc-highlight">Updating the openc3-traefik Dockerfile</a></li><li><a href="#updating-the-traefik-config" class="table-of-contents__link toc-highlight">Updating the Traefik config</a></li><li><a href="#update-docker-composeyaml" class="table-of-contents__link toc-highlight">Update docker-compose.yaml</a></li><li><a href="#lets-encrypt" class="table-of-contents__link toc-highlight">Let&#39;s Encrypt</a><ul><li><a href="#key" class="table-of-contents__link toc-highlight">KEY</a></li><li><a href="#crt" class="table-of-contents__link toc-highlight">CRT</a></li><li><a href="#crtkey-bundle" class="table-of-contents__link toc-highlight">CRT/KEY Bundle</a></li><li><a href="#certpem" class="table-of-contents__link toc-highlight">cert.pem</a></li><li><a href="#chainpem" class="table-of-contents__link toc-highlight">chain.pem</a></li><li><a href="#checking-certs" class="table-of-contents__link toc-highlight">Checking certs</a></li></ul></li><li><a href="#extracting-the-certificate-and-keys-from-a-pfx-file" class="table-of-contents__link toc-highlight">Extracting the certificate and keys from a .pfx file</a><ul><li><a href="#extract-crt-and-key-files-from-pfx-file" class="table-of-contents__link toc-highlight">Extract .crt and .key files from .pfx file</a></li><li><a href="#convert-pfx-file-to-pem-format" class="table-of-contents__link toc-highlight">Convert .pfx file to .pem format</a></li></ul></li><li><a href="#tls12-inadequate_security-errors" class="table-of-contents__link toc-highlight">TLS1.2 INADEQUATE_SECURITY Errors</a></li></ul></div></div></div></div></main></div></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Homepage</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://openc3.com" target="_blank" rel="noopener noreferrer" class="footer__link-item">Home</a></li></ul></div><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/tools/staticdocs/docs">Documentation</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://www.linkedin.com/company/openc3" target="_blank" rel="noopener noreferrer" class="footer__link-item">LinkedIn<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_awgD"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://github.com/OpenC3/cosmos" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_awgD"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a class="footer__link-item" href="/tools/staticdocs/docs/privacy">Privacy</a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2024 OpenC3, Inc.</div></div></div></footer></div>
166
+ </code></pre></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/configuration/ssl-tls.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_UohW" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_g62E"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/tools/staticdocs/docs/configuration/telemetry-screens"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Screens</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/tools/staticdocs/docs/tools"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Tools</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="#generate-the-certificate" class="table-of-contents__link toc-highlight">Generate the certificate</a></li><li><a href="#updating-the-openc3-traefik-dockerfile" class="table-of-contents__link toc-highlight">Updating the openc3-traefik Dockerfile</a></li><li><a href="#updating-the-traefik-config" class="table-of-contents__link toc-highlight">Updating the Traefik config</a></li><li><a href="#update-docker-composeyaml" class="table-of-contents__link toc-highlight">Update docker-compose.yaml</a></li><li><a href="#lets-encrypt" class="table-of-contents__link toc-highlight">Let&#39;s Encrypt</a><ul><li><a href="#key" class="table-of-contents__link toc-highlight">KEY</a></li><li><a href="#crt" class="table-of-contents__link toc-highlight">CRT</a></li><li><a href="#crtkey-bundle" class="table-of-contents__link toc-highlight">CRT/KEY Bundle</a></li><li><a href="#certpem" class="table-of-contents__link toc-highlight">cert.pem</a></li><li><a href="#chainpem" class="table-of-contents__link toc-highlight">chain.pem</a></li><li><a href="#checking-certs" class="table-of-contents__link toc-highlight">Checking certs</a></li></ul></li><li><a href="#extracting-the-certificate-and-keys-from-a-pfx-file" class="table-of-contents__link toc-highlight">Extracting the certificate and keys from a .pfx file</a><ul><li><a href="#extract-crt-and-key-files-from-pfx-file" class="table-of-contents__link toc-highlight">Extract .crt and .key files from .pfx file</a></li><li><a href="#convert-pfx-file-to-pem-format" class="table-of-contents__link toc-highlight">Convert .pfx file to .pem format</a></li></ul></li><li><a href="#tls12-inadequate_security-errors" class="table-of-contents__link toc-highlight">TLS1.2 INADEQUATE_SECURITY Errors</a></li></ul></div></div></div></div></main></div></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Homepage</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://openc3.com" target="_blank" rel="noopener noreferrer" class="footer__link-item">Home</a></li></ul></div><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/tools/staticdocs/docs">Documentation</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://www.linkedin.com/company/openc3" target="_blank" rel="noopener noreferrer" class="footer__link-item">LinkedIn<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_awgD"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://github.com/OpenC3/cosmos" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_awgD"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a class="footer__link-item" href="/tools/staticdocs/docs/privacy">Privacy</a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2024 OpenC3, Inc.</div></div></div></footer></div>
167
167
  </body>
168
168
  </html>