Chapter 2. Deploy the Red Hat Offline Knowledge Portal on your network

Procedure

1. Use Podman to download the Red Hat Offline Knowledge Portal:

   1. Enter the following command in a terminal and use your Customer Portal, Red Hat Developer, or registry service account credentials to log in to registry.redhat.io:

      $ podman login registry.redhat.io
      username: <username>
      Password: <password>

      Copy to Clipboard Toggle word wrap

      where:

      <username>

      Specifies your Customer Portal, Red Hat Developer, or registry service account user name.

      <password>

      Specifies your Customer Portal, Red Hat Developer, or registry service account password.

   2. Download the Red Hat Offline Knowledge Portal image:

      $ podman pull registry.redhat.io/offline-knowledge-portal/rhokp-rhel9:latest

      Copy to Clipboard Toggle word wrap

2. If you are deploying the Red Hat Offline Knowledge Portal on an offline network, complete the following steps:

   1. To convert the image to a file that you can transfer to your offline environment, save the image to a TAR file:

      podman save --format oci-archive -o rhokp.tar rhokp-rhel9:latest

      Copy to Clipboard Toggle word wrap
   2. Use a method approved by your organization to transfer the rhokp.tar file to your offline environment.

   3. To load the image in your offline environment, enter the following command:

      podman load -i rhokp.tar

      Copy to Clipboard Toggle word wrap

3. Optional: To use your own SSL/TLS certificates, you must create a local httpd-ssl/ directory to store your certificates:

   Important

   The Red Hat Offline Knowledge Portal reverts to the default SSL/TLS key pair if it cannot detect the certificate files.

   httpd-ssl/
   ├── certs
   │   └── <cert_filename>.pem
   └── private
      └── <key_filename>.pem

   Copy to Clipboard Toggle word wrap

   where:

   <cert_filename>

   Specifies the name of your SSL/TLS certificate.

   <key_filename>

   Specifies the SSL/TLS key.

   The httpd-ssl directory name must be exact. Your cert and key filenames must have a .pem extension.

   For more information about using SSL certificates, see the Apache httpd 2.4 page in the Red Hat catalog.

4. Get your Red Hat Offline Knowledge Portal access key:

   1. Navigate to the Red Hat Offline Knowledge Portal Access Key Generator page, click Generate key, and then copy the key to your clipboard. After you generate your access key, the key is stored in your Red Hat account.
   2. Optional: If you need the key again, click Generate Key to display the previously generated key.
   3. Optional: If your access key is compromised, report a bug to unbind your access key so you can generate a new one.

5. To launch the Red Hat Offline Knowledge Portal with Podman, enter the following command:

   $ podman run --rm -p 8080:8080 -p 8443:8443 \
   -v ./httpd-ssl:/opt/app-root/httpd-ssl:Z \
   --env "ACCESS_KEY=<your_personal_access_key>" \
   -d registry.redhat.io/offline-knowledge-portal/rhokp-rhel9:latest

   Copy to Clipboard Toggle word wrap

   where:

   <your_personal_access_key>

   Specifies the access key that you generated in the previous step. The podman run command includes your access key. Without the correct access key, you cannot view encrypted content or use certain features, such as search.

   If you are using your own SSL/TLS certificates instead of the default, -v ./httpd-ssl:/opt/app-root/httpd-ssl:Z \ mounts a volume for the SSL/TLS certificates in your local httpd-ssl/ directory.

   The container should start after 30 seconds.

Verification

1. On a remote system with a web browser, enter http://<server-ip-address>:8080 or https://<server-ip-address>:8443.

   where:

   <server-ip-address>

   Specifies the IP address of your server.

2. To review the Podman container log, enter the following command:

   $ podman logs <container>

   Copy to Clipboard Toggle word wrap

   where:

   <container>

   Specifies the name of your Red Hat Offline Knowledge Portal container image.