Skip to content

Commit

Permalink
docs(CCSM): add optimize license page doc (#710)
Browse files Browse the repository at this point in the history
* docs(CCSM): add optimize license page doc

* style(formatting): technical review

technical documentation review

Co-authored-by: christinaausley <[email protected]>
  • Loading branch information
akeller and christinaausley authored Mar 25, 2022
1 parent d9b807b commit 0be52c1
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 1 deletion.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ You can also adjust logging levels using environment variables as described in t

#### License key file

If you want the Optimize Docker container to automatically recognize your [license key file]({{< ref "/user-guide/license/_index.md" >}}), you can use standard [Docker means](https://docs.docker.com/storage/volumes/) to make the file with the license key available inside the container. Replacing the `ABSOLUTE_PATH_ON_HOST_TO_LICENSE_FILE` with the absolute path to the license key file on your host can be done with the following command:
If you want the Optimize Docker container to automatically recognize your [license key file](./license.md), you can use standard [Docker means](https://docs.docker.com/storage/volumes/) to make the file with the license key available inside the container. Replacing the `ABSOLUTE_PATH_ON_HOST_TO_LICENSE_FILE` with the absolute path to the license key file on your host can be done with the following command:

```
docker run -d --name optimize -p 8090:8090 -p 8091:8091 \
Expand Down
13 changes: 13 additions & 0 deletions docs/self-managed/optimize-deployment/setup/license.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
id: optimize-license
title: "Optimize license key"
description: "When you log in to Optimize for the first time, you are redirected to the license page where you can enter your license key."
---

When you log in to Optimize for the first time, you are redirected to the license page. Here, enter your license key to be able to use Camunda Optimize.

![Optimize license page with no license key in the text field and submit button below](img/license-guide.png)

Alternatively, you can add a file with the license key to the path `${optimize-root-folder}/config/OptimizeLicense.txt`; it will be automatically loaded to the database unless it already contains a license key.

If you are using the Optimize Docker images and want Optimize to automatically recognize your license key, refer to the [installation guide](./installation.md#license-key-file) on how to achieve this.
1 change: 1 addition & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -467,6 +467,7 @@ module.exports = {
{
Setup: [
"self-managed/optimize-deployment/setup/installation",
"self-managed/optimize-deployment/setup/optimize-license",
"self-managed/optimize-deployment/setup/security-instructions",
"self-managed/optimize-deployment/setup/configuration",
"self-managed/optimize-deployment/setup/user-management",
Expand Down

0 comments on commit 0be52c1

Please sign in to comment.