RDoc-2521_licenseDockerServer

Documentation/6.0/Raven.Documentation.Pages/start/licensing/.docs.json

@@ -1,32 +1,38 @@
-[
-    {
-        "Path": "licensing-overview.markdown",
-        "Name": "Licensing Overview",
-        "DiscussionId": "f96e07fc-5344-4ba6-ab5c-d4263ee8be6b",
-        "Mappings": []
-    },
-    {
-        "Path": "activate-license.markdown",
-        "Name": "Activate License",
-        "DiscussionId": "8dc7f6a1-ec5d-4066-bd0f-f7940dbee476",
-        "Mappings": []
-    },
-    {
-        "Path": "replace-license.markdown",
-        "Name": "Replace License",
-        "DiscussionId": "8dc7f6a1-ec5d-4066-bd0f-f7940dbee476",
-        "Mappings": []
-    },
-    {
-        "Path": "renew-license.markdown",
-        "Name": "Renew License",
-        "DiscussionId": "8dc7f6a1-ec5d-4066-bd0f-f7940dbee476",
-        "Mappings": []
-    },
-    {
-        "Path": "force-update.markdown",
-        "Name": "Force Update",
-        "DiscussionId": "8dc7f6a1-ec5d-4066-bd0f-f7940dbee476",
-        "Mappings": []
-    }
-]
+[
+  {
+    "Path": "licensing-overview.markdown",
+    "Name": "Licensing Overview",
+    "DiscussionId": "f96e07fc-5344-4ba6-ab5c-d4263ee8be6b",
+    "Mappings": []
+  },
+  {
+    "Path": "activate-license.markdown",
+    "Name": "Activate License",
+    "DiscussionId": "8dc7f6a1-ec5d-4066-bd0f-f7940dbee476",
+    "Mappings": []
+  },
+  {
+    "Path": "replace-license.markdown",
+    "Name": "Replace License",
+    "DiscussionId": "8dc7f6a1-ec5d-4066-bd0f-f7940dbee476",
+    "Mappings": []
+  },
+  {
+    "Path": "renew-license.markdown",
+    "Name": "Renew License",
+    "DiscussionId": "8dc7f6a1-ec5d-4066-bd0f-f7940dbee476",
+    "Mappings": []
+  },
+  {
+    "Path": "force-update.markdown",
+    "Name": "Force Update",
+    "DiscussionId": "8dc7f6a1-ec5d-4066-bd0f-f7940dbee476",
+    "Mappings": []
+  },
+  {
+    "Path": "license-under-docker.markdown",
+    "Name": "License Under Docker",
+    "DiscussionId": "d61ebac0-0fdb-48d4-b0b2-dfd7522eb5c7",
+    "Mappings": []
+  }
+]

Documentation/6.0/Raven.Documentation.Pages/start/licensing/license-under-docker.markdown

