# Installation guide

## Supported platforms

* **i.MX 8**
  * CCPilot V510
  * CCPilot V700
  * CCPilot V710
  * CCPilot V1000
  * CCPilot V1200
  * CCPilot V1090
  * CCPilot V1290
  
## Prerequisites

### v1.4.+

* CCL 4.+ OS
* Qt-6.8 Runtime

## Unlock /appfs for development/testing
For experimental testing, a quick way to deploy ccwebbrowser is to format /appfs and make it writable by ccs user.
Real deployment should use RAUC package to deploy browser and Qt runtime in one bundle.

1. Open an ssh session to the target <code>ssh ccs\<ip-address></code>
2. Check which version partition /appfs is mounted to <code>rauc status</code>
3. Unmount /appfs <code>sudo umount /appfs</code>
4. Format the partition <code>sudo mkfs.ext4 /dev/\<partition></code>
5. Remount /appfs <code>sudo mount /dev/\<partition> /appfs</code>
6. Make it writable for ccs user during test: <code>chown -R ccs /appfs</code>

## Installing CC Web browser

1. Download `ccwebbrowser_1.4.2_<target-display>.tar.gz` from the support site under:  
`Web browser module -> Downloads -> Device Download -> CC Linux 5.0 -> <target-display>`
2. Transfer the tarball to the device <code>scp ccwebbrowser_1.4.2_<target-display>.tar.gz ccs@\<ip-address>:/tmp</code>
3. Open an ssh session to the target <code>ssh ccs@\<ip-address></code>
4. Change directory to /appfs <code>cd /appfs</code>
5. Move the tarball to /appfs <code>sudo mv /tmp/ccwebbrowser_1.4.2_<target-display>.tar.gz .</code>
6. Unpack the tarball to /appfs <code>sudo tar xzf ccwebbrowser_1.4.2_<target-display>.tar.gz</code>
7. Edit the <code>/appfs/ccwebbrowser/config/browser.conf</code> file to add your url.
8. By default the web browser is running with Qt platform <code>-platform eglfs</code>. If the browser should run as a wayland client, edit the ccwebbrowser.service systemd script and change the platform to <code>-platform wayland</code> instead.
9. Enable the systemd service file to automatically start the web browser <code>sudo systemctl enable ccwebbrowser</code>
10. Download and extract qt-runtime-<target-display>-6.8.3-5.0.0.0.tar.gz to /appfs folder.
10. Now the web browser should automatically start at boot

## Create a RAUC bundle

Reference the `CC Linux - Using RAUC` documentation on the support web site for more information about how to generate a RAUC bundle.
A appfs partition created as above can be used in the RAUC package to create a deployment package.

## Troubleshooting

Please refer to our [KnowledgeBase](https://support.crosscontrol.com/knowledge-base) for further information and troubleshooting guides.