Make remote help ready on your server

Make remote help ready on your server

Remote help on the BGPVR Player app (see a viewer's app screen, press its buttons, change its settings) needs three things from your server. Settings › Clients & privacy › Remote help readiness checks all three through your own web address and shows the command for each red line, filled in for your install. MAG boxes need none of this. Kodi boxes (the BGPVR Kodi add-on) are listed in Devices but have no remote help.

1. Name your reverse proxy. The suite believes "this came over https" and "this is a picture" only from a proxy you named. Until then it is in auto mode and remote help on the app stays off. Run on the server (127.0.0.1 when nginx runs on the same machine, else the proxy's own address; no restart needed):

   docker exec bgpvr python3 -c "import sys; sys.path.insert(0, '/app/backend'); from bgpvr.config import set_setting; set_setting('trusted_proxy_cidrs', '127.0.0.1/32')"

   If you set BGPVR_TRUSTED_PROXIES in your docker-compose.yml, that wins over the setting: change it there and restart the container instead.
2. Add the picture locations to your proxy. Screen pictures must stay in memory: they are never written to your proxy's disk, a cache or a log. Write this install's picture key into a file only nginx reads (the key goes through the pipe and never shows on screen):

   docker exec bgpvr python3 -c "import sys; sys.path.insert(0, '/app/backend'); from bgpvr.config import get_setting; print('proxy_set_header X-BGPVR-Picture-Path %s;' % get_setting('remote_help_picture_key', ''))" | sudo install -m 600 /dev/stdin /etc/nginx/bgpvr-picture-key.conf

   then add these two locations to the https server block of your console's address, above location / (change 127.0.0.1:8095 to what your location / uses), and reload:

   location ~ ^/api/client/device/remote-help/[0-9]+/screen$ {
       client_max_body_size 1m;
       client_body_buffer_size 1m;
       proxy_request_buffering on;
       include /etc/nginx/bgpvr-picture-key.conf;
       proxy_pass http://127.0.0.1:8095;
       proxy_set_header Host $host;
       proxy_set_header X-Real-IP $remote_addr;
       proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
       proxy_set_header X-Forwarded-Proto $scheme;
   }
   location ~ ^/api/remote-help/[0-9]+/screen$ {
       proxy_buffering off;
       proxy_max_temp_file_size 0;
       proxy_pass http://127.0.0.1:8095;
       proxy_set_header Host $host;
       proxy_set_header X-Real-IP $remote_addr;
       proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
       proxy_set_header X-Forwarded-Proto $scheme;
   }

   sudo nginx -t && sudo systemctl reload nginx

   Without it the keys and actions work, and the console says "Live screen needs the server update".
3. Use https. The app never takes remote help on an http:// address. With nginx and Let's Encrypt: sudo certbot --nginx -d your.domain, then open the console on https.
4. Open Settings › Clients & privacy › Remote help readiness and press Check again: all three lines say Ready.

docker exec bgpvr python3 -c "import secrets, sys; sys.path.insert(0, '/app/backend'); from bgpvr.config import set_setting; set_setting('remote_help_picture_key', secrets.token_hex(32))"

In the console: Make remote help ready on your server

docker exec bgpvr python3 -c "import sys; sys.path.insert(0, '/app/backend'); from bgpvr.config import set_setting; set_setting('trusted_proxy_cidrs', '127.0.0.1/32')"