@@ -0,0 +1,125 @@
+# Installation: License a RavenDB Docker Image
+---
+
+{NOTE: }
+
+* This page explains how to pass a license to a RavenDB server that runs 
+  in a Docker container or under a Linux or a Unix system.  
+* A license can be passed to RavenDB in one of the following methods:  
+   * A path to the license file can be passed to the server via CLI.  
+   * The license can be provided to the server in the `settings.json` 
+     configuration file.  
+   * A `RAVEN_License` environment variable can be set.  
+
+* In this page:  
+  * [Prerequisites](../../start/licensing/license-under-docker#prerequisites)  
+  * [Licensing a RavenDB docker image](../../start/licensing/license-under-docker#licensing-a-ravendb-docker-image)  
+     * [Passing a Path to the License File via CLI](../../start/licensing/license-under-docker#passing-a-path-to-the-license-file-via-cli)  
+     * [Providing a License in `settings.json`](../../start/licensing/license-under-docker#providing-a-license-in-)  
+     * [Setting a `RAVEN_License` Environment Variable](../../start/licensing/license-under-docker#setting-a--environment-variable)  
+  * [Licensing RavenDB under Linux](../../start/licensing/license-under-docker#licensing-ravendb-under-linux)  
+
+{NOTE/}
+
+---
+{PANEL: Prerequisites}
+
+* Docker images of RavenDB versions up to `5.x` require no special permissions 
+  since they are installed and handled by the `root` user, that is innately allowed 
+  to access any RavenDB property, including its license.  
+* Docker images of RavenDB `6.0` and on are executed by a **regular user** for 
+  security reasons, requiring that this user would be explicitly permitted to access 
+  RavenDB properties, including any mounted license folder.  
+* Read more about this in the dedicated [migration page](../../migration/server/docker).  
+{PANEL/}
+
+{PANEL: Licensing a RavenDB docker image}  
+
+Please find below a few methods to license a RavenDB server that runs in a Docker container.  
+
+## Passing a Path to the License File via CLI
+
+Store the license in a folder that can be accessed by the host machine that runs Docker.  
+RavenDB, within Docker, will have **no direct access** to the license.  
+Allow RavenDB to access the license by **mounting the license folder** when you run RavenDB 
+using Docker's CLI.  
+
+* From Docker's CLI, use this syntax:  
+  {CODE-BLOCK: JSON}
+  docker run -v <host_dir>:<container_dir> -e <env.var>
+  {CODE-BLOCK/}
+
+    The `-v` option points at the host directory.  
+    The `-e` option sets the Docker `RAVEN_License_Path` environment variable with the license.  
+
+* **Example**:  
+  {CODE-BLOCK: JSON}
+  docker run -v "C:\docker-license\config:/ravendb/license" -e RAVEN_License_Path=/ravendb/license/license.json  
+  {CODE-BLOCK/}
+  When RavenDB is executed this way, the license folder will be mounted and the environment variable set with the license.  
+  RavenDB will fetch the license from the environment variable the first time it accesses a database.  
+
+To verify that the server is licensed run it as shown above, create a new database or access an existing one, 
+and then open the **About** view.   
+
+![About view: Licensed Server](images/licensed-server.png "About view: Licensed Server")
+
+## Providing a License in `settings.json`
+
+Provide the license as a property of the `settings.json` configuration file in one of the following ways.  
+
+* Add `settings.json` the **full license string** as the value of the "License" key 
+  [as explained here](../../server/configuration/license-configuration).  
+  Mount `settings.json` as [explained above](../../start/licensing/license-under-docker#passing-a-path-to-the-license-file-via-cli), 
+  using the location of `settings.json` instead of the location of a license file.  
+* Alternatively, add `settings.json` the **license path** as the value of the “License.Path” key and mount the license directory.  
+
+## Setting a `RAVEN_License` Environment Variable}  
+
+The full license string can also be added as a docker `RAVEN_License` environment variable when the server is executed.  
+
+* Special characters must be escaped.  
+* Each line of the license key is provided as a single string.  
+* **Example**:  
+  {CODE-BLOCK: JSON}
+  docker run -e 'RAVEN_License={ 
+   \"Id\": \"4b167357-42f5-48a8-bef5-29ca557ef0ce\",  
+   \"Name\": \"asdf\",   \"Keys\": [
+     \"6aoht+NE3zvJidqIspOIa/5N1\",
+     \"320e9G95NFsNwbKkNfl3R/qO9\",
+     \"IHuEgp9OHVjxwV9ekur/L/FiF\",
+     \"RCfFywsNR0O2ghqZo6N0r4onp\",
+     \"fGNula2WJv0iz5Tq+xt99/A6t\",
+     \"oHfaSXrNOdgilfCqLkoyFI9E8\",
+     \"MHMmcIfBoQelf/qZKOpE5ABYE\",
+     \"DNi4wBSYoSQMmKywtLL8wJzEy\",
+     \"MzQVFjc4OTo7PD0+nwIfIJ8CI\",
+     \"CCfAiEgnwIjIJ8CJCMfAiUgnw\",
+     \"ImIJ8CJyCfAiggnwIpI12CKiC\",
+     \"fAisgwvJsIJ8CLSCfAi4gnwIv\",
+     \"IJ8CMCCfAzZAAUMkRAlio9g=\"  ]}'
+   {CODE-BLOCK/}
+
+{PANEL/}
+
+{PANEL: Licensing RavenDB under Linux}  
+
+To license RavenDB under Linux, pass a license **file** rather than a **directory**.  
+
+* **Example**:  
+  {CODE-BLOCK: JSON}
+  docker run -v "/home/ubuntu/ravendb-docker-license/license.json:/ravendb/license" -e RAVEN_License_Path=/ravendb/license
+  {CODE-BLOCK/}
+
+{PANEL/}
+
+
+## Related Articles
+
+### Installation
+- [Running in a Docker Container](../../start/installation/running-in-docker-container)  
+- [Running as a Service](../../start/installation/running-as-service)  
+- [Upgrading to New Version](../../start/installation/upgrading-to-new-version)  
+
+### Setup Examples
+- [Docker on AWS Linux VM](../../start/installation/setup-examples/aws-docker-linux-vm)