openc3-cosmos-tool-docs 5.19.0 → 6.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (429) hide show
  1. checksums.yaml +4 -4
  2. data/tools/staticdocs/404.html +1 -13
  3. data/tools/staticdocs/assets/css/styles.839a3ee9.css +1 -0
  4. data/tools/staticdocs/assets/images/add_tool-6919be6e6c05db133a8816a9fc03bf98b0789a8525da4cdaa7b041b25bf9edb8.png +0 -0
  5. data/tools/staticdocs/assets/images/array-c0c541246cb3f9e355acc5c510649c29116ce4d6eb8864b9ace48e9958b36421.png +0 -0
  6. data/tools/staticdocs/assets/images/backcolor-39ca0e2a25bd98fe1c9e067f026f3a719a760d3f14ccb404e2da3a0af4235760.png +0 -0
  7. data/tools/staticdocs/assets/images/block-14583c7d26c1a1c6553435d57015bc5282426f7aa176804867de223009a8d4d7.png +0 -0
  8. data/tools/staticdocs/assets/images/bordercolor-a3ac15f24f91c910fcc9c8bd195232205ec44da0b428b11b71108687ce6316d3.png +0 -0
  9. data/tools/staticdocs/assets/images/button-3f6fd69518f4b2c60b15605ca607cda8b596d4d5e804b867f09f750a47b6cbad.png +0 -0
  10. data/tools/staticdocs/assets/images/canvasdot-d634bed1905d13b0da41200e62781cea6e012b5d68fc914f4c11f512c9c4f7fd.png +0 -0
  11. data/tools/staticdocs/assets/images/canvasimage-6f6f83dc6d777fdff0b820287a96ad171a475fda2896c0a3b678b14984e496fd.png +0 -0
  12. data/tools/staticdocs/assets/images/canvasimagevalue-8c835310f99cebbb15ad34632c77370cf4cc9b95535040fa4723df8baedb5b57.png +0 -0
  13. data/tools/staticdocs/assets/images/canvaslabel-68ee99da9ef15924a2b5b41c60ba7de47382d036eece57574411839ff5ec14e4.png +0 -0
  14. data/tools/staticdocs/assets/images/canvaslabelvalue-43254b6647e626939e79ec7e0940e921582039af006e5024c952881ba196b165.png +0 -0
  15. data/tools/staticdocs/assets/images/canvasline-c5120da84530d4a60a04d40d5565daede656639808d1a456f430e9404a2d5bad.png +0 -0
  16. data/tools/staticdocs/assets/images/canvaslinevalue-5540d10997f723fd09b269b75997452622a3c4333ed4f25628747c1212699255.png +0 -0
  17. data/tools/staticdocs/assets/images/checkbutton-c263b840dcdbeca5cd886884fe8f24bedac7daac5a0ca224a1fb2cce3e24bdf6.png +0 -0
  18. data/tools/staticdocs/assets/images/cmd_authority-34cde391ad5109ad53bca40b55cb74d59e8cd1d0e70eedb3e5bf4d258c324787.png +0 -0
  19. data/tools/staticdocs/assets/images/cmd_tlm_server-dbc02e99c1c837efabeba52831d1d2a3445904fb06b758aaa747496725423fe5.png +0 -0
  20. data/tools/staticdocs/assets/images/collect_states-5418d5b4cb901577f2cbdeccceb254dd2e5b81b1f2c975fb15b5fc679cf23dbf.png +0 -0
  21. data/tools/staticdocs/assets/images/combobox-6c8fa241aa7c5ccf31a42a2373dbd4f6f66d9a063e98ba111d5472b5c8e21590.png +0 -0
  22. data/tools/staticdocs/assets/images/command_history-ecc9b618661ad0aefa0700047a8ab3b094372f2aa427e9fcd270dcd352a30408.png +0 -0
  23. data/tools/staticdocs/assets/images/command_sender-83cf2e2343133c2883c405abd0b322f6d3d4a095c6ee800158a04c8eefe474ed.png +0 -0
  24. data/tools/staticdocs/assets/images/critical_cmd_sender-dd81e845489cf1efd3e08cec87da2262eb9f22dbeb3d89359edf0c58146524a1.png +0 -0
  25. data/tools/staticdocs/assets/images/date-d104f822ef7a1b99ade0a334e2e34c27fc6b1d087ed267f13280623a943113ce.png +0 -0
  26. data/tools/staticdocs/assets/images/formatvalue-8e2ddb6cec177fde1846d333d70168479a3bf67dd2b293764f938726b9e7cdf8.png +0 -0
  27. data/tools/staticdocs/assets/images/height-67268e562da2f9b2d0b9adc38d8fb2ba629504b09d798d8c26be9cfbfdad672a.png +0 -0
  28. data/tools/staticdocs/assets/images/history-04aebef1a0fdaaacc5042e5b835f850b48ea04f4fe50271d9bb57803b442d6cd.png +0 -0
  29. data/tools/staticdocs/assets/images/horizontal-11de51b6fc8baf057ca4f38a7f54a5302b58f30099331c22a074f012e53497aa.png +0 -0
  30. data/tools/staticdocs/assets/images/horizontalbox-ddf82f64de700286a742a71e0c1adebbc7e9822a0dff41139f41bc476e4fc4ce.png +0 -0
  31. data/tools/staticdocs/assets/images/horizontalline-0805762eadcc125ed6584a29a60e7cf8e2d76d13c6243e18eecbaba7a3803128.png +0 -0
  32. data/tools/staticdocs/assets/images/iframe-30d5a4104336b84d18ba538d668978a7986679431a7fe1fd0e3179fea08c074f.png +0 -0
  33. data/tools/staticdocs/assets/images/imageviewer-6149159e29a35cd6694926b344836ce034ce17cc019537028a80d95460eec405.png +0 -0
  34. data/tools/staticdocs/assets/images/inst_clear-48f37464d774363be4a5c1d30a48d4bc7803cb806a15d80dcd3741d7a9a37811.png +0 -0
  35. data/tools/staticdocs/assets/images/inst_collect-ef36e8a1e97fde625cde7a9c300c3db61aca30140f5431f089ce6a3e5da9d7f4.png +0 -0
  36. data/tools/staticdocs/assets/images/inst_collect_hazardous-02857bda2b5e7e821d3f42d3301962ede2bb4379c469a9d62f4a0e686336f0c4.png +0 -0
  37. data/tools/staticdocs/assets/images/interfaces-fa10646a27eb9045b70c2c485498a864bed1896ff171b7f31f8698288e08ae73.png +0 -0
  38. data/tools/staticdocs/assets/images/label-25a3052a497d0db7ebf84c788baedcd01d34f4b423aceee53d6d83639a128e82.png +0 -0
  39. data/tools/staticdocs/assets/images/labelled-b8d0f0a157f48e1fa98511f9177f962e69d1e0e8c24b37cf9f355671f9d13ab8.png +0 -0
  40. data/tools/staticdocs/assets/images/labelprogressbar-c3412db92b2f4e6af20233b085ee20915414d6c4da371398a3e8f36b84971cc7.png +0 -0
  41. data/tools/staticdocs/assets/images/labelsparkline-5985a0f034a5d2fb54b040612178ac9f0d5476eb76ca7e04cacc2618a9970c69.png +0 -0
  42. data/tools/staticdocs/assets/images/labelvalue-db97724272df4815b4ecc397974f91a62c31108b98ef0657716c670ca8128051.png +0 -0
  43. data/tools/staticdocs/assets/images/labelvaluedesc-2e174a9f3443ba971683dea9a33f8aa66d0248fb92a3aff41ec26b7424b5e68c.png +0 -0
  44. data/tools/staticdocs/assets/images/labelvaluelimitscolumn-47664affa9d88150ce257e90d32c61b314d7f0b6aa6da4f5e49152be2cce4ef7.png +0 -0
  45. data/tools/staticdocs/assets/images/labelvaluerangebar-641eba160b8ef7872557584de92f046d9e4411fae3280781f9b049265cc6dd52.png +0 -0
  46. data/tools/staticdocs/assets/images/led-d333a6c7e8b1bad13b7775142c74f94b1829ddedd38814d606b2d00e76707751.png +0 -0
  47. data/tools/staticdocs/assets/images/limitsbar-4f2758f846f6f8a1add81aeaf3b58e071792a6d2ccae9eb504e9c07ab8f8dae1.png +0 -0
  48. data/tools/staticdocs/assets/images/limitscolor-7f8e24e4f27f476c3b4c57393ab797268b86aa8ad8b6e7b83d72dd5bf3ca7952.png +0 -0
  49. data/tools/staticdocs/assets/images/limitscolumn-743800180e9558c86a4f5c5d949e2b8355420a98c85ef98a3320b09defa21fe6.png +0 -0
  50. data/tools/staticdocs/assets/images/linegraph-dc3cca59601beb3ea551bbd05e4e09b6cfabd1a7cbc93b757a7d4b22c478a75b.png +0 -0
  51. data/tools/staticdocs/assets/images/log_messages-6da2901ac63928daa3dcaf39a78ca9e455482c48d4ba917ee704f697e5210818.png +0 -0
  52. data/tools/staticdocs/assets/images/margin-4247b51c2c305cb961d08a807f30883b7fc6d9e3316c18174b86afe2356106dd.png +0 -0
  53. data/tools/staticdocs/assets/images/matrixbycolumns-74a67f236a97fffbdf7251fc98da2302a92df20ad16793a1617bc6f77380c9f6.png +0 -0
  54. data/tools/staticdocs/assets/images/microservices-805cc7d137958ac8183579cdb9a9845e7aef79db19723f0773f4ea4d957b48a1.png +0 -0
  55. data/tools/staticdocs/assets/images/mode_menu-04b9187b57a09ed12481a2699a86c7504fdc1c822579b4f762865ea90cb52dd3.png +0 -0
  56. data/tools/staticdocs/assets/images/named_widget-37362db8e310e5639be849d729fd637677f72330d676da4cd6baafc4b961331c.png +0 -0
  57. data/tools/staticdocs/assets/images/packages-3bfae1a91b0534077280c323a40e879a8ac6a7c3ac45376b3c706a098dab12c3.png +0 -0
  58. data/tools/staticdocs/assets/images/padding-e8ceea8ec79def3b14d186971854c44883675d974409366b77c586eedd85025c.png +0 -0
  59. data/tools/staticdocs/assets/images/plugins-aabbe060bec19e6fa2490b737f20758af9000066121f5af85f260a3b14f9b3d8.png +0 -0
  60. data/tools/staticdocs/assets/images/progressbar-cc1095369de0d483c4a9b07ad3a76f9e966990b2aa68b2bc8177d7130ed382a7.png +0 -0
  61. data/tools/staticdocs/assets/images/radiobutton-9151f7cb0dae5120e51e05b5575981c143e19f350e84c7e190d3dd78aa80fae8.png +0 -0
  62. data/tools/staticdocs/assets/images/rangebar-ceae5a30609ab12625e29fd479e88fb3ba16eb12879976edc807da87547a275d.png +0 -0
  63. data/tools/staticdocs/assets/images/raw-63c1dd793f4a734e7d512bf4c0c3722831c38d5392a1a1b0cb77bbef4d16b96b.png +0 -0
  64. data/tools/staticdocs/assets/images/redis-4553b5b35292cca3df1fa08577f2175efef34e0fdfe512f30ca70785b086b24f.png +0 -0
  65. data/tools/staticdocs/assets/images/right_click-371e3683026c0bb2b27187277b4e99727c6b52965e0190a5f81335248f40ef9b.png +0 -0
  66. data/tools/staticdocs/assets/images/rollup-ff0cecc0daa8dbdc84bc2a81efe4625b88f36a699368ada18e70c8d3d0c63c06.png +0 -0
  67. data/tools/staticdocs/assets/images/routers-489fe07165973feede7a63adf71781cca7ecb1f7d17c069761c1c57e70cf926e.png +0 -0
  68. data/tools/staticdocs/assets/images/scrollwindow-03e2823bf392679f0bd26159f476bad2f6d70a7ebb5a31e109fd75ad681cdd50.png +0 -0
  69. data/tools/staticdocs/assets/images/secrets-c8daf324829a0d4dde1d30f9da89d884ca06ce458e400dfa5d1de4ccb10395a1.png +0 -0
  70. data/tools/staticdocs/assets/images/settings1-36a446ec0455ae5ab3a6d225647264647e517e1e2d83da5c639a63756e0339a6.png +0 -0
  71. data/tools/staticdocs/assets/images/settings2-c18e478b65ba569bea37a2bb185b4702e347aecc570fbc7b26a6e66aeecc9129.png +0 -0
  72. data/tools/staticdocs/assets/images/signal-0e5def1ecb42b4688c7c6ab616ae87ef05c8b9afb5b1a27077e6cc9127721668.png +0 -0
  73. data/tools/staticdocs/assets/images/spacer-055e206bed0b13cba778071458407f184a690a8f2d5ff9cd9789f925c60c4886.png +0 -0
  74. data/tools/staticdocs/assets/images/sparkline-c5f8ecd361eef8172a9dea7ff70f3c1b056a3a00b525459429ead67d00c0c0e5.png +0 -0
  75. data/tools/staticdocs/assets/images/subsetting-ef46d38a0ba47b2fd0ad48422ccc7343a6ff88901c8a9675a27c13c9313e222b.png +0 -0
  76. data/tools/staticdocs/assets/images/tabitem-58fb7c6faa16ac04a0561a0315515852ad43ebdfbf709bd65b211af29f2f85f1.png +0 -0
  77. data/tools/staticdocs/assets/images/targets-c02c28769712aa226fdcbd3b90329285aeb39e775b9be1df6ab0e2ad31231518.png +0 -0
  78. data/tools/staticdocs/assets/images/textbox-9e4a1eb37cf68aabf92e326ff248d098a70295ffe6f7cf2e002a5dbff9ff0ef5.png +0 -0
  79. data/tools/staticdocs/assets/images/textcolor-e6d5bb0fba3786e4da7dd5e739306500ddc5fc6a4ead8e212bbe99a80433596c.png +0 -0
  80. data/tools/staticdocs/assets/images/textfield-931f510c2160ed8e5475bee78fa4c6cebd67d9195d92a22600217824ff55943d.png +0 -0
  81. data/tools/staticdocs/assets/images/time-d77e3f94633eb1008d5a382054940052070f5a4cd385f4a9203c0f60d406d7c6.png +0 -0
  82. data/tools/staticdocs/assets/images/title-5817bee0aa4702b4fd22c81a25e8036c1afc88a465a68d79707b2d58fb48789a.png +0 -0
  83. data/tools/staticdocs/assets/images/tools-d3ea80e2fdc04e5b85743146ebaf1fc7f1406b7b5e6ec9b700ed35dedc8d16e6.png +0 -0
  84. data/tools/staticdocs/assets/images/value-825b95d71be2c565e1d3fa5c57ec94be1bbb6e0a1e8166abb8617d5f50a93d39.png +0 -0
  85. data/tools/staticdocs/assets/images/valuelimitsbar-fd7637e8b4287430ab21a888acd1d10276438186bad6d204a4081c1b0423950f.png +0 -0
  86. data/tools/staticdocs/assets/images/valuelimitscolumn-aecfce9016c27e500eb506675bd372f77df1d671fd8fb0f30debe18c5cfee46c.png +0 -0
  87. data/tools/staticdocs/assets/images/valuerangebar-3a860f1fb4af1beeeb846c389c60f08eb633cc15cbb6f1c09509b5f5c0116d56.png +0 -0
  88. data/tools/staticdocs/assets/images/vertical-d4ea61f78a2cfc2cacc725f0a5dea194ab75278f0cb676e4a749f55d58a632f3.png +0 -0
  89. data/tools/staticdocs/assets/images/verticalbox-28fdba6f2c051a499b7f08a1be97edf0297ac9a9ce0dba44f02a7fe1c2616d91.png +0 -0
  90. data/tools/staticdocs/assets/images/width-1a69354459761ea23e4824436ef364124236f9bb96d46a28c97d8ff20d07ab81.png +0 -0
  91. data/tools/staticdocs/assets/js/019369f3.8413befc.js +1 -0
  92. data/tools/staticdocs/assets/js/058ffc22.a4ceeb8e.js +1 -0
  93. data/tools/staticdocs/assets/js/0686a885.ae0a89e8.js +1 -0
  94. data/tools/staticdocs/assets/js/078dbab0.90ef4019.js +1 -0
  95. data/tools/staticdocs/assets/js/0f5d161c.1c827de2.js +1 -0
  96. data/tools/staticdocs/assets/js/0ff569c9.3b7f9c95.js +1 -0
  97. data/tools/staticdocs/assets/js/103cc3be.76716a45.js +1 -0
  98. data/tools/staticdocs/assets/js/13196248.18801ae0.js +1 -0
  99. data/tools/staticdocs/assets/js/13c1b4e4.4457fa9a.js +1 -0
  100. data/tools/staticdocs/assets/js/1602.1e622848.js +1 -0
  101. data/tools/staticdocs/assets/js/1e02e6a3.8e63f255.js +1 -0
  102. data/tools/staticdocs/assets/js/2047b354.9470f5c9.js +1 -0
  103. data/tools/staticdocs/assets/js/2124.0e1f26f5.js +1 -0
  104. data/tools/staticdocs/assets/js/22b3ac48.ac895789.js +1 -0
  105. data/tools/staticdocs/assets/js/26b8abb2.45d268b1.js +1 -0
  106. data/tools/staticdocs/assets/js/2bb7bf90.471e10a1.js +1 -0
  107. data/tools/staticdocs/assets/js/3040.18a0bb2a.js +4 -0
  108. data/tools/staticdocs/assets/js/3687.6fa52db1.js +101 -0
  109. data/tools/staticdocs/assets/js/3dd7ef3b.d8bb37a8.js +1 -0
  110. data/tools/staticdocs/assets/js/40365d27.5f8a5da7.js +1 -0
  111. data/tools/staticdocs/assets/js/411898ad.c8f67fde.js +1 -0
  112. data/tools/staticdocs/assets/js/42170351.86617d4a.js +1 -0
  113. data/tools/staticdocs/assets/js/4303.a84f454a.js +1 -0
  114. data/tools/staticdocs/assets/js/43652efd.0c473c25.js +1 -0
  115. data/tools/staticdocs/assets/js/53ca7c5b.f0e35da3.js +1 -0
  116. data/tools/staticdocs/assets/js/54d0d530.9ace531c.js +1 -0
  117. data/tools/staticdocs/assets/js/5b233ba7.565c0c28.js +1 -0
  118. data/tools/staticdocs/assets/js/5bc719f6.80b7b43c.js +1 -0
  119. data/tools/staticdocs/assets/js/5c6ce5ec.ed839e0d.js +1 -0
  120. data/tools/staticdocs/assets/js/5e3ed378.048e258b.js +1 -0
  121. data/tools/staticdocs/assets/js/5fe211ef.96109971.js +1 -0
  122. data/tools/staticdocs/assets/js/62df909c.dd5f3a0c.js +1 -0
  123. data/tools/staticdocs/assets/js/630e5448.699a9dec.js +1 -0
  124. data/tools/staticdocs/assets/js/6831b732.4008a669.js +1 -0
  125. data/tools/staticdocs/assets/js/696b4199.34aa1d77.js +1 -0
  126. data/tools/staticdocs/assets/js/6b210247.d37e3087.js +1 -0
  127. data/tools/staticdocs/assets/js/6b65133b.f71c0e94.js +1 -0
  128. data/tools/staticdocs/assets/js/6f92e431.c98e31e0.js +1 -0
  129. data/tools/staticdocs/assets/js/72c6d8a8.1053fbd7.js +1 -0
  130. data/tools/staticdocs/assets/js/75897369.522ccdd7.js +1 -0
  131. data/tools/staticdocs/assets/js/75e64983.6b588c87.js +1 -0
  132. data/tools/staticdocs/assets/js/7690.fc05b8e6.js +1 -0
  133. data/tools/staticdocs/assets/js/7f5b2696.72e3b019.js +1 -0
  134. data/tools/staticdocs/assets/js/80c97f38.5a408d9c.js +1 -0
  135. data/tools/staticdocs/assets/js/867640d5.866fe67b.js +1 -0
  136. data/tools/staticdocs/assets/js/89e76475.b4e9da15.js +1 -0
  137. data/tools/staticdocs/assets/js/8f7843ee.59da8025.js +1 -0
  138. data/tools/staticdocs/assets/js/9424f0b3.cc8aa06e.js +1 -0
  139. data/tools/staticdocs/assets/js/97535711.94a5b402.js +1 -0
  140. data/tools/staticdocs/assets/js/99581c43.ebea1d08.js +1 -0
  141. data/tools/staticdocs/assets/js/9d6e81d0.4bc52207.js +1 -0
  142. data/tools/staticdocs/assets/js/{9fb6059a.a5107afb.js → 9fb6059a.57936fbe.js} +1 -1
  143. data/tools/staticdocs/assets/js/a677c089.d8d7a8f5.js +1 -0
  144. data/tools/staticdocs/assets/js/a9987364.2aa836fd.js +1 -0
  145. data/tools/staticdocs/assets/js/aa6b6c1b.4f484861.js +1 -0
  146. data/tools/staticdocs/assets/js/b4596165.a5fe2cea.js +1 -0
  147. data/tools/staticdocs/assets/js/b6d70f94.5df56282.js +1 -0
  148. data/tools/staticdocs/assets/js/b9f60ba6.cdb4a698.js +1 -0
  149. data/tools/staticdocs/assets/js/bd0034eb.5fb449fc.js +1 -0
  150. data/tools/staticdocs/assets/js/c24eae19.f419c8fb.js +1 -0
  151. data/tools/staticdocs/assets/js/c2598f55.85419dc8.js +1 -0
  152. data/tools/staticdocs/assets/js/c5388ca4.32f8f561.js +1 -0
  153. data/tools/staticdocs/assets/js/cb8c3f08.9264e5dd.js +1 -0
  154. data/tools/staticdocs/assets/js/cd879be4.aa3c877c.js +1 -0
  155. data/tools/staticdocs/assets/js/ce89ef36.1d76e86a.js +1 -0
  156. data/tools/staticdocs/assets/js/d1b923aa.de9e8fd6.js +1 -0
  157. data/tools/staticdocs/assets/js/d1bfc316.82dd17ab.js +1 -0
  158. data/tools/staticdocs/assets/js/d24bf9b6.1cb515f4.js +1 -0
  159. data/tools/staticdocs/assets/js/d57a4b5d.09769a64.js +1 -0
  160. data/tools/staticdocs/assets/js/d5d77c37.1704d750.js +1 -0
  161. data/tools/staticdocs/assets/js/d66bf9c0.9a597f56.js +1 -0
  162. data/tools/staticdocs/assets/js/d8ca4191.1861d710.js +1 -0
  163. data/tools/staticdocs/assets/js/d9b92eba.5a40eb6d.js +1 -0
  164. data/tools/staticdocs/assets/js/db8fa1d0.f9f65c91.js +1 -0
  165. data/tools/staticdocs/assets/js/dbe31111.dae4b9bd.js +1 -0
  166. data/tools/staticdocs/assets/js/dc5f7beb.15fc7cc8.js +1 -0
  167. data/tools/staticdocs/assets/js/dfbae5fd.3959d626.js +1 -0
  168. data/tools/staticdocs/assets/js/e501b0d1.cb2ef34f.js +1 -0
  169. data/tools/staticdocs/assets/js/ebec1ccb.086b8668.js +1 -0
  170. data/tools/staticdocs/assets/js/f15615f1.afd4ba93.js +1 -0
  171. data/tools/staticdocs/assets/js/fd886806.fa25adc4.js +1 -0
  172. data/tools/staticdocs/assets/js/main.1a59b278.js +36 -0
  173. data/tools/staticdocs/assets/js/runtime~main.25e99a76.js +1 -0
  174. data/tools/staticdocs/docs/configuration/accessors.html +85 -0
  175. data/tools/staticdocs/docs/configuration/command.html +149 -158
  176. data/tools/staticdocs/docs/configuration/format.html +28 -40
  177. data/tools/staticdocs/docs/configuration/interfaces.html +119 -64
  178. data/tools/staticdocs/docs/configuration/plugins.html +234 -225
  179. data/tools/staticdocs/docs/configuration/protocols.html +106 -92
  180. data/tools/staticdocs/docs/configuration/ssl-tls.html +34 -46
  181. data/tools/staticdocs/docs/configuration/table.html +88 -100
  182. data/tools/staticdocs/docs/configuration/target.html +29 -41
  183. data/tools/staticdocs/docs/configuration/telemetry-screens.html +374 -316
  184. data/tools/staticdocs/docs/configuration/telemetry.html +136 -142
  185. data/tools/staticdocs/docs/configuration.html +1 -13
  186. data/tools/staticdocs/docs/development/curl.html +17 -29
  187. data/tools/staticdocs/docs/development/developing.html +24 -36
  188. data/tools/staticdocs/docs/development/json-api.html +26 -38
  189. data/tools/staticdocs/docs/development/log-structure.html +19 -31
  190. data/tools/staticdocs/docs/development/roadmap.html +26 -44
  191. data/tools/staticdocs/docs/development/streaming-api.html +10 -22
  192. data/tools/staticdocs/docs/development/testing.html +23 -27
  193. data/tools/staticdocs/docs/development.html +1 -13
  194. data/tools/staticdocs/docs/getting-started/generators.html +37 -49
  195. data/tools/staticdocs/docs/getting-started/gettingstarted.html +45 -56
  196. data/tools/staticdocs/docs/getting-started/installation.html +24 -36
  197. data/tools/staticdocs/docs/getting-started/key_concepts.html +32 -44
  198. data/tools/staticdocs/docs/getting-started/podman.html +25 -37
  199. data/tools/staticdocs/docs/getting-started/requirements.html +32 -44
  200. data/tools/staticdocs/docs/getting-started/upgrading.html +134 -24
  201. data/tools/staticdocs/docs/getting-started.html +1 -13
  202. data/tools/staticdocs/docs/guides/bridges.html +17 -30
  203. data/tools/staticdocs/docs/guides/cfs.html +46 -58
  204. data/tools/staticdocs/docs/guides/custom-widgets.html +17 -29
  205. data/tools/staticdocs/docs/guides/little-endian-bitfields.html +3 -15
  206. data/tools/staticdocs/docs/guides/local-mode.html +16 -28
  207. data/tools/staticdocs/docs/guides/logging.html +12 -24
  208. data/tools/staticdocs/docs/guides/monitoring.html +18 -30
  209. data/tools/staticdocs/docs/guides/performance.html +21 -33
  210. data/tools/staticdocs/docs/guides/raspberrypi.html +16 -28
  211. data/tools/staticdocs/docs/guides/script-writing.html +108 -120
  212. data/tools/staticdocs/docs/guides/scripting-api.html +606 -615
  213. data/tools/staticdocs/docs/guides.html +1 -13
  214. data/tools/staticdocs/docs/meta/contributing.html +14 -26
  215. data/tools/staticdocs/docs/meta/licenses.html +36 -25
  216. data/tools/staticdocs/docs/meta/philosophy.html +3 -15
  217. data/tools/staticdocs/docs/meta/xtce.html +13 -25
  218. data/tools/staticdocs/docs/meta.html +1 -13
  219. data/tools/staticdocs/docs/privacy.html +19 -31
  220. data/tools/staticdocs/docs/tools/admin.html +36 -0
  221. data/tools/staticdocs/docs/tools/autonomic.html +22 -34
  222. data/tools/staticdocs/docs/tools/bucket-explorer.html +10 -22
  223. data/tools/staticdocs/docs/tools/calendar.html +21 -33
  224. data/tools/staticdocs/docs/tools/cmd-sender.html +16 -28
  225. data/tools/staticdocs/docs/tools/cmd-tlm-server.html +27 -36
  226. data/tools/staticdocs/docs/tools/command_history.html +10 -0
  227. data/tools/staticdocs/docs/tools/data-extractor.html +29 -41
  228. data/tools/staticdocs/docs/tools/data-viewer.html +11 -23
  229. data/tools/staticdocs/docs/tools/handbooks.html +4 -16
  230. data/tools/staticdocs/docs/tools/limits-monitor.html +18 -30
  231. data/tools/staticdocs/docs/tools/packet-viewer.html +16 -28
  232. data/tools/staticdocs/docs/tools/script-runner.html +44 -50
  233. data/tools/staticdocs/docs/tools/table-manager.html +16 -28
  234. data/tools/staticdocs/docs/tools/tlm-grapher.html +21 -33
  235. data/tools/staticdocs/docs/tools/tlm-viewer.html +16 -28
  236. data/tools/staticdocs/docs/tools.html +1 -13
  237. data/tools/staticdocs/docs.html +12 -24
  238. data/tools/staticdocs/img/admin/add_tool.png +0 -0
  239. data/tools/staticdocs/img/admin/interfaces.png +0 -0
  240. data/tools/staticdocs/img/admin/microservices.png +0 -0
  241. data/tools/staticdocs/img/admin/packages.png +0 -0
  242. data/tools/staticdocs/img/admin/plugins.png +0 -0
  243. data/tools/staticdocs/img/admin/redis.png +0 -0
  244. data/tools/staticdocs/img/admin/routers.png +0 -0
  245. data/tools/staticdocs/img/admin/secrets.png +0 -0
  246. data/tools/staticdocs/img/admin/settings1.png +0 -0
  247. data/tools/staticdocs/img/admin/settings2.png +0 -0
  248. data/tools/staticdocs/img/admin/targets.png +0 -0
  249. data/tools/staticdocs/img/admin/tools.png +0 -0
  250. data/tools/staticdocs/img/cmd_tlm_server/cmd_authority.png +0 -0
  251. data/tools/staticdocs/img/cmd_tlm_server/cmd_tlm_server.png +0 -0
  252. data/tools/staticdocs/img/cmd_tlm_server/critical_cmd_sender.png +0 -0
  253. data/tools/staticdocs/img/cmd_tlm_server/log_messages.png +0 -0
  254. data/tools/staticdocs/img/command_history/command_history.png +0 -0
  255. data/tools/staticdocs/img/command_sender/collect_states.png +0 -0
  256. data/tools/staticdocs/img/command_sender/command_sender.png +0 -0
  257. data/tools/staticdocs/img/command_sender/history.png +0 -0
  258. data/tools/staticdocs/img/command_sender/inst_clear.png +0 -0
  259. data/tools/staticdocs/img/command_sender/inst_collect.png +0 -0
  260. data/tools/staticdocs/img/command_sender/inst_collect_hazardous.png +0 -0
  261. data/tools/staticdocs/img/command_sender/mode_menu.png +0 -0
  262. data/tools/staticdocs/img/script_runner/right_click.png +0 -0
  263. data/tools/staticdocs/img/telemetry_viewer/widgets/array.png +0 -0
  264. data/tools/staticdocs/img/telemetry_viewer/widgets/backcolor.png +0 -0
  265. data/tools/staticdocs/img/telemetry_viewer/widgets/block.png +0 -0
  266. data/tools/staticdocs/img/telemetry_viewer/widgets/bordercolor.png +0 -0
  267. data/tools/staticdocs/img/telemetry_viewer/widgets/button.png +0 -0
  268. data/tools/staticdocs/img/telemetry_viewer/widgets/canvasdot.png +0 -0
  269. data/tools/staticdocs/img/telemetry_viewer/widgets/canvasimage.png +0 -0
  270. data/tools/staticdocs/img/telemetry_viewer/widgets/canvasimagevalue.png +0 -0
  271. data/tools/staticdocs/img/telemetry_viewer/widgets/canvaslabel.png +0 -0
  272. data/tools/staticdocs/img/telemetry_viewer/widgets/canvaslabelvalue.png +0 -0
  273. data/tools/staticdocs/img/telemetry_viewer/widgets/canvasline.png +0 -0
  274. data/tools/staticdocs/img/telemetry_viewer/widgets/canvaslinevalue.png +0 -0
  275. data/tools/staticdocs/img/telemetry_viewer/widgets/checkbutton.png +0 -0
  276. data/tools/staticdocs/img/telemetry_viewer/widgets/combobox.png +0 -0
  277. data/tools/staticdocs/img/telemetry_viewer/widgets/date.png +0 -0
  278. data/tools/staticdocs/img/telemetry_viewer/widgets/formatvalue.png +0 -0
  279. data/tools/staticdocs/img/telemetry_viewer/widgets/height.png +0 -0
  280. data/tools/staticdocs/img/telemetry_viewer/widgets/horizontal.png +0 -0
  281. data/tools/staticdocs/img/telemetry_viewer/widgets/horizontalbox.png +0 -0
  282. data/tools/staticdocs/img/telemetry_viewer/widgets/horizontalline.png +0 -0
  283. data/tools/staticdocs/img/telemetry_viewer/widgets/iframe.png +0 -0
  284. data/tools/staticdocs/img/telemetry_viewer/widgets/imageviewer.png +0 -0
  285. data/tools/staticdocs/img/telemetry_viewer/widgets/label.png +0 -0
  286. data/tools/staticdocs/img/telemetry_viewer/widgets/labelled.png +0 -0
  287. data/tools/staticdocs/img/telemetry_viewer/widgets/labelprogressbar.png +0 -0
  288. data/tools/staticdocs/img/telemetry_viewer/widgets/labelsparkline.png +0 -0
  289. data/tools/staticdocs/img/telemetry_viewer/widgets/labelvalue.png +0 -0
  290. data/tools/staticdocs/img/telemetry_viewer/widgets/labelvaluedesc.png +0 -0
  291. data/tools/staticdocs/img/telemetry_viewer/widgets/labelvaluelimitscolumn.png +0 -0
  292. data/tools/staticdocs/img/telemetry_viewer/widgets/labelvaluerangebar.png +0 -0
  293. data/tools/staticdocs/img/telemetry_viewer/widgets/led.png +0 -0
  294. data/tools/staticdocs/img/telemetry_viewer/widgets/limitsbar.png +0 -0
  295. data/tools/staticdocs/img/telemetry_viewer/widgets/limitscolor.png +0 -0
  296. data/tools/staticdocs/img/telemetry_viewer/widgets/limitscolumn.png +0 -0
  297. data/tools/staticdocs/img/telemetry_viewer/widgets/linegraph.png +0 -0
  298. data/tools/staticdocs/img/telemetry_viewer/widgets/margin.png +0 -0
  299. data/tools/staticdocs/img/telemetry_viewer/widgets/matrixbycolumns.png +0 -0
  300. data/tools/staticdocs/img/telemetry_viewer/widgets/named_widget.png +0 -0
  301. data/tools/staticdocs/img/telemetry_viewer/widgets/padding.png +0 -0
  302. data/tools/staticdocs/img/telemetry_viewer/widgets/progressbar.png +0 -0
  303. data/tools/staticdocs/img/telemetry_viewer/widgets/radiobutton.png +0 -0
  304. data/tools/staticdocs/img/telemetry_viewer/widgets/rangebar.png +0 -0
  305. data/tools/staticdocs/img/telemetry_viewer/widgets/raw.png +0 -0
  306. data/tools/staticdocs/img/telemetry_viewer/widgets/rollup.png +0 -0
  307. data/tools/staticdocs/img/telemetry_viewer/widgets/scrollwindow.png +0 -0
  308. data/tools/staticdocs/img/telemetry_viewer/widgets/signal.png +0 -0
  309. data/tools/staticdocs/img/telemetry_viewer/widgets/spacer.png +0 -0
  310. data/tools/staticdocs/img/telemetry_viewer/widgets/sparkline.png +0 -0
  311. data/tools/staticdocs/img/telemetry_viewer/widgets/subsetting.png +0 -0
  312. data/tools/staticdocs/img/telemetry_viewer/widgets/tabbook.png +0 -0
  313. data/tools/staticdocs/img/telemetry_viewer/widgets/tabitem.png +0 -0
  314. data/tools/staticdocs/img/telemetry_viewer/widgets/textbox.png +0 -0
  315. data/tools/staticdocs/img/telemetry_viewer/widgets/textcolor.png +0 -0
  316. data/tools/staticdocs/img/telemetry_viewer/widgets/textfield.png +0 -0
  317. data/tools/staticdocs/img/telemetry_viewer/widgets/time.png +0 -0
  318. data/tools/staticdocs/img/telemetry_viewer/widgets/title.png +0 -0
  319. data/tools/staticdocs/img/telemetry_viewer/widgets/value.png +0 -0
  320. data/tools/staticdocs/img/telemetry_viewer/widgets/valuelimitsbar.png +0 -0
  321. data/tools/staticdocs/img/telemetry_viewer/widgets/valuelimitscolumn.png +0 -0
  322. data/tools/staticdocs/img/telemetry_viewer/widgets/valuerangebar.png +0 -0
  323. data/tools/staticdocs/img/telemetry_viewer/widgets/vertical.png +0 -0
  324. data/tools/staticdocs/img/telemetry_viewer/widgets/verticalbox.png +0 -0
  325. data/tools/staticdocs/img/telemetry_viewer/widgets/width.png +0 -0
  326. data/tools/staticdocs/index.html +1 -13
  327. data/tools/staticdocs/lunr-index-1734474862542.json +1 -0
  328. data/tools/staticdocs/lunr-index.json +1 -1
  329. data/tools/staticdocs/markdown-page.html +2 -14
  330. data/tools/staticdocs/search-doc-1734474862542.json +1 -0
  331. data/tools/staticdocs/search-doc.json +1 -1
  332. data/tools/staticdocs/sitemap.xml +1 -1
  333. metadata +256 -99
  334. data/tools/staticdocs/assets/css/styles.80ddca08.css +0 -1
  335. data/tools/staticdocs/assets/images/cmd_authority-51594401bfa6d8cc5849aae05b4d2af838360f8a3329f9746aa1307fe3091402.png +0 -0
  336. data/tools/staticdocs/assets/images/cmd_tlm_server-727ea478568988b10e4be4a3ba7255dd48ec56f6ab6444c6c1e32497fe478681.png +0 -0
  337. data/tools/staticdocs/assets/images/collect_states-565ae4b6d02449850585afd7ce35982711d4d677f5a04c1332b2c176f1ec3a25.png +0 -0
  338. data/tools/staticdocs/assets/images/command_sender-bb1543bde21fc1963405de5251d16a80a0c3a1bf5adb5fb78145d4995e2fe541.png +0 -0
  339. data/tools/staticdocs/assets/images/history-2391436f9edc3e00104a7375f88f5de72b0967f9eb154dfecc346c0a70af4389.png +0 -0
  340. data/tools/staticdocs/assets/images/inst_clear-2d5f985c879e8b917fedacdb8c6552bbd383231bf5c8ab8e560e77df4e050026.png +0 -0
  341. data/tools/staticdocs/assets/images/inst_collect-81bc422b3b33c5ebcbe4c2f489c730b32ab0d6ea6c7f81cc79d9f6bc03e9db15.png +0 -0
  342. data/tools/staticdocs/assets/images/inst_collect_hazardous-a8fb19ea296354a0cd276da1e0ad82f74479eea4e7e204fcf64b779596f2c092.png +0 -0
  343. data/tools/staticdocs/assets/images/log_messages-a934181ef59dc82d2624d052faf1023ef8ff2548f074ba9d67abdb6ebfd728d4.png +0 -0
  344. data/tools/staticdocs/assets/images/mode_menu-9c112084937db5bbff02c18a5681ad038caa0838fc88438628b134a6f6823a09.png +0 -0
  345. data/tools/staticdocs/assets/js/019369f3.727d87f1.js +0 -1
  346. data/tools/staticdocs/assets/js/058ffc22.f2d69d72.js +0 -1
  347. data/tools/staticdocs/assets/js/0686a885.83641127.js +0 -1
  348. data/tools/staticdocs/assets/js/078dbab0.945c9f59.js +0 -1
  349. data/tools/staticdocs/assets/js/0f5d161c.9d01fab0.js +0 -1
  350. data/tools/staticdocs/assets/js/0ff569c9.aa4daee5.js +0 -1
  351. data/tools/staticdocs/assets/js/103cc3be.537144c5.js +0 -1
  352. data/tools/staticdocs/assets/js/13196248.6b49e93d.js +0 -1
  353. data/tools/staticdocs/assets/js/13c1b4e4.22a0b1d4.js +0 -1
  354. data/tools/staticdocs/assets/js/1e02e6a3.0445f325.js +0 -1
  355. data/tools/staticdocs/assets/js/2047b354.25d11993.js +0 -1
  356. data/tools/staticdocs/assets/js/22b3ac48.7a5ea984.js +0 -1
  357. data/tools/staticdocs/assets/js/2601.ca992ab9.js +0 -1
  358. data/tools/staticdocs/assets/js/26b8abb2.dcdf815e.js +0 -1
  359. data/tools/staticdocs/assets/js/2bb7bf90.633f7a6c.js +0 -1
  360. data/tools/staticdocs/assets/js/3917.a6366d59.js +0 -1
  361. data/tools/staticdocs/assets/js/3dd7ef3b.d55880a8.js +0 -1
  362. data/tools/staticdocs/assets/js/40365d27.4b4b2ccd.js +0 -1
  363. data/tools/staticdocs/assets/js/411898ad.1d6a609d.js +0 -1
  364. data/tools/staticdocs/assets/js/42170351.d7f6034b.js +0 -1
  365. data/tools/staticdocs/assets/js/43652efd.d1e1add3.js +0 -1
  366. data/tools/staticdocs/assets/js/53ca7c5b.c3111020.js +0 -1
  367. data/tools/staticdocs/assets/js/54d0d530.fa34b0b0.js +0 -1
  368. data/tools/staticdocs/assets/js/5723.f6123e37.js +0 -1
  369. data/tools/staticdocs/assets/js/5778.7d36f1c2.js +0 -1
  370. data/tools/staticdocs/assets/js/5b233ba7.6fdd6b6c.js +0 -1
  371. data/tools/staticdocs/assets/js/5bc719f6.daa2a049.js +0 -1
  372. data/tools/staticdocs/assets/js/5c6ce5ec.61a9cae2.js +0 -1
  373. data/tools/staticdocs/assets/js/5e3ed378.2bee863a.js +0 -1
  374. data/tools/staticdocs/assets/js/5fe211ef.0b54b37a.js +0 -1
  375. data/tools/staticdocs/assets/js/62df909c.906d9999.js +0 -1
  376. data/tools/staticdocs/assets/js/630e5448.6fea087c.js +0 -1
  377. data/tools/staticdocs/assets/js/6831b732.60c3c6d5.js +0 -1
  378. data/tools/staticdocs/assets/js/696b4199.a5ae3d65.js +0 -1
  379. data/tools/staticdocs/assets/js/6b210247.aaa91da1.js +0 -1
  380. data/tools/staticdocs/assets/js/6b65133b.76b83e83.js +0 -1
  381. data/tools/staticdocs/assets/js/6f92e431.d02304f0.js +0 -1
  382. data/tools/staticdocs/assets/js/72c6d8a8.be25aaac.js +0 -1
  383. data/tools/staticdocs/assets/js/75897369.7b31b03e.js +0 -1
  384. data/tools/staticdocs/assets/js/75e64983.6ef0928b.js +0 -1
  385. data/tools/staticdocs/assets/js/7760.7f593c4f.js +0 -2
  386. data/tools/staticdocs/assets/js/7760.7f593c4f.js.LICENSE.txt +0 -61
  387. data/tools/staticdocs/assets/js/7f5b2696.60735273.js +0 -1
  388. data/tools/staticdocs/assets/js/867640d5.48133ad5.js +0 -1
  389. data/tools/staticdocs/assets/js/89e76475.13ce283b.js +0 -1
  390. data/tools/staticdocs/assets/js/8f7843ee.7a68246a.js +0 -1
  391. data/tools/staticdocs/assets/js/9424f0b3.ea51e6e5.js +0 -1
  392. data/tools/staticdocs/assets/js/97535711.5311ddd9.js +0 -1
  393. data/tools/staticdocs/assets/js/99581c43.64e9c551.js +0 -1
  394. data/tools/staticdocs/assets/js/9d6e81d0.c31feabc.js +0 -1
  395. data/tools/staticdocs/assets/js/a507c363.d2cc5d72.js +0 -1
  396. data/tools/staticdocs/assets/js/a677c089.7877e85d.js +0 -1
  397. data/tools/staticdocs/assets/js/a9987364.0358fb0b.js +0 -1
  398. data/tools/staticdocs/assets/js/aa6b6c1b.9f3252e1.js +0 -1
  399. data/tools/staticdocs/assets/js/b4596165.daa24b72.js +0 -1
  400. data/tools/staticdocs/assets/js/b6d70f94.19c327f0.js +0 -1
  401. data/tools/staticdocs/assets/js/b9f60ba6.e55cd937.js +0 -1
  402. data/tools/staticdocs/assets/js/bd0034eb.6691ccc4.js +0 -1
  403. data/tools/staticdocs/assets/js/c24eae19.503774e8.js +0 -1
  404. data/tools/staticdocs/assets/js/c2598f55.c5a1bac3.js +0 -1
  405. data/tools/staticdocs/assets/js/c5388ca4.f526bb0c.js +0 -1
  406. data/tools/staticdocs/assets/js/cb8c3f08.b82ad06f.js +0 -1
  407. data/tools/staticdocs/assets/js/cd879be4.f956406f.js +0 -1
  408. data/tools/staticdocs/assets/js/ce89ef36.aa518a52.js +0 -1
  409. data/tools/staticdocs/assets/js/d1b923aa.d6bafb72.js +0 -1
  410. data/tools/staticdocs/assets/js/d1bfc316.28d99aa4.js +0 -1
  411. data/tools/staticdocs/assets/js/d24bf9b6.6c422113.js +0 -1
  412. data/tools/staticdocs/assets/js/d57a4b5d.8f23a506.js +0 -1
  413. data/tools/staticdocs/assets/js/d5d77c37.fb296e02.js +0 -1
  414. data/tools/staticdocs/assets/js/d8ca4191.2349d796.js +0 -1
  415. data/tools/staticdocs/assets/js/d9b92eba.8f82360d.js +0 -1
  416. data/tools/staticdocs/assets/js/db8fa1d0.b0500934.js +0 -1
  417. data/tools/staticdocs/assets/js/dc5f7beb.e3a82d1e.js +0 -1
  418. data/tools/staticdocs/assets/js/dfbae5fd.d1484e14.js +0 -1
  419. data/tools/staticdocs/assets/js/e501b0d1.0b407477.js +0 -1
  420. data/tools/staticdocs/assets/js/ebec1ccb.a1b5fc97.js +0 -1
  421. data/tools/staticdocs/assets/js/f15615f1.ee14b7d6.js +0 -1
  422. data/tools/staticdocs/assets/js/fd886806.4a41fa80.js +0 -1
  423. data/tools/staticdocs/assets/js/main.a3784266.js +0 -2
  424. data/tools/staticdocs/assets/js/main.a3784266.js.LICENSE.txt +0 -71
  425. data/tools/staticdocs/assets/js/runtime~main.9f7e4d76.js +0 -1
  426. data/tools/staticdocs/docs/development/host-install.html +0 -38
  427. data/tools/staticdocs/docs/v5/host-install/index.html +0 -11
  428. data/tools/staticdocs/lunr-index-1727813111453.json +0 -1
  429. data/tools/staticdocs/search-doc-1727813111453.json +0 -1
