Local debug console

(Optional) To view the local debug console on your development computer, you can forward the console's port over SSH. However, you must first enable the AllowTcpForwarding option in your core device's SSH configuration file. This option is enabled by default. Run the following command on your development computer to view the dashboard at localhost:1441 on your development computer.

ssh -L 1441:localhost:1441 -L 1442:localhost:1442 username@core-device-ip-address

Create a session to use the local debug console. When you create a session, you generate a password that you use to authenticate. The local debug console requires a password to increase security, because you can use this component to view important information and perform operations on the core device. The local debug console also creates a certificate to secure the connection if you enable HTTPS in the component configuration. HTTPS is enabled by default.

Use the AWS IoT Greengrass CLI to create the session. This command generates a random 43-character password that expires after 8 hours. Replace /greengrass/v2 or C:\greengrass\v2 with the path to the AWS IoT Greengrass V2 root folder.

The command output looks like the following example if you have configured the local debug console to use HTTPS. You use the certificate fingerprints to verify that the connection is secure when you open the local debug console.

Username: debug
Password: bEDp3MOHdj8ou2w5de_sCBI2XAaguy3a8XxREXAMPLE
Password expires at: 2021-04-01T17:01:43.921999931-07:00
The local debug console is configured to use TLS security. The certificate is self-signed so you will need to bypass your web browser's security warnings to open the console.
Before you bypass the security warning, verify that the certificate fingerprint matches the following fingerprints.
SHA-256: 15 0B 2C E2 54 8B 22 DE 08 46 54 8A B1 2B 25 DE FB 02 7D 01 4E 4A 56 67 96 DA A6 CC B1 D2 C4 1B
SHA-1: BC 3E 16 04 D3 80 70 DA E0 47 25 F9 90 FA D6 02 80 3E B5 C1

The debug view component creates a session that lasts for 8 hours. After that, you must generate a new password to view the local debug console again.

Open and sign in to the dashboard. View the dashboard on your Greengrass core device, or on your development computer if you forward the port over SSH. Do one of the following:

• If you enabled HTTPS in the local debug console, which is the default setting, do the following:

  1. Open https://localhost:1441 on your core device, or on your development computer if you forwarded the port over SSH.

     Your browser might show a security warning about an invalid security certificate.

  2. If your browser shows a security warning, verify the certificate is legitimate and bypass the security warning. Do the following:

     1. Find the SHA-256 or SHA-1 fingerprint for the certificate, and verify that it matches the SHA-256 or SHA-1 fingerprint that the get-debug-password command previously printed. Your browser might provide one or both fingerprints. Consult your browser's documentation to view the certificate and its fingerprints. In some browsers, the certificate fingerprint is called a thumbprint.

        Note

        If the certificate fingerprint doesn't match, go to Step 2 to create a new session. If the certificate fingerprint still doesn't match, your connection might be insecure.

     2. If the certificate fingerprint matches, bypass your browser's security warning to open the local debug console. Consult your browser's documentation to bypass the browser security warning.

  3. Sign in to the website using the user name and password that the get-debug-password command printed earlier.

     The local debug console opens.

  4. If the local debug console shows an error that says it can't connect to the WebSocket due to a failed TLS handshake, you must bypass the self-signed security warning for the WebSocket URL.

     

     Do the following:

     1. Open https://localhost:1442 in the same browser where you opened the local debug console.

     2. Verify the certificate and bypass the security warning.

        Your browser might show an HTTP 404 page after you bypass the warning.

     3. Open https://localhost:1441 again.

        The local debug console shows information about the core device.

• If you disabled HTTPS in the local debug console, do the following:

  1. Open http://localhost:1441 on your core device, or open it on your development computer if you forwarded the port over SSH.

  2. Sign in to the website using the user name and password that the get-debug-password command previously printed.

     The local debug console opens.

(Optional) To view the local debug console on your development computer, you can forward the console's port over SSH. However, you must first enable the AllowTcpForwarding option in your core device's SSH configuration file. This option is enabled by default. Run the following command on your development computer to view the dashboard at localhost:1441 on your development computer.

ssh -L 1441:localhost:1441 -L 1442:localhost:1442 username@core-device-ip-address

Create a session to use the local debug console. When you create a session, you generate a password that you use to authenticate. The local debug console requires a password to increase security, because you can use this component to view important information and perform operations on the core device.

Use the AWS IoT Greengrass CLI to create the session. This command generates a random 43-character password that expires after 8 hours. Replace /greengrass/v2 or C:\greengrass\v2 with the path to the AWS IoT Greengrass V2 root folder.

The command output looks like the following example.

Username: debug
Password: bEDp3MOHdj8ou2w5de_sCBI2XAaguy3a8XxREXAMPLE
Password will expire at: 2021-04-01T17:01:43.921999931-07:00

The debug view component creates a session lasts for 4 hours, and then you must generate a new password to view the local debug console again.

Open http://localhost:1441 on your core device, or open it on your development computer if you forwarded the port over SSH.

Sign in to the website using the user name and password that the get-debug-password command previously printed.

The local debug console opens.