Deployed c6bcaf6 with MkDocs version: 1.6.0

HowToHelp/FTSConfig.yaml

@@ -0,0 +1,43 @@
+System:
+  #FTS_DATABASE_TYPE: SQLite
+  FTS_CONNECTION_MESSAGE: Welcome to FreeTAKServer FreeTAKServer-2.X alpha. 
+    The Parrot is not dead. It’s just resting
+  #FTS_OPTIMIZE_API: True
+  #FTS_MAINLOOP_DELAY: 1
+Addresses:
+  #FTS_COT_PORT: 8087
+  #FTS_SSLCOT_PORT: 8089
+  FTS_DP_ADDRESS: 192.168.100.105
+  FTS_USER_ADDRESS: 192.168.100.105
+  #FTS_API_PORT: 19023
+  #FTS_FED_PORT: 9000
+  #FTS_API_ADDRESS: 0.0.0.0
+  FTS_FIRST_START: false
+Filesystem:
+  FTS_DB_PATH: [PATH]\\FreeTakServer\\FreeTAKServer.db
+  #FTS_COT_TO_DB: True
+  FTS_MAINPATH:  [PATH]\\FreeTakServer\\FreeTAKServer
+  FTS_CERTS_PATH: [PATH]\\FreeTakServer\\FreeTAKServerCerts
+  FTS_EXCHECK_PATH: [PATH]\\FreeTakServer\\ExCheck
+  FTS_EXCHECK_TEMPLATE_PATH: [PATH]\\FreeTakServer\\ExCheck\\template
+  FTS_EXCHECK_CHECKLIST_PATH: [PATH]\\FreeTakServer\\ExCheck\\checklist
+  FTS_DATAPACKAGE_PATH: [PATH]\\FreeTakServer\\FreeTAKServerDataPackageFolder
+  FTS_LOGFILE_PATH: [PATH]\\FreeTakServer\\FreeTakServerLogs
+  FTS_CORE_COMPONENTS_PATH: \\home\\ariel\\Workspace\\FTAK\\FreeTakServer\\FreeTAKServer\\components\\core
+  FTS_EXTERNAL_COMPONENTS_PATH: [PATH]\\FreeTakServer\\components\\extended
+  FTS_CLIENT_PACKAGES: [PATH]\\FreeTakServer\\FreeTAKServerCerts\\clientPackages
+Certs:
+  FTS_SERVER_KEYDIR: [PATH]\\FreeTakServer\\FreeTAKServerCerts\\server.key
+  FTS_SERVER_PEMDIR: [PATH]\\FreeTakServer\\FreeTAKServerCerts\\server.pem
+  FTS_TESTCLIENT_PEMDIR: [PATH]\\FreeTakServer\\FreeTAKServerCerts\\Client.pem
+  FTS_TESTCLIENT_KEYDIR: [PATH]\\FreeTakServer\\FreeTAKServerCerts\\Client.key
+  FTS_UNENCRYPTED_KEYDIR: [PATH]\\FreeTakServer\\FreeTAKServerCerts\\server.key.unencrypted
+  FTS_SERVER_P12DIR: [PATH]\\FreeTakServer\\FreeTAKServerCerts\\server.p12
+  FTS_CADIR: [PATH]\\FreeTakServer\\FreeTAKServerCerts\\ca.pem
+  FTS_CAKEYDIR: [PATH]\\FreeTakServer\\FreeTAKServerCerts\\ca.key
+  FTS_FEDERATION_CERTDIR: [PATH]\\FreeTakServer\\FreeTAKServerCerts\\server.pem
+  FTS_FEDERATION_KEYDIR: [PATH]\\FreeTakServer\\FreeTAKServerCerts\\server.key
+  FTS_CRLDIR: [PATH]\\FreeTakServer\\FreeTAKServerCerts\\FTS_CRL.json
+  FTS_FEDERATION_KEYPASS: demopassfed
+  FTS_CLIENT_CERT_PASSWORD: demopasscert
+  FTS_WEBSOCKET_KEY: YourWebsocketKey

HowToHelp/fts-dev-env.yml

@@ -0,0 +1,35 @@
+name: fts-dev
+channels:
+- conda-forge
+dependencies:
+- coverage>=7.3.2
+- coveralls>=1.8.0
+- email-validator>=2.1.0.post1
+- flake8>=6.1.0
+- flake8-print>=5.0.0
+- flask>=3.0.0
+- flask-login>=0.6.3
+- flask-migrate>=4.0.5
+- flask-wtf>=1.2.1
+- flask-testing>=0.8.0
+- lxml>=4.9.3
+- nose>=1.3.7
+- pluggy>=1.3.0
+- pathlib>=1.0.1
+- pep8-naming>=0.13.3
+- platformdirs>=4.0.0
+- pycairo>=1.25.1
+- python=3.11
+- selenium>=4.15.2
+- setuptools>=68.2.2
+- tabulate>=0.9.0
+- tox>=4.11.4
+- vim>=9.0.2059
+- waitress>=2.1.2
+- pytest>=7.4.3
+- pytest-pep8>=1.0.6
+- pytest-cov>=4.1.0
+- pip>=23.3.1
+- pip:
+    - pytak>=6.2.0
+    - randomize>=0.14

