Docs on the resource proxy

ckan · Nov 16, 2012 · 2792859 · 2792859
1 parent 84973d2
commit 2792859
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 3 deletions.
diff --git a/ckanext/resourceproxy/plugin.py b/ckanext/resourceproxy/plugin.py
@@ -24,9 +24,18 @@ class ResourceProxy(p.SingletonPlugin):
     """A proxy for CKAN resources to get around the same
     origin policy for previews
 
-    This extension implements two interfaces
-
+    This extension implements the IRoute interface
       - ``IRoutes`` allows to add a route to the proxy action
+
+
+    Instructions on how to use the extension:
+
+    1. Import the proxy plugin if it exists
+        ``import ckanext.resourceproxy.plugin as proxy``
+
+    2. In you extension, make sure that the proxy plugin is
+        enabled by checking the ``ckan.resource_proxy_enabled`` config variable.
+        ``config.get('ckan.resource_proxy_enabled', False)``
     """
     p.implements(p.IRoutes, inherit=True)
     p.implements(p.IConfigurer, inherit=True)

diff --git a/doc/writing-extensions.rst b/doc/writing-extensions.rst
@@ -143,7 +143,7 @@ Here's a list of some of the more commonly used plugin interfaces:
     Intercept template rendering to modify the output.
 
 :class:`~ckan.plugins.interfaces.IResourcePreview`
-    Add custom previews.
+    Add custom previews. The preview extensions can make use of the resoucre proxy extension, if enabled.
 
 :class:`~ckan.plugins.interfaces.IDomainObjectModification`
     Listens for changes to CKAN domain objects.