Skip to content

Commit

Permalink
Merge pull request #144 from Volt-MX-GO/zerlordDRAPI-MXOP-16443
Browse files Browse the repository at this point in the history
MXOP-16443
  • Loading branch information
rwilkins108 authored and GitHub Enterprise committed Jul 26, 2024
2 parents 4271e81 + f69cf1c commit 841af5d
Show file tree
Hide file tree
Showing 6 changed files with 16 additions and 12 deletions.
2 changes: 1 addition & 1 deletion docs/howto/install/notesclient.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ The procedure guides you to try the Domino REST API with a sample demo Notes dat
## Prerequisites

- HCL Notes Desktop Client installed.
- Domino REST API installed using the `restapiInstall.jar` from Flexnet.
- Domino REST API installed using the `restapiInstall.jar` from My HCLSoftware Portal or HCL Software License and Download Portal.

--8<-- "jarfilename.md"

Expand Down
8 changes: 4 additions & 4 deletions docs/howto/production/versionupdate.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ The procedure guides you on how to update your installed Domino REST API to the

## Prerequisite

- When updating installed Domino REST API on Linux, Mac, or Windows, [download the latest release version of the Domino REST API multi-platform installer](../../tutorial/installconfig/index.md#download-domino-rest-api). <!--from [HCL Software License and Download Portal](https://hclsoftware.flexnetoperations.com/) (Flexnet).-->
- When updating installed Domino REST API on Linux, Mac, or Windows, [download the latest release version of the Domino REST API multi-platform installer](../../tutorial/installconfig/index.md#download-domino-rest-api).
- When updating Domino REST API running with Docker image:

- [Download the docker image of the latest release version of Domino REST API](../../tutorial/installconfig/index.md#download-domino-rest-api) <!--from [HCL Software License and Download Portal](https://hclsoftware.flexnetoperations.com/) (Flexnet)-->.
- [Download the docker image of the latest release version of Domino REST API](../../tutorial/installconfig/index.md#download-domino-rest-api).

**OR**

Expand All @@ -24,7 +24,7 @@ Follow the procedure based on the installation option you used when installing t
### Docker

1. Remove the existing docker container.
2. If using the docker image from *HCL Software License and Download Portal (Flexnet)* or *My HCLSoftware Portal*, load the docker image using the following command:
2. If using the docker image from *HCL Software License and Download Portal* or *My HCLSoftware Portal*, load the docker image using the following command:

```bash
docker load -i [name_of_tar_file].tar
Expand All @@ -36,7 +36,7 @@ Follow the procedure based on the installation option you used when installing t
3. Take note of the image name.
- When using the docker image from *HCL Software License and Download Portal (Flexnet)* or *My HCLSoftware Portal*, take note of the image name that was output after being loaded. The image name is also indicated in the [What’s New](../../references/whatisnew.md) for each version of the Domino REST API and marked *Docker image version for docker compose .env file (CONTAINER_IMAGE)*.
- When using the docker image from *HCL Software License and Download Portal* or *My HCLSoftware Portal*, take note of the image name that was output after being loaded. The image name is also indicated in the [What’s New](../../references/whatisnew.md) for each version of the Domino REST API and marked *Docker image version for docker compose .env file (CONTAINER_IMAGE)*.
!!!example "Example loaded image name"
- From earlier releases: `docker.qs.hcllabs.net/hclcom/projectkeep-r12:1.10.0`
Expand Down
2 changes: 1 addition & 1 deletion docs/references/downloads.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ title: Downloads

Download from:

- [HCL Software License & Download Portal (Flexnet)](https://hclsoftware.flexnetoperations.com/){: target="_blank"}
- [HCL Software License & Download Portal](https://hclsoftware.flexnetoperations.com/){: target="_blank"}
- [My HCLSoftware Portal](https://my.hcltechsw.com/){: target="_blank"}

## Presentations
Expand Down
6 changes: 3 additions & 3 deletions docs/tutorial/installconfig/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Running Domino REST API with a Docker image requires the following:

- **Domino REST API Docker image**.

Download the image as an archive file from [HCL Software License and Download Portal (Flexnet)](https://hclsoftware.flexnetoperations.com/) or [My HCLSoftware Portal](https://my.hcltechsw.com/). For more information, see [Download Domino REST API](index.md#download-domino-rest-api).
Download the image as an archive file from [HCL Software License and Download Portal](https://hclsoftware.flexnetoperations.com/) or [My HCLSoftware Portal](https://my.hcltechsw.com/). For more information, see [Download Domino REST API](index.md#download-domino-rest-api).

!!!warning "Important"
<!-- This prerequisite is only needed if you would use the Docker image from **HCL Software License and Download Portal (Flexnet)** or **My HCLSoftware Portal**.-->
Expand Down Expand Up @@ -76,7 +76,7 @@ A Domino server uses one persistent volume to store its data. This volume also s

## Load Docker image

**For docker image from Flexnet or My HCLSoftware Portal**
**For docker image from HCL Software License and Download Portal or My HCLSoftware Portal**

Load the docker image that you've downloaded from [prerequisites](#prerequisites). Make sure you [extract the tar.gz file](https://linuxize.com/post/how-to-extract-unzip-tar-gz-file/){: target="_blank" rel="noopener noreferrer"} first.

Expand Down Expand Up @@ -110,7 +110,7 @@ Depending on the compose file you choose, a different set of variables needs to
| Variable | Example | Remarks |
| :---- | :---- | :---- |
| CONTAINER_HOSTNAME | domino.acme.com | Pro tip: use something.local for local testing|
| CONTAINER_IMAGE | docker.qs.hcllabs.net/hclcom/projectkeep-r12:1.10.0 (example name for docker image from Flexnet or My HCLSoftware Portal from earlier release)</br></br>domino-rest-api:1.0.7 (example name for docker image from Flexnet or My HCLSoftware Portal starting v1.0.7 release)</br></br>hclcr.io/domino/restapi:1.0.6 (example name for docker image from Harbor)| <!--**Check** carefully for the current image name! `:latest` most likely need to be replaced.--> For docker image downloaded from Flexnet or My HCLSoftware Portal, update based on the name of the loaded image, such as the example shown above, or use `docker images ls` to see the exact image name. <br><br>For docker image downloaded from Harbor, update based on the image name of the latest docker image version for docker compose .env file from Harbor indicated in [What's New](../../references/whatisnew.md). |
| CONTAINER_IMAGE | docker.qs.hcllabs.net/hclcom/projectkeep-r12:1.10.0 (example name for docker image from HCL Software License and Download Portal or My HCLSoftware Portal from earlier release)</br></br>domino-rest-api:1.0.7 (example name for docker image from HCL Software License and Download Portal or My HCLSoftware Portal starting v1.0.7 release)</br></br>hclcr.io/domino/restapi:1.0.6 (example name for docker image from Harbor)| <!--**Check** carefully for the current image name! `:latest` most likely need to be replaced.--> For docker image downloaded from HCL Software License and Download Portal or My HCLSoftware Portal, update based on the name of the loaded image, such as the example shown above, or use `docker images ls` to see the exact image name. <br><br>For docker image downloaded from Harbor, update based on the image name of the latest docker image version for docker compose .env file from Harbor indicated in [What's New](../../references/whatisnew.md). |
| CONTAINER_NAME | domino-keep-test02 | |
| CONTAINER_VOLUMES | domino_keep_notesdata | no spaces or special characters |
| SERVERSETUP_ADMIN_CN | Peter Parker | |
Expand Down
8 changes: 6 additions & 2 deletions docs/tutorial/installconfig/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,11 @@
- `Domino_REST_API_V1.0.9_R14_Docker.tar.gz`
- `Domino_REST_API_V1.0.9_R14_Installer.tar.gz`

#### via HCL Software License and Download Portal (Flexnet)
!!!warning "Important"
- For **Domino customers**, download the Domino REST API via the [My HCLSoftware Portal](#via-my-hclsoftware-portal).
- For **Volt MX Go customers**, download the Domino REST API via [HCL Software License and Download Portal](#via-hcl-software-license-and-download-portal) or via [My HCLSoftware Portal](#via-my-hclsoftware-portal).

#### via HCL Software License and Download Portal

**Option 1**

Expand Down Expand Up @@ -78,7 +82,7 @@ Domino REST API can be installed on:
- Domino Server on [Docker or Kubernetes](../installconfig/docker.md)
<!-- Domino Server on [Kubernetes](../installconfig/helm.md)-->

All platforms use a Java-based installer, except Kubernetes or Docker, which uses a container (colloquial referred to as Docker) image. You can download the installer and the Docker image from your Flexnet account. For any questions, contact your HCL reseller.
All platforms use a Java-based installer, except Kubernetes or Docker, which uses a container (colloquial referred to as Docker) image. You can download the installer and the Docker image from your HCL Software License and Download Portal or My HCLSoftware Portal account. For any questions, contact your HCL reseller.

!!! warning "You did shut down Domino, did you?"

Expand Down
2 changes: 1 addition & 1 deletion docs/tutorial/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This guide allows new users with working experience in HCL Notes and HCL Domino

## Downloading Domino REST API

Log in to [Flexnet](https://hclsoftware.flexnetoperations.com/) and download Domino REST API.
Log in to [HCL Software License & Download Portal](https://hclsoftware.flexnetoperations.com/) or [My HCLSoftware Portal](https://my.hcltechsw.com/) and download Domino REST API.

## Let's connect

Expand Down

0 comments on commit 841af5d

Please sign in to comment.