ctubbsii commented on code in PR #70:
URL: 
https://github.com/apache/accumulo-classloaders/pull/70#discussion_r2785189746


##########
modules/caching-class-loader/README.md:
##########
@@ -87,6 +87,28 @@ Here is an example manifest:
 }
 ```
 
+## Quick Start
+
+The following are the steps to use this context classloader with jars
+accessible via URL.
+
+1. Add the jar for this project to the Accumulo classpath.
+2. Optionally add the jar for the [hdfs-urlstreamhandler-provider][2] project
+   to the Accumulo classpath. This will enable loading jars from HDFS URLs.
+3. Set the following Accumulo properties:
+   * 
`general.context.class.loader.factory=org.apache.accumulo.classloader.ccl.CachingClassLoaderFactory`
+   * 
`general.custom.classloader.ccl.cache.dir=file:/absolute/path/to/some/local/directory`
+   * 
`general.custom.classloader.ccl.allowed.urls.pattern=someRegexPatternForAllowedUrls`
+   * (optional) `general.custom.classloader.ccl.update.grace.minutes=30`
+4. Restart Accumulo (required for the first two properties; the others can be
+   changed on a running system)
+5. Create a manifest like the example above, either manually, or by using the
+   provided tool (see "Creating a Manifest" section below) and make it

Review Comment:
   Creating a link to the section would really depend on the markdown-to-html 
renderer. Not all renderers will create html anchors the same way.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to