HowToHelp/fts-doc-env.yml

@@ -0,0 +1,18 @@
+name: fts-doc
+channels:
+  - conda-forge
+dependencies:
+    - python=3.11
+    - mkdocs
+    - mkdocs-material
+    - mkdocs-material-extensions
+    - mike
+    # - mkdocs-jupyter
+    - markdown-include
+    - pip
+    - pip:
+        - mkdocs-awesome-pages-plugin
+        - mkdocs-section-index
+        - mkdocs-pdf-export-plugin
+        - mkdocs-mermaid2-plugin
+        - mkdocs_puml

Installation/platform/Windows/MainConfig.py

@@ -0,0 +1,92 @@
+# -*- encoding: utf-8 -*-
+
+import os
+from pathlib import Path
+
+currentPath = os.path.dirname(os.path.abspath(__file__))
+
+
+class MainConfig:
+    """
+    this is the main configuration file and is the only one which
+    should need to be changed
+    """
+    # this is the port to which clients will connect
+    CoTServicePort = int(8087)
+
+    SSLCoTServicePort = int(8089)
+
+    # this needs to be changed for private data packages to work
+    DataPackageServiceDefaultIP = str("0.0.0.0")
+
+    # User Connection package IP needs to be set to the IP which is used when creating the connection in your tak device
+    UserConnectionIP = str("0.0.0.0")
+
+    # python_version = 'python3.8'
+
+    # userpath = '/usr/local/lib/'
+
+    # api port
+    APIPort = 19023
+
+    # Federation port
+    FederationPort = 9000
+
+    # api IP
+    APIIP = '0.0.0.0'
+
+    # allowed ip's to access CLI commands
+    AllowedCLIIPs = ['127.0.0.1']
+
+    # IP for CLI to access
+    CLIIP = '127.0.0.1'
+
+    # whether to save CoT's to the DB
+    SaveCoTToDB = bool(True)
+
+    # this should be set before startup
+    DBFilePath = str(r'C:\\Software\\python\\Lib\\site-packages\\FreeTAKServer\\FTSDataBase.db')
+
+    # the version information of the server (recommended to leave as default)
+    version = 'FreeTAKServer-1.5.12 RC1'
+
+    MainPath = str(Path(fr'C:\\Software\\python\\Lib\\site-packages\\FreeTAKServer'))
+
+    ExCheckMainPath = str(Path(fr'{MainPath}\\ExCheck'))
+
+    ExCheckFilePath = str(Path(fr'{MainPath}\\ExCheck\\template'))
+
+    ExCheckChecklistFilePath = str(Path(fr'{MainPath}\\ExCheck\\checklist'))
+
+    DataPackageFilePath = str(Path(fr'{MainPath}\\FreeTAKServerDataPackageFolder'))
+
+    # format of API message header should be {Authentication: Bearer 'TOKEN'}
+    from uuid import uuid4
+    id = str(uuid4())
+
+    nodeID = f"FreeTAKServer-{id}"
+
+    # set to None if you don't want a message sent
+    ConnectionMessage = f'Welcome to FreeTAKServer {version}. The Parrot is not dead. It’s just resting'
+
+    keyDir = str(Path(fr'{MainPath}\\certs\\pubserver.key'))
+
+    pemDir = str(Path(fr'{MainPath}\\certs\\pubserver.pem'))  # or crt
+
+    unencryptedKey = str(Path(fr'{MainPath}\\certs\\pubserver.key.unencrypted'))
+
+    p12Dir = str(Path(fr'{MainPath}\\certs\\pubserver.p12'))
+
+    CA = str(Path(fr'{MainPath}\\certs\\ca.pem'))
+    CAkey = str(Path(fr'{MainPath}\\certs\\ca.key'))
+
+    federationCert = str(Path(fr'{MainPath}\\certs\\pubserver.pem'))
+    federationKey = str(Path(fr'{MainPath}\\certs\\pubserver.key'))
+    federationKeyPassword = str('defaultpass')
+
+    # location to back up client packages
+    clientPackages = str(Path(fr'{MainPath}\\certs\\ClientPackages'))
+
+    password = str('defaultpass')
+
+    websocketkey = "YourWebsocketKey"

Installation/platform/Windows/StartFreeTAKServer.bat

@@ -0,0 +1,8 @@
+::START THE SERVER
+ECHO ON
+start cmd /k python -m FreeTAKServer.controllers.services.FTS
+::WHEN RUNNING THE SCRIPT FROM A DIFFERENT DRIVE ADD THE `/D` SWITCH TO YOUR CD COMMAND
+CD C:\Software\python\Lib\site-packages\FreeTAKServer-UI
+set FLASK_APP=run.py
+flask run
+pause