User guide

Procedure

1. To get your access key, navigate to the Red Hat Offline Knowledge Portal Access Key Generator in your browser, log in, and select the Generate key button.

2. To download Red Hat Offline Knowledge Portal from your terminal using Podman:

   1. If needed, log in to registry.redhat.io using your Customer Portal, Red Hat Developer, or Registry Service Account credentials:

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

      Copy to Clipboard Toggle word wrap

   2. Pull the image:

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

      Copy to Clipboard Toggle word wrap

3. To launch Red Hat Offline Knowledge Portal with https using the self-signed certificate Podman generates, enter the minimal podman run command with your access key:

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

   Copy to Clipboard Toggle word wrap

Procedure

1. Select the Create Issue link. If Jira displays a login error, log in and proceed after the site redirects you to the form.
2. Complete the Summary, Description, and Component fields. In the Description field, include the documentation URL, chapter or section number, and a detailed description of the issue.
3. Select Create.

Procedure

1. To get your access key, navigate to the Red Hat Offline Knowledge Portal Access Key Generator, and select the Generate key button.

   Important

   You only need one access key. After you generate your access key, the Red Hat Offline Knowledge Portal Access Key Generator retrieves the key already bound to your Red Hat account.

   If your access key is compromised, report a bug to unbind your access key, so you can generate a new one.

2. To download Red Hat Offline Knowledge Portal from your terminal using Podman:

   1. If needed, log in to registry.redhat.io using your Customer Portal, Red Hat Developer, or Registry Service Account credentials:

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

      Copy to Clipboard Toggle word wrap

   2. Pull the image:

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

      Copy to Clipboard Toggle word wrap

3. 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

4. To load the image in your offline environment:

   podman load -i rhokp.tar

   Copy to Clipboard Toggle word wrap

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

   httpd-ssl/ 

   1

   
   ├── certs
   │   └── <cert_filename>.pem 

   2

   
   └── private
      └── <key_filename>.pem

   Copy to Clipboard Toggle word wrap

   1

   The directory name must be exact.

   2

   Your cert and key filenames must have a .pem extension.

   Important

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

6. Enter the following podman run command with your access key:

   $ podman run --rm -p 8080:8080 -p 8443:8443 \
   -v ./httpd-ssl:/opt/app-root/httpd-ssl:Z \ 

   1

   
   --env "ACCESS_KEY=<your_personal_access_key>" \ 

   2

   
   --name <red_hat_offline_knowledge_portal> \ 

   3

   
   -d registry.redhat.io/offline-knowledge-portal/rhokp-rhel9:latest

   Copy to Clipboard Toggle word wrap

   1

   If you’re using your own SSL/TLS certificates rather than the default, this portion of the command mounts a volume for the SSL/TLS certificates in your local httpd-ssl/ directory.

   2

   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.

   3

   The --name parameter is optional.

7. Wait about 30 seconds for the container to start.

Validation

1. In your browser, access Red Hat Offline Knowledge Portal at http://localhost:8080 or https://localhost:8443.

2. To examine the Podman container log, run the following command:

   $ podman logs <container>

   Copy to Clipboard Toggle word wrap

Procedure

1. To download Red Hat Offline Knowledge Portal from your terminal using Podman:

   1. If needed, log in to registry.redhat.io using your Customer Portal, Red Hat Developer, or Registry Service Account credentials:

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

      Copy to Clipboard Toggle word wrap

   2. Pull the image:

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

      Copy to Clipboard Toggle word wrap

2. 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

3. To load the image in your offline environment:

   podman load -i rhokp.tar

   Copy to Clipboard Toggle word wrap
4. Replace the updated Red Hat Offline Knowledge Portal container image in your disconnected environment. For more information, see Installing Red Hat Offline Knowledge Portal.