@@ -1,18 +1,8 @@
1
- <!doctype html>
2
- <html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-getting-started/installation" data-has-hydrated="false">
3
- <head>
4
- <meta charset="UTF-8">
5
- <meta name="generator" content="Docusaurus v3.5.2">
6
- <title data-rh="true">Installation | OpenC3 Docs</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.openc3.com/tools/staticdocs/docs/getting-started/installation"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Installation | OpenC3 Docs"><meta data-rh="true" name="description" content="Installing OpenC3 COSMOS"><meta data-rh="true" property="og:description" content="Installing OpenC3 COSMOS"><link data-rh="true" rel="icon" href="/tools/staticdocs/img/favicon.png"><link data-rh="true" rel="canonical" href="https://docs.openc3.com/tools/staticdocs/docs/getting-started/installation"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/getting-started/installation" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/getting-started/installation" hreflang="x-default"><link rel="stylesheet" href="/tools/staticdocs/assets/css/styles.80ddca08.css">
7
- <script src="/tools/staticdocs/assets/js/runtime~main.9f7e4d76.js" defer="defer"></script>
8
- <script src="/tools/staticdocs/assets/js/main.a3784266.js" defer="defer"></script>
9
- </head>
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 window.localStorage.getItem("theme")}catch(t){}}();t(null!==e?e:"dark")}(),function(){try{const n=new URLSearchParams(window.location.search).entries();for(var[t,e]of n)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_G6ar" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/tools/staticdocs/"><div class="navbar__logo"><img src="/tools/staticdocs/img/logo.svg" alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--light_DIHH"><img src="/tools/staticdocs/img/logo.svg" alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--dark_Bv2M"></div><b class="navbar__title text--truncate">OpenC3 Docs</b></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/tools/staticdocs/docs">Documentation</a><a href="https://openc3.com/enterprise/" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Enterprise</a></div><div class="navbar__items navbar__items--right"><div class="navbarSearchContainer_bmvg"><div class="navbar__search"><span aria-label="expand searchbar" role="button" class="search-icon" tabindex="0"></span><input id="search_input_react" type="search" placeholder="Loading..." aria-label="Search" class="navbar__search-input search-bar" disabled=""></div></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_UyTV"><div class="docsWrapper_XLvK"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_z1FD" type="button"></button><div class="docRoot_HciC"><aside class="theme-doc-sidebar-container docSidebarContainer_e5ai"><div class="sidebarViewport_N8x0"><div class="sidebar_vJCc"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_qiME"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/tools/staticdocs/docs">Introduction</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--active" href="/tools/staticdocs/docs/getting-started">Getting Started</a><button aria-label="Collapse sidebar category &#x27;Getting Started&#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 menu__link--active" aria-current="page" tabindex="0" href="/tools/staticdocs/docs/getting-started/installation">Installation</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/gettingstarted">Getting Started</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/generators">Code Generators</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/upgrading">Upgrading</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/key_concepts">Key Concepts</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/requirements">Requirements and Design</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/podman">Podman</a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/tools/staticdocs/docs/configuration">Configuration</a><button aria-label="Expand sidebar category &#x27;Configuration&#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/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/getting-started"><span itemprop="name">Getting Started</span></a><meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Installation</span><meta itemprop="position" content="2"></li></ul></nav><div class="tocCollapsible_O_Qc theme-doc-toc-mobile tocMobile_tjDr"><button type="button" class="clean-btn tocCollapsibleButton_htYj">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Installation</h1></header><h2 class="anchor anchorWithStickyNavbar_fF9Z" id="installing-openc3-cosmos">Installing OpenC3 COSMOS<a href="#installing-openc3-cosmos" class="hash-link" aria-label="Direct link to Installing OpenC3 COSMOS" title="Direct link to Installing OpenC3 COSMOS">​</a></h2>
1
+ <!doctype html><html lang=en dir=ltr class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-getting-started/installation" data-has-hydrated=false><meta charset=UTF-8><meta name=generator content="Docusaurus v3.6.3"><title data-rh=true>Installation | OpenC3 Docs</title><meta data-rh=true name=viewport content="width=device-width,initial-scale=1.0"><meta data-rh=true name=twitter:card content=summary_large_image><meta data-rh=true property=og:url content=https://docs.openc3.com/tools/staticdocs/docs/getting-started/installation><meta data-rh=true property=og:locale content=en><meta data-rh=true name=docusaurus_locale content=en><meta data-rh=true name=docsearch:language content=en><meta data-rh=true name=docusaurus_version content=current><meta data-rh=true name=docusaurus_tag content=docs-default-current><meta data-rh=true name=docsearch:version content=current><meta data-rh=true name=docsearch:docusaurus_tag content=docs-default-current><meta data-rh=true property=og:title content="Installation | OpenC3 Docs"><meta data-rh=true name=description content="Installing OpenC3 COSMOS"><meta data-rh=true property=og:description content="Installing OpenC3 COSMOS"><link data-rh=true rel=icon href=/tools/staticdocs/img/favicon.png><link data-rh=true rel=canonical href=https://docs.openc3.com/tools/staticdocs/docs/getting-started/installation><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/getting-started/installation hreflang=en><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/getting-started/installation hreflang=x-default><link rel=stylesheet href=/tools/staticdocs/assets/css/styles.839a3ee9.css><script src=/tools/staticdocs/assets/js/runtime~main.25e99a76.js defer></script><script src=/tools/staticdocs/assets/js/main.1a59b278.js defer></script><body class=navigation-with-keyboard><script>!function(){var t,e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();t=null!==e?e:"dark",document.documentElement.setAttribute("data-theme",t)}(),function(){try{for(var[t,e]of new URLSearchParams(window.location.search).entries())if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id=__docusaurus><div role=region aria-label="Skip to main content"><a class=skipToContent_G6ar href=#__docusaurus_skipToContent_fallback>Skip to main content</a></div><nav aria-label=Main class="navbar navbar--fixed-top"><div class=navbar__inner><div class=navbar__items><button aria-label="Toggle navigation bar" aria-expanded=false class="navbar__toggle clean-btn" type=button><svg width=30 height=30 viewBox="0 0 30 30" aria-hidden=true><path stroke=currentColor stroke-linecap=round stroke-miterlimit=10 stroke-width=2 d="M4 7h22M4 15h22M4 23h22"/></svg></button><a class=navbar__brand href=/tools/staticdocs/><div class=navbar__logo><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--light_DIHH"><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--dark_Bv2M"></div><b class="navbar__title text--truncate">OpenC3 Docs</b></a><a aria-current=page class="navbar__item navbar__link navbar__link--active" href=/tools/staticdocs/docs>Documentation</a><a href=https://openc3.com/enterprise/ target=_blank rel="noopener noreferrer" class="navbar__item navbar__link">Enterprise</a></div><div class="navbar__items navbar__items--right"><div class=navbarSearchContainer_bmvg><div class=navbar__search><span aria-label="expand searchbar" role=button class=search-icon tabindex=0></span><input id=search_input_react type=search placeholder=Loading... aria-label=Search class="navbar__search-input search-bar" disabled></div></div></div></div><div role=presentation class=navbar-sidebar__backdrop></div></nav><div id=__docusaurus_skipToContent_fallback class="main-wrapper mainWrapper_UyTV"><div class=docsWrapper_XLvK><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_z1FD" type=button></button><div class=docRoot_HciC><aside class="theme-doc-sidebar-container docSidebarContainer_e5ai"><div class=sidebarViewport_N8x0><div class=sidebar_vJCc><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_qiME"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs>Introduction</a><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist menu__link--active" href=/tools/staticdocs/docs/getting-started>Getting Started</a><button aria-label="Collapse sidebar category 'Getting Started'" aria-expanded=true type=button class="clean-btn menu__caret"></button></div><ul style=display:block;overflow:visible;height:auto class=menu__list><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current=page tabindex=0 href=/tools/staticdocs/docs/getting-started/installation>Installation</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/getting-started/gettingstarted>Getting Started</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/getting-started/generators>Code Generators</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/getting-started/upgrading>Upgrading</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/getting-started/key_concepts>Key Concepts</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/getting-started/requirements>Requirements and Design</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/getting-started/podman>Podman</a></ul><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/configuration>Configuration</a><button aria-label="Expand sidebar category 'Configuration'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/tools>Tools</a><button aria-label="Expand sidebar category 'Tools'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/guides>Guides</a><button aria-label="Expand sidebar category 'Guides'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/development>Development</a><button aria-label="Expand sidebar category 'Development'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/meta>Meta</a><button aria-label="Expand sidebar category 'Meta'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs/privacy>OpenC3, Inc. Privacy Policy</a></ul></nav></div></div></aside><main class=docMainContainer_namt><div class="container padding-top--md padding-bottom--lg"><div class=row><div class="col docItemCol_YAwJ"><div class=docItemContainer_Rv5Z><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_zCmv" aria-label=Breadcrumbs><ul class=breadcrumbs itemscope itemtype=https://schema.org/BreadcrumbList><li class=breadcrumbs__item><a aria-label="Home page" class=breadcrumbs__link href=/tools/staticdocs/><svg viewBox="0 0 24 24" class=breadcrumbHomeIcon_JFrk><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill=currentColor /></svg></a><li itemscope itemprop=itemListElement itemtype=https://schema.org/ListItem class=breadcrumbs__item><a class=breadcrumbs__link itemprop=item href=/tools/staticdocs/docs/getting-started><span itemprop=name>Getting Started</span></a><meta itemprop=position content=1><li itemscope itemprop=itemListElement itemtype=https://schema.org/ListItem class="breadcrumbs__item breadcrumbs__item--active"><span class=breadcrumbs__link itemprop=name>Installation</span><meta itemprop=position content=2></ul></nav><div class="tocCollapsible_O_Qc theme-doc-toc-mobile tocMobile_tjDr"><button type=button class="clean-btn tocCollapsibleButton_htYj">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Installation</h1></header><h2 class="anchor anchorWithStickyNavbar_fF9Z" id=installing-openc3-cosmos>Installing OpenC3 COSMOS<a href=#installing-openc3-cosmos class=hash-link aria-label="Direct link to Installing OpenC3 COSMOS" title="Direct link to Installing OpenC3 COSMOS">​</a></h2>
12
2
  <p>The following sections describe how to get OpenC3 COSMOS installed on various operating systems. This document should help you setup you host machine to allow you to have a running version of COSMOS in no time.</p>
13
- <h2 class="anchor anchorWithStickyNavbar_fF9Z" id="installing-openc3-cosmos-on-host-machines">Installing OpenC3 COSMOS on Host Machines<a href="#installing-openc3-cosmos-on-host-machines" class="hash-link" aria-label="Direct link to Installing OpenC3 COSMOS on Host Machines" title="Direct link to Installing OpenC3 COSMOS on Host Machines">​</a></h2>
14
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="prerequisites">PREREQUISITES<a href="#prerequisites" class="hash-link" aria-label="Direct link to PREREQUISITES" title="Direct link to PREREQUISITES">​</a></h3>
15
- <p>Install <a href="https://docs.docker.com/get-docker/" target="_blank" rel="noopener noreferrer">Docker</a> and install <a href="https://docs.docker.com/compose/install/" target="_blank" rel="noopener noreferrer">Docker Compose</a>.</p>
3
+ <h2 class="anchor anchorWithStickyNavbar_fF9Z" id=installing-openc3-cosmos-on-host-machines>Installing OpenC3 COSMOS on Host Machines<a href=#installing-openc3-cosmos-on-host-machines class=hash-link aria-label="Direct link to Installing OpenC3 COSMOS on Host Machines" title="Direct link to Installing OpenC3 COSMOS on Host Machines">​</a></h2>
4
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=prerequisites>PREREQUISITES<a href=#prerequisites class=hash-link aria-label="Direct link to PREREQUISITES" title="Direct link to PREREQUISITES">​</a></h3>
5
+ <p>If you're on Linux (recommended for production), we recommend installing Docker using the <a href=https://docs.docker.com/engine/install/ target=_blank rel="noopener noreferrer">Install Docker Engine</a> instructions (do not use Docker Desktop on Linux). Note: Red Hat users should read the <a href=/tools/staticdocs/docs/getting-started/podman>Podman</a> documentation. If you're on Windows or Mac, install <a href=https://docs.docker.com/get-docker/ target=_blank rel="noopener noreferrer">Docker Desktop</a>. All platforms also need to install <a href=https://docs.docker.com/compose/install/ target=_blank rel="noopener noreferrer">Docker Compose</a>.</p>
16
6
  <ul>
17
7
  <li>
18
8
  <p>Minimum Resources allocated to Docker: 8GB RAM, 1 CPU, 80GB Disk</p>
@@ -27,7 +17,7 @@
27
17
  <p>WSL2 consumes 50% of total memory on Windows or 8GB, whichever is less. However, on Windows builds before 20175 (use <code>winver</code> to check) it consumes 80% of your total memory. This can have a negative effect on Windows performance!</p>
28
18
  </li>
29
19
  <li>
30
- <p>On Windows builds &lt; 20175 or for more fine grained control, create C:\Users\&lt;username&gt;\<a href="https://docs.microsoft.com/en-us/windows/wsl/wsl-config" target="_blank" rel="noopener noreferrer">.wslconfig</a>. Suggested contents on a 32GB machine:</p>
20
+ <p>On Windows builds &lt; 20175 or for more fine grained control, create C:\Users\&lt;username>\<a href=https://docs.microsoft.com/en-us/windows/wsl/wsl-config target=_blank rel="noopener noreferrer">.wslconfig</a>. Suggested contents on a 32GB machine:</p>
31
21
  <p>[wsl2]
32
22
  memory=16GB
33
23
  swap=0</p>
@@ -35,32 +25,30 @@ swap=0</p>
35
25
  </ul>
36
26
  </li>
37
27
  </ul>
38
- <div class="theme-admonition theme-admonition-warning admonition_IZjC alert alert--warning"><div class="admonitionHeading_uVvU"><span class="admonitionIcon_HiR3"><svg viewBox="0 0 16 16"><path fill-rule="evenodd" d="M8.893 1.5c-.183-.31-.52-.5-.887-.5s-.703.19-.886.5L.138 13.499a.98.98 0 0 0 0 1.001c.193.31.53.501.886.501h13.964c.367 0 .704-.19.877-.5a1.03 1.03 0 0 0 .01-1.002L8.893 1.5zm.133 11.497H6.987v-2.003h2.039v2.003zm0-3.004H6.987V5.987h2.039v4.006z"></path></svg></span>Important: Modify Docker Connection Timeouts</div><div class="admonitionContent_bl22"><p>Docker by default will break idle (no data) connections after a period of 5 minutes. This &quot;feature&quot; will eventually cause you problems if you don&#x27;t adjust the Docker settings. This may manifest as idle connections dropping or simply failing to resume after data should have started flowing again. Find the file at C:\Users\username\AppData\Roaming\Docker\settings.json on Windows or ~/Library/Group Containers/group.com.docker/settings.json on MacOS. Modify the value <code>vpnKitMaxPortIdleTime</code> to change the timeout (recommend setting to 0). <strong>Note:</strong> 0 means no timeout (idle connections not dropped)</p></div></div>
28
+ <div class="theme-admonition theme-admonition-warning admonition_IZjC alert alert--warning"><div class=admonitionHeading_uVvU><span class=admonitionIcon_HiR3><svg viewBox="0 0 16 16"><path fill-rule=evenodd d="M8.893 1.5c-.183-.31-.52-.5-.887-.5s-.703.19-.886.5L.138 13.499a.98.98 0 0 0 0 1.001c.193.31.53.501.886.501h13.964c.367 0 .704-.19.877-.5a1.03 1.03 0 0 0 .01-1.002L8.893 1.5zm.133 11.497H6.987v-2.003h2.039v2.003zm0-3.004H6.987V5.987h2.039v4.006z"/></svg></span>Important: Modify Docker Connection Timeouts</div><div class=admonitionContent_bl22><p>Docker by default will break idle (no data) connections after a period of 5 minutes. This "feature" will eventually cause you problems if you don't adjust the Docker settings. This may manifest as idle connections dropping or simply failing to resume after data should have started flowing again. Find the file at C:\Users\username\AppData\Roaming\Docker\settings.json on Windows or ~/Library/Group Containers/group.com.docker/settings.json on MacOS. Modify the value <code>vpnKitMaxPortIdleTime</code> to change the timeout (recommend setting to 0). <strong>Note:</strong> 0 means no timeout (idle connections not dropped)</div></div>
39
29
  <p><strong>Note:</strong> As of December 2021 the COSMOS Docker containers are based on the Alpine Docker image.</p>
40
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="clone-project">CLONE PROJECT<a href="#clone-project" class="hash-link" aria-label="Direct link to CLONE PROJECT" title="Direct link to CLONE PROJECT">​</a></h3>
41
- <p>Since the COSMOS 5.0.9 release we recommend using the project template to get started.</p>
42
- <div class="language-bash codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#d6deeb;--prism-background-color:#011627"><div class="codeBlockContent_qZBB"><pre tabindex="0" class="prism-code language-bash codeBlock_TAPP thin-scrollbar" style="color:#d6deeb;background-color:#011627"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token function" style="color:rgb(130, 170, 255)">git</span><span class="token plain"> clone https://github.com/OpenC3/cosmos-project.git</span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain"></span><span class="token function" style="color:rgb(130, 170, 255)">git</span><span class="token plain"> clone https://github.com/OpenC3/cosmos-enterprise-project.git</span><br></span></code></pre><div class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
43
- <div class="theme-admonition theme-admonition-info admonition_IZjC alert alert--info"><div class="admonitionHeading_uVvU"><span class="admonitionIcon_HiR3"><svg viewBox="0 0 14 16"><path fill-rule="evenodd" d="M7 2.3c3.14 0 5.7 2.56 5.7 5.7s-2.56 5.7-5.7 5.7A5.71 5.71 0 0 1 1.3 8c0-3.14 2.56-5.7 5.7-5.7zM7 1C3.14 1 0 4.14 0 8s3.14 7 7 7 7-3.14 7-7-3.14-7-7-7zm1 3H6v5h2V4zm0 6H6v2h2v-2z"></path></svg></span>Offline Installation</div><div class="admonitionContent_bl22"><p style="margin-bottom:20px">If you need to install in an offline environment you should first see if you&#x27;re able to directly use the COSMOS containers. If so you can first save the containers:</p><p style="margin-bottom:20px"><code>./openc3.sh util save docker.io openc3inc 5.16.2</code></p><p style="margin-bottom:20px">This will download the COSMOS containers from the docker.io repo using the openc3inc namespace and version 5.16.2. The repo, namespace and version are all configurable. Tar files are created in the &#x27;tmp&#x27; directory which you can transfer to your offline environment. Transfer the tar files to your offline environment&#x27;s project &#x27;tmp&#x27; dir and import them with:</p><p style="margin-bottom:20px"><code>./openc3.sh util load 5.16.2</code></p><p style="margin-bottom:20px">Note the version specified in save needs to match the version in load.</p></div></div>
44
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="certificates">CERTIFICATES<a href="#certificates" class="hash-link" aria-label="Direct link to CERTIFICATES" title="Direct link to CERTIFICATES">​</a></h3>
30
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=clone-project>CLONE PROJECT<a href=#clone-project class=hash-link aria-label="Direct link to CLONE PROJECT" title="Direct link to CLONE PROJECT">​</a></h3>
31
+ <p>We recommend using the COSMOS <a href=/tools/staticdocs/docs/getting-started/key_concepts#projects>project template</a> to get started.</p>
32
+ <div class="language-bash codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-bash codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token function" style="color:rgb(130, 170, 255)">git</span><span class="token plain"> clone https://github.com/OpenC3/cosmos-project.git</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token function" style="color:rgb(130, 170, 255)">git</span><span class="token plain"> clone https://github.com/OpenC3/cosmos-enterprise-project.git</span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
33
+ <div class="theme-admonition theme-admonition-info admonition_IZjC alert alert--info"><div class=admonitionHeading_uVvU><span class=admonitionIcon_HiR3><svg viewBox="0 0 14 16"><path fill-rule=evenodd d="M7 2.3c3.14 0 5.7 2.56 5.7 5.7s-2.56 5.7-5.7 5.7A5.71 5.71 0 0 1 1.3 8c0-3.14 2.56-5.7 5.7-5.7zM7 1C3.14 1 0 4.14 0 8s3.14 7 7 7 7-3.14 7-7-3.14-7-7-7zm1 3H6v5h2V4zm0 6H6v2h2v-2z"/></svg></span>Offline Installation</div><div class=admonitionContent_bl22><p style=margin-bottom:20px>If you need to install in an offline environment you should first see if you're able to directly use the COSMOS containers. If so you can first save the containers:<p style=margin-bottom:20px><code>./openc3.sh util save docker.io openc3inc 5.16.2</code><p style=margin-bottom:20px>This will download the COSMOS containers from the docker.io repo using the openc3inc namespace and version 5.16.2. The repo, namespace and version are all configurable. Tar files are created in the 'tmp' directory which you can transfer to your offline environment. Transfer the tar files to your offline environment's project 'tmp' dir and import them with:<p style=margin-bottom:20px><code>./openc3.sh util load 5.16.2</code><p style=margin-bottom:20px>Note the version specified in save needs to match the version in load.</div></div>
34
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=certificates>CERTIFICATES<a href=#certificates class=hash-link aria-label="Direct link to CERTIFICATES" title="Direct link to CERTIFICATES">​</a></h3>
45
35
  <p>The COSMOS containers are designed to work and be built in the presence of an SSL Decryption device. To support this a cacert.pem file can be placed at the base of the COSMOS 5 project that includes any certificates needed by your organization. <strong>Note</strong>: If you set the path to the ssl file in the <code>SSL_CERT_FILE</code> environment variables the openc3 setup script will copy it and place it for the docker container to load.</p>
46
- <div class="theme-admonition theme-admonition-warning admonition_IZjC alert alert--warning"><div class="admonitionHeading_uVvU"><span class="admonitionIcon_HiR3"><svg viewBox="0 0 16 16"><path fill-rule="evenodd" d="M8.893 1.5c-.183-.31-.52-.5-.887-.5s-.703.19-.886.5L.138 13.499a.98.98 0 0 0 0 1.001c.193.31.53.501.886.501h13.964c.367 0 .704-.19.877-.5a1.03 1.03 0 0 0 .01-1.002L8.893 1.5zm.133 11.497H6.987v-2.003h2.039v2.003zm0-3.004H6.987V5.987h2.039v4.006z"></path></svg></span>SSL Issues</div><div class="admonitionContent_bl22"><p>Increasingly organizations are using some sort of SSL decryptor device which can cause curl and other command line tools like git to have SSL certificate problems. If installation fails with messages that involve &quot;certificate&quot;, &quot;SSL&quot;, &quot;self-signed&quot;, or &quot;secure&quot; this is the problem. IT typically sets up browsers to work correctly but not command line applications. Note that the file extension might not be .pem, it could be .pem, crt, .ca-bundle, .cer, .p7b, .p7s, or potentially something else.</p><p>The workaround is to get a proper local certificate file from your IT department that can be used by tools like curl (for example C:\Shared\Ball.pem). Doesn&#x27;t matter just somewhere with no spaces.</p><p>Then set the following environment variables to that path (ie. C:\Shared\Ball.pem)</p><p>SSL_CERT_FILE<br>
36
+ <div class="theme-admonition theme-admonition-warning admonition_IZjC alert alert--warning"><div class=admonitionHeading_uVvU><span class=admonitionIcon_HiR3><svg viewBox="0 0 16 16"><path fill-rule=evenodd d="M8.893 1.5c-.183-.31-.52-.5-.887-.5s-.703.19-.886.5L.138 13.499a.98.98 0 0 0 0 1.001c.193.31.53.501.886.501h13.964c.367 0 .704-.19.877-.5a1.03 1.03 0 0 0 .01-1.002L8.893 1.5zm.133 11.497H6.987v-2.003h2.039v2.003zm0-3.004H6.987V5.987h2.039v4.006z"/></svg></span>SSL Issues</div><div class=admonitionContent_bl22><p>Increasingly organizations are using some sort of SSL decryptor device which can cause curl and other command line tools like git to have SSL certificate problems. If installation fails with messages that involve "certificate", "SSL", "self-signed", or "secure" this is the problem. IT typically sets up browsers to work correctly but not command line applications. Note that the file extension might not be .pem, it could be .pem, crt, .ca-bundle, .cer, .p7b, .p7s, or potentially something else.<p>The workaround is to get a proper local certificate file from your IT department that can be used by tools like curl (for example C:\Shared\Ball.pem). Doesn't matter just somewhere with no spaces.<p>Then set the following environment variables to that path (ie. C:\Shared\Ball.pem)<p>SSL_CERT_FILE<br>
47
37
  CURL_CA_BUNDLE<br>
48
- REQUESTS_CA_BUNDLE<br></p><p>Here are some directions on environment variables in Windows: <a href="https://www.computerhope.com/issues/ch000549.htm" target="_blank" rel="noopener noreferrer">Windows Environment Variables</a></p><p>You will need to create new ones with the names above and set their value to the full path to the certificate file.</p></div></div>
49
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="run">RUN<a href="#run" class="hash-link" aria-label="Direct link to RUN" title="Direct link to RUN">​</a></h3>
50
- <p>Add the locally cloned project directory to your path so you can directly use the batch file or shell script. In Windows this would be adding &quot;C:\openc3-project&quot; to the PATH. In Linux you would edit your shell&#x27;s rc file and export the PATH. For example, on a Mac add the following to ~/.zshrc: <code>export PATH=~/cosmos-project:$PATH</code>.</p>
38
+ REQUESTS_CA_BUNDLE<br><p>Here are some directions on environment variables in Windows: <a href=https://www.computerhope.com/issues/ch000549.htm target=_blank rel="noopener noreferrer">Windows Environment Variables</a><p>You will need to create new ones with the names above and set their value to the full path to the certificate file.</div></div>
39
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=run>RUN<a href=#run class=hash-link aria-label="Direct link to RUN" title="Direct link to RUN">​</a></h3>
40
+ <p>Add the locally cloned project directory to your path so you can directly use the batch file or shell script. In Windows this would be adding "C:\openc3-project" to the PATH. In Linux you would edit your shell's rc file and export the PATH. For example, on a Mac add the following to ~/.zshrc: <code>export PATH=~/cosmos-project:$PATH</code>.</p>
51
41
  <p>Run <code>openc3.bat run</code> (Windows), or <code>./openc3.sh run</code> (linux/Mac).</p>
52
- <p>Note, you can edit the .env file and change OPENC3_TAG to a specific release (e.g. 5.0.9) rather than &#x27;latest&#x27;.</p>
42
+ <p>Note, you can edit the .env file and change OPENC3_TAG to a specific release (e.g. 5.0.9) rather than 'latest'.</p>
53
43
  <p>If you see an error indicating docker daemon is not running ensure Docker and Docker compose is installed and running. If it errors please try to run <code>docker --version</code> or <code>docker-compose --version</code> and try to run the start command again. If the error continues please include the version in your issue if you choose to create one.</p>
54
44
  <p>Running <code>docker ps</code> can help show the running containers.</p>
55
45
  <p><code>openc3.*</code> takes multiple arguments. Run with no arguments for help. An example run of openc3.sh with no arguments will show a usage guide.</p>
56
- <div class="codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#d6deeb;--prism-background-color:#011627"><div class="codeBlockContent_qZBB"><pre tabindex="0" class="prism-code language-text codeBlock_TAPP thin-scrollbar" style="color:#d6deeb;background-color:#011627"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#d6deeb"><span class="token plain">./openc3.sh</span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain">Usage: ./openc3.sh [cli, cliroot, start, stop, cleanup, run, util]</span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain">* cli: run a cli command as the default user (&#x27;cli help&#x27; for more info)</span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain">* cliroot: run a cli command as the root user (&#x27;cli help&#x27; for more info)</span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain">* start: start the docker-compose openc3</span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain">* stop: stop the running dockers for openc3</span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain">* cleanup: cleanup network and volumes for openc3</span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain">* run: run the prebuilt containers for openc3</span><br></span><span class="token-line" style="color:#d6deeb"><span class="token plain">* util: various helper commands</span><br></span></code></pre><div class="buttonGroup_TNwR"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_MVhB" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_yxgH"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_QJLJ"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
57
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="connect">CONNECT<a href="#connect" class="hash-link" aria-label="Direct link to CONNECT" title="Direct link to CONNECT">​</a></h3>
58
- <p>Connect a web browser to <a href="http://localhost:2900" target="_blank" rel="noopener noreferrer">http://localhost:2900</a>. Set the password to whatever you want.</p>
59
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="next-steps">NEXT STEPS<a href="#next-steps" class="hash-link" aria-label="Direct link to NEXT STEPS" title="Direct link to NEXT STEPS">​</a></h3>
60
- <p>Continue to <a href="/tools/staticdocs/docs/getting-started/gettingstarted">Getting Started</a>.</p>
46
+ <div class="language-bash codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_qZBB><pre tabindex=0 class="prism-code language-bash codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">./openc3.sh</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">Usage: ./openc3.sh </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token plain">cli, cliroot, start, stop, cleanup, run, util</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">* cli: run a cli </span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">command</span><span class="token plain"> as the default user </span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string" style="color:rgb(173, 219, 103)">'cli help'</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">for</span><span class="token plain"> </span><span class="token function" style="color:rgb(130, 170, 255)">more</span><span class="token plain"> info</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">* cliroot: run a cli </span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">command</span><span class="token plain"> as the root user </span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token string" style="color:rgb(173, 219, 103)">'cli help'</span><span class="token plain"> </span><span class="token keyword" style="color:rgb(127, 219, 202)">for</span><span class="token plain"> </span><span class="token function" style="color:rgb(130, 170, 255)">more</span><span class="token plain"> info</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">* start: start the </span><span class="token function" style="color:rgb(130, 170, 255)">docker-compose</span><span class="token plain"> openc3</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">* stop: stop the running dockers </span><span class="token keyword" style="color:rgb(127, 219, 202)">for</span><span class="token plain"> openc3</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">* cleanup: cleanup network and volumes </span><span class="token keyword" style="color:rgb(127, 219, 202)">for</span><span class="token plain"> openc3</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">* run: run the prebuilt containers </span><span class="token keyword" style="color:rgb(127, 219, 202)">for</span><span class="token plain"> openc3</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">* util: various helper commands</span><br></span></code></pre><div class=buttonGroup_TNwR><button type=button aria-label="Copy code to clipboard" title=Copy class=clean-btn><span class=copyButtonIcons_MVhB aria-hidden=true><svg viewBox="0 0 24 24" class=copyButtonIcon_yxgH><path fill=currentColor d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"/></svg><svg viewBox="0 0 24 24" class=copyButtonSuccessIcon_QJLJ><path fill=currentColor d=M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z /></svg></span></button></div></div></div>
47
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=connect>CONNECT<a href=#connect class=hash-link aria-label="Direct link to CONNECT" title="Direct link to CONNECT">​</a></h3>
48
+ <p>Connect a web browser to <a href=http://localhost:2900 target=_blank rel="noopener noreferrer">http://localhost:2900</a>. Set the password to whatever you want.</p>
49
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=next-steps>NEXT STEPS<a href=#next-steps class=hash-link aria-label="Direct link to NEXT STEPS" title="Direct link to NEXT STEPS">​</a></h3>
50
+ <p>Continue to <a href=/tools/staticdocs/docs/getting-started/gettingstarted>Getting Started</a>.</p>
61
51
  <hr>
62
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="feedback">Feedback<a href="#feedback" class="hash-link" aria-label="Direct link to Feedback" title="Direct link to Feedback">​</a></h3>
63
- <div class="theme-admonition theme-admonition-note admonition_IZjC alert alert--secondary"><div class="admonitionHeading_uVvU"><span class="admonitionIcon_HiR3"><svg viewBox="0 0 14 16"><path fill-rule="evenodd" d="M6.3 5.69a.942.942 0 0 1-.28-.7c0-.28.09-.52.28-.7.19-.18.42-.28.7-.28.28 0 .52.09.7.28.18.19.28.42.28.7 0 .28-.09.52-.28.7a1 1 0 0 1-.7.3c-.28 0-.52-.11-.7-.3zM8 7.99c-.02-.25-.11-.48-.31-.69-.2-.19-.42-.3-.69-.31H6c-.27.02-.48.13-.69.31-.2.2-.3.44-.31.69h1v3c.02.27.11.5.31.69.2.2.42.31.69.31h1c.27 0 .48-.11.69-.31.2-.19.3-.42.31-.69H8V7.98v.01zM7 2.3c-3.14 0-5.7 2.54-5.7 5.68 0 3.14 2.56 5.7 5.7 5.7s5.7-2.55 5.7-5.7c0-3.15-2.56-5.69-5.7-5.69v.01zM7 .98c3.86 0 7 3.14 7 7s-3.14 7-7 7-7-3.12-7-7 3.14-7 7-7z"></path></svg></span>Find a problem in the documentation?</div><div class="admonitionContent_bl22"><p>Please <a href="https://github.com/OpenC3/cosmos/issues/new/choose" target="_blank" rel="noopener noreferrer">create an issue</a> on
64
- GitHub describing what we can do to make it better.</p></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/getting-started/installation.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_UohW" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_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/getting-started"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Getting Started</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/tools/staticdocs/docs/getting-started/gettingstarted"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Getting Started</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_TN1Q thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#installing-openc3-cosmos" class="table-of-contents__link toc-highlight">Installing OpenC3 COSMOS</a></li><li><a href="#installing-openc3-cosmos-on-host-machines" class="table-of-contents__link toc-highlight">Installing OpenC3 COSMOS on Host Machines</a><ul><li><a href="#prerequisites" class="table-of-contents__link toc-highlight">PREREQUISITES</a></li><li><a href="#clone-project" class="table-of-contents__link toc-highlight">CLONE PROJECT</a></li><li><a href="#certificates" class="table-of-contents__link toc-highlight">CERTIFICATES</a></li><li><a href="#run" class="table-of-contents__link toc-highlight">RUN</a></li><li><a href="#connect" class="table-of-contents__link toc-highlight">CONNECT</a></li><li><a href="#next-steps" class="table-of-contents__link toc-highlight">NEXT STEPS</a></li><li><a href="#feedback" class="table-of-contents__link toc-highlight">Feedback</a></li></ul></li></ul></div></div></div></div></main></div></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Homepage</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://openc3.com" target="_blank" rel="noopener noreferrer" class="footer__link-item">Home</a></li></ul></div><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/tools/staticdocs/docs">Documentation</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://www.linkedin.com/company/openc3" target="_blank" rel="noopener noreferrer" class="footer__link-item">LinkedIn<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_awgD"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://github.com/OpenC3/cosmos" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_awgD"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a class="footer__link-item" href="/tools/staticdocs/docs/privacy">Privacy</a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2024 OpenC3, Inc.</div></div></div></footer></div>
65
- </body>
66
- </html>
52
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=feedback>Feedback<a href=#feedback class=hash-link aria-label="Direct link to Feedback" title="Direct link to Feedback">​</a></h3>
53
+ <div class="theme-admonition theme-admonition-note admonition_IZjC alert alert--secondary"><div class=admonitionHeading_uVvU><span class=admonitionIcon_HiR3><svg viewBox="0 0 14 16"><path fill-rule=evenodd d="M6.3 5.69a.942.942 0 0 1-.28-.7c0-.28.09-.52.28-.7.19-.18.42-.28.7-.28.28 0 .52.09.7.28.18.19.28.42.28.7 0 .28-.09.52-.28.7a1 1 0 0 1-.7.3c-.28 0-.52-.11-.7-.3zM8 7.99c-.02-.25-.11-.48-.31-.69-.2-.19-.42-.3-.69-.31H6c-.27.02-.48.13-.69.31-.2.2-.3.44-.31.69h1v3c.02.27.11.5.31.69.2.2.42.31.69.31h1c.27 0 .48-.11.69-.31.2-.19.3-.42.31-.69H8V7.98v.01zM7 2.3c-3.14 0-5.7 2.54-5.7 5.68 0 3.14 2.56 5.7 5.7 5.7s5.7-2.55 5.7-5.7c0-3.15-2.56-5.69-5.7-5.69v.01zM7 .98c3.86 0 7 3.14 7 7s-3.14 7-7 7-7-3.12-7-7 3.14-7 7-7z"/></svg></span>Find a problem in the documentation?</div><div class=admonitionContent_bl22><p>Please <a href=https://github.com/OpenC3/cosmos/issues/new/choose target=_blank rel="noopener noreferrer">create an issue</a> on
54
+ GitHub describing what we can do to make it better.</div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class=col><a href=https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/getting-started/installation.md target=_blank rel="noopener noreferrer" class=theme-edit-this-page><svg fill=currentColor height=20 width=20 viewBox="0 0 40 40" class=iconEdit_UohW aria-hidden=true><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"/></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/getting-started><div class=pagination-nav__sublabel>Previous</div><div class=pagination-nav__label>Getting Started</div></a><a class="pagination-nav__link pagination-nav__link--next" href=/tools/staticdocs/docs/getting-started/gettingstarted><div class=pagination-nav__sublabel>Next</div><div class=pagination-nav__label>Getting Started</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_TN1Q thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href=#installing-openc3-cosmos class="table-of-contents__link toc-highlight">Installing OpenC3 COSMOS</a><li><a href=#installing-openc3-cosmos-on-host-machines class="table-of-contents__link toc-highlight">Installing OpenC3 COSMOS on Host Machines</a><ul><li><a href=#prerequisites class="table-of-contents__link toc-highlight">PREREQUISITES</a><li><a href=#clone-project class="table-of-contents__link toc-highlight">CLONE PROJECT</a><li><a href=#certificates class="table-of-contents__link toc-highlight">CERTIFICATES</a><li><a href=#run class="table-of-contents__link toc-highlight">RUN</a><li><a href=#connect class="table-of-contents__link toc-highlight">CONNECT</a><li><a href=#next-steps class="table-of-contents__link toc-highlight">NEXT STEPS</a><li><a href=#feedback class="table-of-contents__link toc-highlight">Feedback</a></ul></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></ul></div><div class="col footer__col"><div class=footer__title>Docs</div><ul class="footer__items clean-list"><li class=footer__item><a class=footer__link-item href=/tools/staticdocs/docs>Documentation</a></ul></div><div class="col footer__col"><div class=footer__title>Community</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://www.linkedin.com/company/openc3 target=_blank rel="noopener noreferrer" class=footer__link-item>LinkedIn<svg width=13.5 height=13.5 aria-hidden=true viewBox="0 0 24 24" class=iconExternalLink_awgD><path fill=currentColor d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></svg></a></ul></div><div class="col footer__col"><div class=footer__title>More</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://github.com/OpenC3/cosmos target=_blank rel="noopener noreferrer" class=footer__link-item>GitHub<svg width=13.5 height=13.5 aria-hidden=true viewBox="0 0 24 24" class=iconExternalLink_awgD><path fill=currentColor d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></svg></a><li class=footer__item><a class=footer__link-item href=/tools/staticdocs/docs/privacy>Privacy</a></ul></div></div><div class="footer__bottom text--center"><div class=footer__copyright>Copyright © 2024 OpenC3, Inc.</div></div></div></footer></div>
@@ -1,45 +1,33 @@
1
- <!doctype html>
2
- <html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-getting-started/key_concepts" data-has-hydrated="false">
3
- <head>
4
- <meta charset="UTF-8">
5
- <meta name="generator" content="Docusaurus v3.5.2">
6
- <title data-rh="true">Key Concepts | OpenC3 Docs</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.openc3.com/tools/staticdocs/docs/getting-started/key_concepts"><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="Key Concepts | OpenC3 Docs"><meta data-rh="true" name="description" content="Projects"><meta data-rh="true" property="og:description" content="Projects"><link data-rh="true" rel="icon" href="/tools/staticdocs/img/favicon.png"><link data-rh="true" rel="canonical" href="https://docs.openc3.com/tools/staticdocs/docs/getting-started/key_concepts"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/getting-started/key_concepts" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openc3.com/tools/staticdocs/docs/getting-started/key_concepts" hreflang="x-default"><link rel="stylesheet" href="/tools/staticdocs/assets/css/styles.80ddca08.css">
7
- <script src="/tools/staticdocs/assets/js/runtime~main.9f7e4d76.js" defer="defer"></script>
8
- <script src="/tools/staticdocs/assets/js/main.a3784266.js" defer="defer"></script>
9
- </head>
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 window.localStorage.getItem("theme")}catch(t){}}();t(null!==e?e:"dark")}(),function(){try{const n=new URLSearchParams(window.location.search).entries();for(var[t,e]of n)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_G6ar" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/tools/staticdocs/"><div class="navbar__logo"><img src="/tools/staticdocs/img/logo.svg" alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--light_DIHH"><img src="/tools/staticdocs/img/logo.svg" alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--dark_Bv2M"></div><b class="navbar__title text--truncate">OpenC3 Docs</b></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/tools/staticdocs/docs">Documentation</a><a href="https://openc3.com/enterprise/" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Enterprise</a></div><div class="navbar__items navbar__items--right"><div class="navbarSearchContainer_bmvg"><div class="navbar__search"><span aria-label="expand searchbar" role="button" class="search-icon" tabindex="0"></span><input id="search_input_react" type="search" placeholder="Loading..." aria-label="Search" class="navbar__search-input search-bar" disabled=""></div></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_UyTV"><div class="docsWrapper_XLvK"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_z1FD" type="button"></button><div class="docRoot_HciC"><aside class="theme-doc-sidebar-container docSidebarContainer_e5ai"><div class="sidebarViewport_N8x0"><div class="sidebar_vJCc"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_qiME"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/tools/staticdocs/docs">Introduction</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--active" href="/tools/staticdocs/docs/getting-started">Getting Started</a><button aria-label="Collapse sidebar category &#x27;Getting Started&#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/getting-started/installation">Installation</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/gettingstarted">Getting Started</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/generators">Code Generators</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/upgrading">Upgrading</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/tools/staticdocs/docs/getting-started/key_concepts">Key Concepts</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/requirements">Requirements and Design</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/tools/staticdocs/docs/getting-started/podman">Podman</a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/tools/staticdocs/docs/configuration">Configuration</a><button aria-label="Expand sidebar category &#x27;Configuration&#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/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/getting-started"><span itemprop="name">Getting Started</span></a><meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Key Concepts</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>OpenC3 COSMOS Key Concepts</h1></header>
12
- <h2 class="anchor anchorWithStickyNavbar_fF9Z" id="projects">Projects<a href="#projects" class="hash-link" aria-label="Direct link to Projects" title="Direct link to Projects">​</a></h2>
13
- <p>The main COSMOS <a href="https://github.com/OpenC3/cosmos" target="_blank" rel="noopener noreferrer">repo</a> contains all the source code used to build and run COSMOS. However, users (not developers) of COSMOS should use the COSMOS <a href="https://github.com/OpenC3/cosmos-project" target="_blank" rel="noopener noreferrer">project</a> to launch COSMOS. The project consists of the <a href="https://github.com/OpenC3/cosmos-project/blob/main/openc3.sh" target="_blank" rel="noopener noreferrer">openc3.sh</a> and <a href="https://github.com/OpenC3/cosmos-project/blob/main/openc3.bat" target="_blank" rel="noopener noreferrer">openc3.bat</a> files for starting and stopping COSMOS, the <a href="https://github.com/OpenC3/cosmos-project/blob/main/compose.yaml" target="_blank" rel="noopener noreferrer">compose.yaml</a> for configuring the COSMOS containers, and the <a href="https://github.com/OpenC3/cosmos-project/blob/main/.env" target="_blank" rel="noopener noreferrer">.env</a> file for setting runtime variables. Additionally, the COSMOS project contains user modifiable config files for both Redis and Traefik.</p>
14
- <h2 class="anchor anchorWithStickyNavbar_fF9Z" id="containerization">Containerization<a href="#containerization" class="hash-link" aria-label="Direct link to Containerization" title="Direct link to Containerization">​</a></h2>
15
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="images">Images<a href="#images" class="hash-link" aria-label="Direct link to Images" title="Direct link to Images">​</a></h3>
16
- <p>Per <a href="https://docs.docker.com/get-started/overview/#images" target="_blank" rel="noopener noreferrer">Docker</a>, &quot;An image is a read-only template with instructions for creating a Docker container.&quot; The base operating system COSMOS uses is called <a href="https://www.alpinelinux.org/" target="_blank" rel="noopener noreferrer">Alpine Linux</a>. It is a simple and compact image with a full package system that allows us to install our dependencies. Starting with Alpine, we create a <a href="https://docs.docker.com/engine/reference/builder/" target="_blank" rel="noopener noreferrer">Dockerfile</a> to add Ruby and Python and a few other packages to create our own docker image. We further build upon that image to create a NodeJS image to support our frontend and additional images to support our backend.</p>
17
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="containers">Containers<a href="#containers" class="hash-link" aria-label="Direct link to Containers" title="Direct link to Containers">​</a></h3>
18
- <p>Per <a href="https://www.docker.com/resources/what-container/" target="_blank" rel="noopener noreferrer">Docker</a>, &quot;a container is a standard unit of software that packages up code and all its dependencies so the application runs quickly and reliably from one computing environment to another.&quot; Also per <a href="https://docs.docker.com/guides/walkthroughs/what-is-a-container/" target="_blank" rel="noopener noreferrer">Docker</a>, &quot;A container is an isolated environment for your code. This means that a container has no knowledge of your operating system, or your files. It runs on the environment provided to you by Docker Desktop. Containers have everything that your code needs in order to run, down to a base operating system.&quot; COSMOS utilizes containers to provide a consistent runtime environment. Containers make it easy to deploy to local on-prem servers, cloud environments, or air-gapped networks.</p>
1
+ <!doctype html><html lang=en dir=ltr class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-getting-started/key_concepts" data-has-hydrated=false><meta charset=UTF-8><meta name=generator content="Docusaurus v3.6.3"><title data-rh=true>Key Concepts | OpenC3 Docs</title><meta data-rh=true name=viewport content="width=device-width,initial-scale=1.0"><meta data-rh=true name=twitter:card content=summary_large_image><meta data-rh=true property=og:url content=https://docs.openc3.com/tools/staticdocs/docs/getting-started/key_concepts><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="Key Concepts | OpenC3 Docs"><meta data-rh=true name=description content="Projects, Containerization, Frontend, Backend"><meta data-rh=true property=og:description content="Projects, Containerization, Frontend, Backend"><link data-rh=true rel=icon href=/tools/staticdocs/img/favicon.png><link data-rh=true rel=canonical href=https://docs.openc3.com/tools/staticdocs/docs/getting-started/key_concepts><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/getting-started/key_concepts hreflang=en><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/getting-started/key_concepts hreflang=x-default><link rel=stylesheet href=/tools/staticdocs/assets/css/styles.839a3ee9.css><script src=/tools/staticdocs/assets/js/runtime~main.25e99a76.js defer></script><script src=/tools/staticdocs/assets/js/main.1a59b278.js defer></script><body class=navigation-with-keyboard><script>!function(){var t,e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();t=null!==e?e:"dark",document.documentElement.setAttribute("data-theme",t)}(),function(){try{for(var[t,e]of new URLSearchParams(window.location.search).entries())if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id=__docusaurus><div role=region aria-label="Skip to main content"><a class=skipToContent_G6ar href=#__docusaurus_skipToContent_fallback>Skip to main content</a></div><nav aria-label=Main class="navbar navbar--fixed-top"><div class=navbar__inner><div class=navbar__items><button aria-label="Toggle navigation bar" aria-expanded=false class="navbar__toggle clean-btn" type=button><svg width=30 height=30 viewBox="0 0 30 30" aria-hidden=true><path stroke=currentColor stroke-linecap=round stroke-miterlimit=10 stroke-width=2 d="M4 7h22M4 15h22M4 23h22"/></svg></button><a class=navbar__brand href=/tools/staticdocs/><div class=navbar__logo><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--light_DIHH"><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--dark_Bv2M"></div><b class="navbar__title text--truncate">OpenC3 Docs</b></a><a aria-current=page class="navbar__item navbar__link navbar__link--active" href=/tools/staticdocs/docs>Documentation</a><a href=https://openc3.com/enterprise/ target=_blank rel="noopener noreferrer" class="navbar__item navbar__link">Enterprise</a></div><div class="navbar__items navbar__items--right"><div class=navbarSearchContainer_bmvg><div class=navbar__search><span aria-label="expand searchbar" role=button class=search-icon tabindex=0></span><input id=search_input_react type=search placeholder=Loading... aria-label=Search class="navbar__search-input search-bar" disabled></div></div></div></div><div role=presentation class=navbar-sidebar__backdrop></div></nav><div id=__docusaurus_skipToContent_fallback class="main-wrapper mainWrapper_UyTV"><div class=docsWrapper_XLvK><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_z1FD" type=button></button><div class=docRoot_HciC><aside class="theme-doc-sidebar-container docSidebarContainer_e5ai"><div class=sidebarViewport_N8x0><div class=sidebar_vJCc><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_qiME"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs>Introduction</a><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist menu__link--active" href=/tools/staticdocs/docs/getting-started>Getting Started</a><button aria-label="Collapse sidebar category 'Getting Started'" aria-expanded=true type=button class="clean-btn menu__caret"></button></div><ul style=display:block;overflow:visible;height:auto class=menu__list><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/getting-started/installation>Installation</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/getting-started/gettingstarted>Getting Started</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/getting-started/generators>Code Generators</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/getting-started/upgrading>Upgrading</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current=page tabindex=0 href=/tools/staticdocs/docs/getting-started/key_concepts>Key Concepts</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/getting-started/requirements>Requirements and Design</a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/getting-started/podman>Podman</a></ul><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/configuration>Configuration</a><button aria-label="Expand sidebar category 'Configuration'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/tools>Tools</a><button aria-label="Expand sidebar category 'Tools'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/guides>Guides</a><button aria-label="Expand sidebar category 'Guides'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/development>Development</a><button aria-label="Expand sidebar category 'Development'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/meta>Meta</a><button aria-label="Expand sidebar category 'Meta'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs/privacy>OpenC3, Inc. Privacy Policy</a></ul></nav></div></div></aside><main class=docMainContainer_namt><div class="container padding-top--md padding-bottom--lg"><div class=row><div class="col docItemCol_YAwJ"><div class=docItemContainer_Rv5Z><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_zCmv" aria-label=Breadcrumbs><ul class=breadcrumbs itemscope itemtype=https://schema.org/BreadcrumbList><li class=breadcrumbs__item><a aria-label="Home page" class=breadcrumbs__link href=/tools/staticdocs/><svg viewBox="0 0 24 24" class=breadcrumbHomeIcon_JFrk><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill=currentColor /></svg></a><li itemscope itemprop=itemListElement itemtype=https://schema.org/ListItem class=breadcrumbs__item><a class=breadcrumbs__link itemprop=item href=/tools/staticdocs/docs/getting-started><span itemprop=name>Getting Started</span></a><meta itemprop=position content=1><li itemscope itemprop=itemListElement itemtype=https://schema.org/ListItem class="breadcrumbs__item breadcrumbs__item--active"><span class=breadcrumbs__link itemprop=name>Key Concepts</span><meta itemprop=position content=2></ul></nav><div class="tocCollapsible_O_Qc theme-doc-toc-mobile tocMobile_tjDr"><button type=button class="clean-btn tocCollapsibleButton_htYj">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>OpenC3 COSMOS Key Concepts</h1></header>
2
+ <h2 class="anchor anchorWithStickyNavbar_fF9Z" id=projects>Projects<a href=#projects class=hash-link aria-label="Direct link to Projects" title="Direct link to Projects">​</a></h2>
3
+ <p>The main COSMOS <a href=https://github.com/OpenC3/cosmos target=_blank rel="noopener noreferrer">repo</a> contains all the source code used to build and run COSMOS. However, users (not developers) of COSMOS should use the COSMOS <a href=https://github.com/OpenC3/cosmos-project target=_blank rel="noopener noreferrer">project</a> to launch COSMOS. The project consists of the <a href=https://github.com/OpenC3/cosmos-project/blob/main/openc3.sh target=_blank rel="noopener noreferrer">openc3.sh</a> and <a href=https://github.com/OpenC3/cosmos-project/blob/main/openc3.bat target=_blank rel="noopener noreferrer">openc3.bat</a> files for starting and stopping COSMOS, the <a href=https://github.com/OpenC3/cosmos-project/blob/main/compose.yaml target=_blank rel="noopener noreferrer">compose.yaml</a> for configuring the COSMOS containers, and the <a href=https://github.com/OpenC3/cosmos-project/blob/main/.env target=_blank rel="noopener noreferrer">.env</a> file for setting runtime variables. Additionally, the COSMOS project contains user modifiable config files for both Redis and Traefik.</p>
4
+ <h2 class="anchor anchorWithStickyNavbar_fF9Z" id=containerization>Containerization<a href=#containerization class=hash-link aria-label="Direct link to Containerization" title="Direct link to Containerization">​</a></h2>
5
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=images>Images<a href=#images class=hash-link aria-label="Direct link to Images" title="Direct link to Images">​</a></h3>
6
+ <p>Per <a href=https://docs.docker.com/get-started/overview/#images target=_blank rel="noopener noreferrer">Docker</a>, "An image is a read-only template with instructions for creating a Docker container." The base operating system COSMOS uses is called <a href=https://www.alpinelinux.org/ target=_blank rel="noopener noreferrer">Alpine Linux</a>. It is a simple and compact image with a full package system that allows us to install our dependencies. Starting with Alpine, we create a <a href=https://docs.docker.com/engine/reference/builder/ target=_blank rel="noopener noreferrer">Dockerfile</a> to add Ruby and Python and a few other packages to create our own docker image. We further build upon that image to create a NodeJS image to support our frontend and additional images to support our backend.</p>
7
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=containers>Containers<a href=#containers class=hash-link aria-label="Direct link to Containers" title="Direct link to Containers">​</a></h3>
8
+ <p>Per <a href=https://www.docker.com/resources/what-container/ target=_blank rel="noopener noreferrer">Docker</a>, "a container is a standard unit of software that packages up code and all its dependencies so the application runs quickly and reliably from one computing environment to another." Also per <a href=https://docs.docker.com/guides/walkthroughs/what-is-a-container/ target=_blank rel="noopener noreferrer">Docker</a>, "A container is an isolated environment for your code. This means that a container has no knowledge of your operating system, or your files. It runs on the environment provided to you by Docker Desktop. Containers have everything that your code needs in order to run, down to a base operating system." COSMOS utilizes containers to provide a consistent runtime environment. Containers make it easy to deploy to local on-prem servers, cloud environments, or air-gapped networks.</p>
19
9
  <p>The COSMOS Open Source containers consist of the following:</p>
20
- <table><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td>cosmos-openc3-cosmos-init-1</td><td>Copies files to Minio and configures COSMOS then exits</td></tr><tr><td>cosmos-openc3-operator-1</td><td>Main COSMOS container that runs the interfaces and target microservices</td></tr><tr><td>cosmos-openc3-cosmos-cmd-tlm-api-1</td><td>Rails server that provides all the COSMOS API endpoints</td></tr><tr><td>cosmos-openc3-cosmos-script-runner-api-1</td><td>Rails server that provides the Script API endpoints</td></tr><tr><td>cosmos-openc3-redis-1</td><td>Serves the static target configuration</td></tr><tr><td>cosmos-openc3-redis-ephemeral-1</td><td>Serves the <a href="https://redis.io/docs/data-types/streams" target="_blank" rel="noopener noreferrer">streams</a> containing the raw and decomutated data</td></tr><tr><td>cosmos-openc3-minio-1</td><td>Provides a S3 like bucket storage interface and also serves as a static webserver for the tool files</td></tr><tr><td>cosmos-openc3-traefik-1</td><td>Provides a reverse proxy and load balancer with routes to the COSMOS endpoints</td></tr></tbody></table>
21
- <p>The container list for <a href="https://openc3.com/enterprise" target="_blank" rel="noopener noreferrer">Enterprise COSMOS</a> consists of the following:</p>
22
- <table><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td>cosmos-enterprise-openc3-metrics-1</td><td>Rails server that provides metrics on COSMOS performance</td></tr><tr><td>cosmos-enterprise-openc3-keycloak-1</td><td>Single-Sign On service for authentication</td></tr><tr><td>cosmos-enterprise-openc3-postgresql-1</td><td>SQL Database for use by Keycloak</td></tr><tr><td>openc3-nfs *</td><td>Network File System pod only for use in Kubernetes to share code libraries between containers</td></tr></tbody></table>
23
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="docker-compose">Docker Compose<a href="#docker-compose" class="hash-link" aria-label="Direct link to Docker Compose" title="Direct link to Docker Compose">​</a></h3>
24
- <p>Per <a href="https://docs.docker.com/compose/" target="_blank" rel="noopener noreferrer">Docker</a>, &quot;Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application&#x27;s services. Then, with a single command, you create and start all the services from your configuration.&quot; OpenC3 uses compose files to both build and run COSMOS. The <a href="https://github.com/OpenC3/cosmos-project/blob/main/compose.yaml" target="_blank" rel="noopener noreferrer">compose.yaml</a> is where ports are exposed and environment variables are used.</p>
25
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="environment-file">Environment File<a href="#environment-file" class="hash-link" aria-label="Direct link to Environment File" title="Direct link to Environment File">​</a></h3>
26
- <p>COSMOS uses an <a href="https://docs.docker.com/compose/environment-variables/env-file/" target="_blank" rel="noopener noreferrer">environment file</a> along with Docker Compose to pass environment variables into the COSMOS runtime. This <a href="https://github.com/OpenC3/cosmos-project/blob/main/.env" target="_blank" rel="noopener noreferrer">.env</a> file consists of simple key value pairs that contain the version of COSMOS deployed, usernames and passwords, and much more.</p>
27
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="kubernetes">Kubernetes<a href="#kubernetes" class="hash-link" aria-label="Direct link to Kubernetes" title="Direct link to Kubernetes">​</a></h3>
28
- <p>Per <a href="https://kubernetes.io/" target="_blank" rel="noopener noreferrer">Kubernetes.io</a>, &quot;Kubernetes, also known as K8s, is an open-source system for automating deployment, scaling, and management of containerized applications. It groups containers that make up an application into logical units for easy management and discovery.&quot; <a href="https://openc3.com/enterprise" target="_blank" rel="noopener noreferrer">COSMOS Enterprise</a> provides <a href="https://helm.sh/docs/topics/charts/" target="_blank" rel="noopener noreferrer">Helm charts</a> for easy deployment to Kubernetes in various cloud environments.</p>
29
- <p>COSMOS Enterprise also provides <a href="https://www.terraform.io/" target="_blank" rel="noopener noreferrer">Terraform</a> scripts to deploy COSMOS infrastructure on various cloud environments.</p>
30
- <h2 class="anchor anchorWithStickyNavbar_fF9Z" id="frontend">Frontend<a href="#frontend" class="hash-link" aria-label="Direct link to Frontend" title="Direct link to Frontend">​</a></h2>
31
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="vuejs">Vue.js<a href="#vuejs" class="hash-link" aria-label="Direct link to Vue.js" title="Direct link to Vue.js">​</a></h3>
32
- <p>The COSMOS frontend is fully browser native and is implemented in the Vue.js framework. Per <a href="https://vuejs.org/guide/introduction.html" target="_blank" rel="noopener noreferrer">Vue.js</a>, &quot;Vue is a JavaScript framework for building user interfaces. It builds on top of standard HTML, CSS, and JavaScript and provides a declarative and component-based programming model that helps you efficiently develop user interfaces, be they simple or complex.&quot; COSMOS utilizes Vue.js and the <a href="https://vuetifyjs.com/en/" target="_blank" rel="noopener noreferrer">Vuetify</a> Component Framework UI library to build all the COSMOS tools which run in the browser of your choice.</p>
33
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="single-spa">Single-Spa<a href="#single-spa" class="hash-link" aria-label="Direct link to Single-Spa" title="Direct link to Single-Spa">​</a></h3>
34
- <p>While COSMOS itself is written in Vue.js, we utilize a technology called <a href="https://single-spa.js.org/" target="_blank" rel="noopener noreferrer">single-spa</a> to allow COSMOS developers to create applications in any javascript framework they choose. Single-spa is a micro frontend framework and acts as a top level router to render the application being requested. COSMOS provides sample applications ready to plug into single-spa in Angular, React, Svelte, and Vue.</p>
35
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="astro-ux">Astro UX<a href="#astro-ux" class="hash-link" aria-label="Direct link to Astro UX" title="Direct link to Astro UX">​</a></h3>
36
- <p>Per <a href="https://www.astrouxds.com/" target="_blank" rel="noopener noreferrer">AstroUXDS</a>, &quot;The Astro Space UX Design System enables developers and designers to build rich space app experiences with established interaction patterns and best practices.&quot; COSMOS utilizes the Astro design guidelines for color, typograpy, and iconograpy. In some cases, e.g. <a href="https://www.astrouxds.com/components/clock/" target="_blank" rel="noopener noreferrer">Astro Clock</a>, COSMOS directly incorporates Astro components.</p>
37
- <h2 class="anchor anchorWithStickyNavbar_fF9Z" id="backend">Backend<a href="#backend" class="hash-link" aria-label="Direct link to Backend" title="Direct link to Backend">​</a></h2>
38
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="redis">Redis<a href="#redis" class="hash-link" aria-label="Direct link to Redis" title="Direct link to Redis">​</a></h3>
39
- <p><a href="https://redis.io/" target="_blank" rel="noopener noreferrer">Redis</a> is an in-memory data store with support for strings, hashes, lists, sets, sorted sets, streams, and more. COSMOS uses Redis to store both our configuration and data. If you look back at our <a href="/tools/staticdocs/docs/getting-started/key_concepts#containers">container list</a> you&#x27;ll notice two redis containers: cosmos-openc3-redis-1 and cosmos-openc3-redis-ephemeral-1. The ephemeral container contains all the real-time data pushed into <a href="https://redis.io/docs/data-types/streams/" target="_blank" rel="noopener noreferrer">Redis streams</a>. The other redis container contains COSMOS configuration that is meant to persist. <a href="https://openc3.com/enterprise" target="_blank" rel="noopener noreferrer">COSMOS Enterprise</a> provides helm charts that setup <a href="https://redis.io/docs/management/scaling/" target="_blank" rel="noopener noreferrer">Redis Cluster</a> to perform horizontal scaling where data is shared across multiple Redis nodes.</p>
40
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="minio">MinIO<a href="#minio" class="hash-link" aria-label="Direct link to MinIO" title="Direct link to MinIO">​</a></h3>
41
- <p><a href="https://min.io/" target="_blank" rel="noopener noreferrer">MinIO</a> is a high-performance, S3 compatible object store. COSMOS uses this storage technology to host both the COSMOS tools themselves and the long term log files. <a href="https://openc3.com/enterprise" target="_blank" rel="noopener noreferrer">COSMOS Enterprise</a> deployed in a cloud environment uses the available cloud native bucket storage technology, e.g. AWS S3, GCP Buckets, and Azure Blob Storage. Using bucket storage allows COSMOS to directly serve the tools as a static website and thus we don&#x27;t need to deploy Tomcat or Nginx for example.</p>
42
- <h3 class="anchor anchorWithStickyNavbar_fF9Z" id="ruby-on-rails">Ruby on Rails<a href="#ruby-on-rails" class="hash-link" aria-label="Direct link to Ruby on Rails" title="Direct link to Ruby on Rails">​</a></h3>
43
- <p>The COSMOS API and Script Runner backends are powered by <a href="https://rubyonrails.org/" target="_blank" rel="noopener noreferrer">Ruby on Rails</a>. Rails is a web application development framework written in the Ruby programming language. Rails (and our familiarity with Ruby) allows us to write less code while accomplishing more than many other languages and frameworks.</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/getting-started/key_concepts.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/getting-started/upgrading"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Upgrading</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/tools/staticdocs/docs/getting-started/requirements"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Requirements and Design</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="#projects" class="table-of-contents__link toc-highlight">Projects</a></li><li><a href="#containerization" class="table-of-contents__link toc-highlight">Containerization</a><ul><li><a href="#images" class="table-of-contents__link toc-highlight">Images</a></li><li><a href="#containers" class="table-of-contents__link toc-highlight">Containers</a></li><li><a href="#docker-compose" class="table-of-contents__link toc-highlight">Docker Compose</a></li><li><a href="#environment-file" class="table-of-contents__link toc-highlight">Environment File</a></li><li><a href="#kubernetes" class="table-of-contents__link toc-highlight">Kubernetes</a></li></ul></li><li><a href="#frontend" class="table-of-contents__link toc-highlight">Frontend</a><ul><li><a href="#vuejs" class="table-of-contents__link toc-highlight">Vue.js</a></li><li><a href="#single-spa" class="table-of-contents__link toc-highlight">Single-Spa</a></li><li><a href="#astro-ux" class="table-of-contents__link toc-highlight">Astro UX</a></li></ul></li><li><a href="#backend" class="table-of-contents__link toc-highlight">Backend</a><ul><li><a href="#redis" class="table-of-contents__link toc-highlight">Redis</a></li><li><a href="#minio" class="table-of-contents__link toc-highlight">MinIO</a></li><li><a href="#ruby-on-rails" class="table-of-contents__link toc-highlight">Ruby on Rails</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>
44
- </body>
45
- </html>
10
+ <table><thead><tr><th>Name<th>Description<tbody><tr><td>cosmos-openc3-cosmos-init-1<td>Copies files to Minio and configures COSMOS then exits<tr><td>cosmos-openc3-operator-1<td>Main COSMOS container that runs the interfaces and target microservices<tr><td>cosmos-openc3-cosmos-cmd-tlm-api-1<td>Rails server that provides all the COSMOS API endpoints<tr><td>cosmos-openc3-cosmos-script-runner-api-1<td>Rails server that provides the Script API endpoints<tr><td>cosmos-openc3-redis-1<td>Serves the static target configuration<tr><td>cosmos-openc3-redis-ephemeral-1<td>Serves the <a href=https://redis.io/docs/data-types/streams target=_blank rel="noopener noreferrer">streams</a> containing the raw and decomutated data<tr><td>cosmos-openc3-minio-1<td>Provides a S3 like bucket storage interface and also serves as a static webserver for the tool files<tr><td>cosmos-openc3-traefik-1<td>Provides a reverse proxy and load balancer with routes to the COSMOS endpoints</table>
11
+ <p>The container list for <a href=https://openc3.com/enterprise target=_blank rel="noopener noreferrer">Enterprise COSMOS</a> consists of the following:</p>
12
+ <table><thead><tr><th>Name<th>Description<tbody><tr><td>cosmos-enterprise-openc3-metrics-1<td>Rails server that provides metrics on COSMOS performance<tr><td>cosmos-enterprise-openc3-keycloak-1<td>Single-Sign On service for authentication<tr><td>cosmos-enterprise-openc3-postgresql-1<td>SQL Database for use by Keycloak<tr><td>openc3-nfs *<td>Network File System pod only for use in Kubernetes to share code libraries between containers</table>
13
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=docker-compose>Docker Compose<a href=#docker-compose class=hash-link aria-label="Direct link to Docker Compose" title="Direct link to Docker Compose">​</a></h3>
14
+ <p>Per <a href=https://docs.docker.com/compose/ target=_blank rel="noopener noreferrer">Docker</a>, "Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application's services. Then, with a single command, you create and start all the services from your configuration." OpenC3 uses compose files to both build and run COSMOS. The <a href=https://github.com/OpenC3/cosmos-project/blob/main/compose.yaml target=_blank rel="noopener noreferrer">compose.yaml</a> is where ports are exposed and environment variables are used.</p>
15
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=environment-file>Environment File<a href=#environment-file class=hash-link aria-label="Direct link to Environment File" title="Direct link to Environment File">​</a></h3>
16
+ <p>COSMOS uses an <a href=https://docs.docker.com/compose/environment-variables/env-file/ target=_blank rel="noopener noreferrer">environment file</a> along with Docker Compose to pass environment variables into the COSMOS runtime. This <a href=https://github.com/OpenC3/cosmos-project/blob/main/.env target=_blank rel="noopener noreferrer">.env</a> file consists of simple key value pairs that contain the version of COSMOS deployed, usernames and passwords, and much more.</p>
17
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=kubernetes>Kubernetes<a href=#kubernetes class=hash-link aria-label="Direct link to Kubernetes" title="Direct link to Kubernetes">​</a></h3>
18
+ <p>Per <a href=https://kubernetes.io/ target=_blank rel="noopener noreferrer">Kubernetes.io</a>, "Kubernetes, also known as K8s, is an open-source system for automating deployment, scaling, and management of containerized applications. It groups containers that make up an application into logical units for easy management and discovery." <a href=https://openc3.com/enterprise target=_blank rel="noopener noreferrer">COSMOS Enterprise</a> provides <a href=https://helm.sh/docs/topics/charts/ target=_blank rel="noopener noreferrer">Helm charts</a> for easy deployment to Kubernetes in various cloud environments.</p>
19
+ <p>COSMOS Enterprise also provides <a href=https://www.terraform.io/ target=_blank rel="noopener noreferrer">Terraform</a> scripts to deploy COSMOS infrastructure on various cloud environments.</p>
20
+ <h2 class="anchor anchorWithStickyNavbar_fF9Z" id=frontend>Frontend<a href=#frontend class=hash-link aria-label="Direct link to Frontend" title="Direct link to Frontend">​</a></h2>
21
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=vuejs>Vue.js<a href=#vuejs class=hash-link aria-label="Direct link to Vue.js" title="Direct link to Vue.js">​</a></h3>
22
+ <p>The COSMOS frontend is fully browser native and is implemented in the Vue.js framework. Per <a href=https://vuejs.org/guide/introduction.html target=_blank rel="noopener noreferrer">Vue.js</a>, "Vue is a JavaScript framework for building user interfaces. It builds on top of standard HTML, CSS, and JavaScript and provides a declarative and component-based programming model that helps you efficiently develop user interfaces, be they simple or complex." COSMOS utilizes Vue.js and the <a href=https://vuetifyjs.com/en/ target=_blank rel="noopener noreferrer">Vuetify</a> Component Framework UI library to build all the COSMOS tools which run in the browser of your choice. COSMOS 5 utilized Vue.js 2.x and Vuetify 2.x while COSMOS 6 utilizes Vue.js 3.x and Vuetify 3.x.</p>
23
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=single-spa>Single-Spa<a href=#single-spa class=hash-link aria-label="Direct link to Single-Spa" title="Direct link to Single-Spa">​</a></h3>
24
+ <p>While COSMOS itself is written in Vue.js, we utilize a technology called <a href=https://single-spa.js.org/ target=_blank rel="noopener noreferrer">single-spa</a> to allow COSMOS developers to create applications in any javascript framework they choose. Single-spa is a micro frontend framework and acts as a top level router to render the application being requested. COSMOS provides sample applications ready to plug into single-spa in Angular, React, Svelte, and Vue.</p>
25
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=astro-ux>Astro UX<a href=#astro-ux class=hash-link aria-label="Direct link to Astro UX" title="Direct link to Astro UX">​</a></h3>
26
+ <p>Per <a href=https://www.astrouxds.com/ target=_blank rel="noopener noreferrer">AstroUXDS</a>, "The Astro Space UX Design System enables developers and designers to build rich space app experiences with established interaction patterns and best practices." COSMOS utilizes the Astro design guidelines for color, typograpy, and iconograpy. In some cases, e.g. <a href=https://www.astrouxds.com/components/clock/ target=_blank rel="noopener noreferrer">Astro Clock</a>, COSMOS directly incorporates Astro components.</p>
27
+ <h2 class="anchor anchorWithStickyNavbar_fF9Z" id=backend>Backend<a href=#backend class=hash-link aria-label="Direct link to Backend" title="Direct link to Backend">​</a></h2>
28
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=redis>Redis<a href=#redis class=hash-link aria-label="Direct link to Redis" title="Direct link to Redis">​</a></h3>
29
+ <p><a href=https://redis.io/ target=_blank rel="noopener noreferrer">Redis</a> is an in-memory data store with support for strings, hashes, lists, sets, sorted sets, streams, and more. COSMOS uses Redis to store both our configuration and data. If you look back at our <a href=/tools/staticdocs/docs/getting-started/key_concepts#containers>container list</a> you'll notice two redis containers: cosmos-openc3-redis-1 and cosmos-openc3-redis-ephemeral-1. The ephemeral container contains all the real-time data pushed into <a href=https://redis.io/docs/data-types/streams/ target=_blank rel="noopener noreferrer">Redis streams</a>. The other redis container contains COSMOS configuration that is meant to persist. <a href=https://openc3.com/enterprise target=_blank rel="noopener noreferrer">COSMOS Enterprise</a> provides helm charts that setup <a href=https://redis.io/docs/management/scaling/ target=_blank rel="noopener noreferrer">Redis Cluster</a> to perform horizontal scaling where data is shared across multiple Redis nodes.</p>
30
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=minio>MinIO<a href=#minio class=hash-link aria-label="Direct link to MinIO" title="Direct link to MinIO">​</a></h3>
31
+ <p><a href=https://min.io/ target=_blank rel="noopener noreferrer">MinIO</a> is a high-performance, S3 compatible object store. COSMOS uses this storage technology to host both the COSMOS tools themselves and the long term log files. <a href=https://openc3.com/enterprise target=_blank rel="noopener noreferrer">COSMOS Enterprise</a> deployed in a cloud environment uses the available cloud native bucket storage technology, e.g. AWS S3, GCP Buckets, and Azure Blob Storage. Using bucket storage allows COSMOS to directly serve the tools as a static website and thus we don't need to deploy Tomcat or Nginx for example.</p>
32
+ <h3 class="anchor anchorWithStickyNavbar_fF9Z" id=ruby-on-rails>Ruby on Rails<a href=#ruby-on-rails class=hash-link aria-label="Direct link to Ruby on Rails" title="Direct link to Ruby on Rails">​</a></h3>
33
+ <p>The COSMOS API and Script Runner backends are powered by <a href=https://rubyonrails.org/ target=_blank rel="noopener noreferrer">Ruby on Rails</a>. Rails is a web application development framework written in the Ruby programming language. Rails (and our familiarity with Ruby) allows us to write less code while accomplishing more than many other languages and frameworks.</div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class=col><a href=https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/getting-started/key_concepts.md target=_blank rel="noopener noreferrer" class=theme-edit-this-page><svg fill=currentColor height=20 width=20 viewBox="0 0 40 40" class=iconEdit_UohW aria-hidden=true><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"/></g></svg>Edit this page</a></div><div class="col lastUpdated_g62E"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href=/tools/staticdocs/docs/getting-started/upgrading><div class=pagination-nav__sublabel>Previous</div><div class=pagination-nav__label>Upgrading</div></a><a class="pagination-nav__link pagination-nav__link--next" href=/tools/staticdocs/docs/getting-started/requirements><div class=pagination-nav__sublabel>Next</div><div class=pagination-nav__label>Requirements and Design</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=#projects class="table-of-contents__link toc-highlight">Projects</a><li><a href=#containerization class="table-of-contents__link toc-highlight">Containerization</a><ul><li><a href=#images class="table-of-contents__link toc-highlight">Images</a><li><a href=#containers class="table-of-contents__link toc-highlight">Containers</a><li><a href=#docker-compose class="table-of-contents__link toc-highlight">Docker Compose</a><li><a href=#environment-file class="table-of-contents__link toc-highlight">Environment File</a><li><a href=#kubernetes class="table-of-contents__link toc-highlight">Kubernetes</a></ul><li><a href=#frontend class="table-of-contents__link toc-highlight">Frontend</a><ul><li><a href=#vuejs class="table-of-contents__link toc-highlight">Vue.js</a><li><a href=#single-spa class="table-of-contents__link toc-highlight">Single-Spa</a><li><a href=#astro-ux class="table-of-contents__link toc-highlight">Astro UX</a></ul><li><a href=#backend class="table-of-contents__link toc-highlight">Backend</a><ul><li><a href=#redis class="table-of-contents__link toc-highlight">Redis</a><li><a href=#minio class="table-of-contents__link toc-highlight">MinIO</a><li><a href=#ruby-on-rails class="table-of-contents__link toc-highlight">Ruby on Rails</a></ul></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></ul></div><div class="col footer__col"><div class=footer__title>Docs</div><ul class="footer__items clean-list"><li class=footer__item><a class=footer__link-item href=/tools/staticdocs/docs>Documentation</a></ul></div><div class="col footer__col"><div class=footer__title>Community</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://www.linkedin.com/company/openc3 target=_blank rel="noopener noreferrer" class=footer__link-item>LinkedIn<svg width=13.5 height=13.5 aria-hidden=true viewBox="0 0 24 24" class=iconExternalLink_awgD><path fill=currentColor d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></svg></a></ul></div><div class="col footer__col"><div class=footer__title>More</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://github.com/OpenC3/cosmos target=_blank rel="noopener noreferrer" class=footer__link-item>GitHub<svg width=13.5 height=13.5 aria-hidden=true viewBox="0 0 24 24" class=iconExternalLink_awgD><path fill=currentColor d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></svg></a><li class=footer__item><a class=footer__link-item href=/tools/staticdocs/docs/privacy>Privacy</a></ul></div></div><div class="footer__bottom text--center"><div class=footer__copyright>Copyright © 2024 OpenC3, Inc.</div></div></div></footer></div>