More CloudTAK updates

Author: brian7704

docs/cloudtak.md

@@ -1,40 +1,24 @@
 # CloudTAK
 
-OpenTAKServer is compatible with [CloudTAK](https://github.com/dfpc-coe/CloudTAK), a fully featured, in-browser TAK client.
+OpenTAKServer is compatible with [CloudTAK](https://github.com/dfpc-coe/CloudTAK), a fully featured, in-browser TAK client. If you need support, please ask in the OTS discord rather than contacting COTAK (the creators of CloudTAK).
 
-## Notes
+## Domain Name and Certificates
 
-CloudTAK has only been tested using an FQDN with a trusted certificate (i.e. Let's Encrypt). It may still work without an FQDN or trusted cert, but SSL is always required.
-For best results you should create a subdomain. For example, if your FQDN is `example.com`, your subdomain could be `cloudtak.example.com`.
+CloudTAK requires a domain name and subdomain names in addition to a Let's Encrypt certificate on the server.
 
-If you need support, please ask in the OTS discord rather than contacting COTAK (the creators of CloudTAK).
+* `ots.example.com` - Points to OpenTAKServer.
+* `cloudtak.example.com` - Points to the CloudTAK web UI.
+* `tiles.cloudtak.example.com` - This is a sub-subdomain for CloudTAK's map tile server.
+* `video.example.com` - CloudTAK's MediaMTX server. This is optional as video streaming from OTS to CloudTAK is not working at this time. However this subdomain will be required once streaming is working.
 
-## Installation
-
-This guide assume that you're installing CloudTAK on the same server as OpenTAKServer.
-
-### Docker
-
-Run these commands to install Docker on Ubuntu. If you're not using Ubuntu, check the Docker docs on how to install for your distro.
+## Known Issues
 
-```shell
-sudo apt update
-sudo apt install ca-certificates curl
-sudo install -m 0755 -d /etc/apt/keyrings
-sudo curl -fsSL https://download.docker.com/linux/ubuntu/gpg -o /etc/apt/keyrings/docker.asc
-sudo chmod a+r /etc/apt/keyrings/docker.asc
+* Video streaming currently doesn't work
+* Uploading files and data packages doesn't work
 
-# Add the repository to Apt sources:
-echo \
-  "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/ubuntu \
-  $(. /etc/os-release && echo "${UBUNTU_CODENAME:-$VERSION_CODENAME}") stable" | \
-  sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
-sudo apt update
-
-sudo apt install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin
-```
+## Installation
 
-### CloudTAK
+This guide assume that you're installing CloudTAK on the same server as OpenTAKServer. The CloudTAK installer script only works on Ubuntu.
 
 1. Clone the CloudTAK repo
 
@@ -43,8 +27,9 @@ git clone https://github.com/dfpc-coe/CloudTAK.git
 cd CloudTAK
 ```
 
-2. Change `API_URL` in docker_compose.yml. It should be prefixed with `https://` and should be changed to the IP or FQDN that you'll use to access it. You should also remove `:5000` at the end. It cannot be localhost unless you're installing CloudTAK to the same computer you'll be accessing it from.
-3. Configure the nginx proxy. Copy the config below and paste it to a new file at `/etc/nginx/sites-available/cloudtak`. You also need to change the `server_name` line to your FQDN.
+2. Run the CloudTAK installer script `./cloudtak.sh install`. This script will install CloudTAK as well as docker and all prerequisites.
+3. Run `./cloudtak.sh start` to start the docker containers.
+4. Configure the nginx proxy. Copy the config below and paste it to a new file at `/etc/nginx/sites-available/cloudtak`. You also need to change the `server_name` line to your FQDN.
 
 ```nginx
 server {
@@ -64,9 +49,6 @@ server {
            proxy_buffering off;
            proxy_set_header Upgrade $http_upgrade;
            proxy_set_header Connection "upgrade";
-           #proxy_hide_header Authorization;
-           #proxy_set_header Referer '';
-           #proxy_set_header Origin '';
    }
 
 listen 80;
@@ -79,7 +61,7 @@ server {
    # Add index.php to the list if you are using PHP
    index index.html index.htm index.nginx-debian.html;
 
-   server_name tiles.cloudtak.anhangueramilsim.com.br; # <------- Change this to your FQDN
+   server_name tiles.cloudtak.example.com; # <------- Change this to your FQDN
 
    location / {
            
@@ -91,13 +73,6 @@ server {
            proxy_set_header Upgrade $http_upgrade;
            proxy_set_header Connection "upgrade";
            proxy_set_header Referer $scheme://$host/;
-           #proxy_hide_header Authorization;
-           #proxy_set_header Referer '';
-           #proxy_set_header Origin '';
-           #proxy_set_header Origin '$http_origin' ;
-           #proxy_set_header Origin 'http://localhost:5002';
-           #add_header 'Access-Control-Allow-Origin' '*';
-           #add_header 'Access-Control-Allow-Headers' 'Content-Type';
 
    }
 
@@ -107,13 +82,13 @@ listen 80;
 }
 ```
 
-4. Create a symbolic link to enable the new nginx config file.
+5Create a symbolic link to enable the new nginx config file.
 
 ```bash
 sudo ln -s /etc/nginx/sites-available/cloudtak /etc/nginx/sites-enabled/cloudtak
 ```
 
-5. Edit `/etc/nginx/sites-available/ots_certificate_enrollment` and add the following inside the `server {}` stanza.
+6. Edit `/etc/nginx/sites-available/ots_certificate_enrollment` and add the following inside the `server {}` stanza if it doesn't already exist.
 
 ```nginx
         location /oauth {
@@ -127,7 +102,7 @@ sudo ln -s /etc/nginx/sites-available/cloudtak /etc/nginx/sites-enabled/cloudtak
         }
 ```
 
-6. Edit `/etc/nginx/sites-available/ots_https` and add this inside the listen 8443 `server {}`.
+7. Edit `/etc/nginx/sites-available/ots_https` and add this inside the listen 8443 `server {}` if it doesn't already exist.
 
 ```nginx
         location /files {
@@ -141,7 +116,7 @@ sudo ln -s /etc/nginx/sites-available/cloudtak /etc/nginx/sites-enabled/cloudtak
         }
 ```
 
-7. Install certbot and nginx `sudo apt install nginx certbot python3-certbot-nginx -y`
-8. Get a cert from Let's Encrypt `sudo certbot --nginx`
-9. Restart nginx `sudo systemctl restart nginx`
-10. Open a browser and enter your CloudTAK server's URL, i.e. https://cloudtak.example.com
+8. Install certbot and nginx `sudo apt install nginx certbot python3-certbot-nginx -y`
+9. Get a cert from Let's Encrypt `sudo certbot --nginx`
+10. Restart nginx `sudo systemctl restart nginx`
+11. Open a browser and enter your CloudTAK server's URL, i.e. https://cloudtak.example.com