/
Setup Guide for cross domain (CORS)

Setup Guide for cross domain (CORS)

Owned by Jennifer (Deactivated)
Last updated: Jan 13, 2023 by Ryosuke Kumai

Alfresco 6.2+, 7.0+

  1. Edit /opt/alfresco/content-services/tomcat/shared/classes/alfresco-global.properties

    cors.enabled=true
cors.allowSubdomains=true
cors.allowed.origins=https://alfresco.sample.net,https://confluence.sample.net
cors.allowed.methods=GET,HEAD,POST,PUT,DELETE,OPTIONS
cors.allowed.headers=Accept,Access-Control-Request-Headers,Access-Control-Request-Method,Authorization,Content-Type,Cache-Control,X-Requested-With,X-CSRF-Token
cors.exposed.headers=Access-Control-Allow-Origin,Access-Control-Allow-Credentials
cors.support.credentials=true
cors.preflight.maxage=10
cors.allowGenericHttpRequests=true
  2. Specify The URL to allow on the cross-domain to cors.allowed.origins value.
    (    Asterisk can NOT be used here, but Please specify the appropriate both Confluence and Alfresco domain.)

  3. Edit /opt/alfresco/content-services/tomcat/conf/server.xml

     <Connector port="8080" protocol="HTTP/1.1"
               connectionTimeout="20000"
               URIEncoding="UTF-8"
               redirectPort="8443" relaxedPathChars="[]|" relaxedQueryChars="[]|{}^\`"/>
  4. Add relaxedPathChars and relaxedQueryChars if they are not.
  5. Restart Alfresco

Alfresco 5.2 - 6.1

  1. Make sure /opt/alfresco-content-services/tomcat/webapps/alfresco/WEB-INF/lib and cors-filter-2.5.jar, java-property-utils-1.9.1.jar is located.

  2. Edit /opt/alfresco-content-services/tomcat/webapps/alfresco/WEB-INF/web.xml

  3. Uncomment <filter> between <!-- CORS Filter Begin --> and <!-- CORS Filter End -->

       <!-- CORS Filter Begin -->
   <filter>
      <filter-name>CORS</filter-name>
      <filter-class>com.thetransactioncompany.cors.CORSFilter</filter-class>
      <init-param>
         <param-name>cors.allowGenericHttpRequests</param-name>
         <param-value>true</param-value>
      </init-param>
      <init-param>
         <param-name>cors.allowOrigin</param-name>
         <param-value>http://localhost:8081</param-value>
      </init-param>
      <init-param>
         <param-name>cors.allowSubdomains</param-name>
         <param-value>true</param-value>
      </init-param>
      <init-param>
         <param-name>cors.supportedMethods</param-name>
         <param-value>GET, HEAD, POST, PUT, DELETE, OPTIONS</param-value>
      </init-param>
      <init-param>
         <param-name>cors.supportedHeaders</param-name>
         <param-value>origin, authorization, x-file-size, x-file-name, content-type, accept, x-file-type</param-value>
      </init-param>
      <init-param>
         <param-name>cors.supportsCredentials</param-name>
         <param-value>true</param-value>
      </init-param>
      <init-param>
         <param-name>cors.maxAge</param-name>
         <param-value>3600</param-value>
      </init-param>
   </filter>
   <!-- CORS Filter End -->

  4. Specify The URL to allow on the cross-domain to cors.allowOrigin param-value of the init-param element.
    (    Asterisk is specified here, but Please specify the appropriate URL.)

          <init-param>
         <param-name>cors.allowOrigin</param-name>
         <!--param-value>http://localhost:8081</param-value-->
         <param-value>*</param-value>
      </init-param>
  5. Uncomment <filter-mapping> between <!-- CORS Filter Mappings Begin --> and <!-- CORS Filter Mappings End -->.
       <!-- CORS Filter Mappings Begin -->
   <filter-mapping>
      <filter-name>CORS</filter-name>
      <url-pattern>/api/*</url-pattern>
      <url-pattern>/service/*</url-pattern>
      <url-pattern>/s/*</url-pattern>
      <url-pattern>/cmisbrowser/*</url-pattern>
   </filter-mapping>
   <!-- CORS Filter Mappings End -->
  6. Restart Alfresco

Alfresco 5.0.2 - 5.1

  1. Make sure "cors-filter-1.9.3.jar,java-property-utils-1.9.1.jar" is located in "/opt/alfresco/tomcat/webapps/alfresco/WEB-INF/lib".

  2. Edit /opt/alfresco/tomcat/webapps/alfresco/WEB-INF/web.xml

  3. Uncomment <filter> between <!-- CORS Filter Begin → and<!-- CORS Filter End -->

       <!-- CORS Filter Begin -->
   <filter>
      <filter-name>CORS</filter-name>
      <filter-class>com.thetransactioncompany.cors.CORSFilter</filter-class>
      <init-param>
         <param-name>cors.allowGenericHttpRequests</param-name>
         <param-value>true</param-value>
      </init-param>
      <init-param>
         <param-name>cors.allowOrigin</param-name>
         <param-value>http://localhost:8081</param-value>
      </init-param>
      <init-param>
         <param-name>cors.allowSubdomains</param-name>
         <param-value>true</param-value>
      </init-param>
      <init-param>
         <param-name>cors.supportedMethods</param-name>
         <param-value>GET, HEAD, POST, PUT, DELETE, OPTIONS</param-value>
      </init-param>
      <init-param>
         <param-name>cors.supportedHeaders</param-name>
      </init-param>
      <init-param>
         <param-name>cors.supportsCredentials</param-name>
         <param-value>true</param-value>
      </init-param>
      <init-param>
         <param-name>cors.maxAge</param-name>
         <param-value>3600</param-value>
      </init-param>
   </filter>
   <!-- CORS Filter End -->

  4. Specify the URL to allow on the cross-domain to  "cros.allowOrigin" param-value of the init-param element. 　

    (The following asterisk specified here, but please specify with appropriate URL according to environment)　　

          <init-param>
         <param-name>cors.allowOrigin</param-name>
         <!--param-value>http://localhost:8081</param-value-->
         <param-value>*</param-value>
      </init-param>

  5. Uncomment  <filter-mapping>  between <!-- CORS Filter Mappings Begin --> and <!-- CORS Filter Mappings End --> .

       <!-- CORS Filter Mappings Begin -->
   <filter-mapping>
      <filter-name>CORS</filter-name>
      <url-pattern>/api/*</url-pattern>
      <url-pattern>/service/*</url-pattern>
      <url-pattern>/s/*</url-pattern>
      <url-pattern>/cmisbrowser/*</url-pattern>
   </filter-mapping>
   <!-- CORS Filter Mappings End -->

  6. Restart the Alfresco.

Alfresco 5.0.1

  1. Put cors-filter-2.4.jar and java-property-utils-1.9.1.ja.in /opt/alfresco/tomcat/webapps/alfresco/WEB-INF/lib directory.

  2. Edit 'web.xml' in '/opt/alfresco/tomcat/webapps/alfresco/WEB-INF/' as shown below. 

    <filter> can be put anywhere on web.xml 
    But, <filter-mapping> must be put after "Global Localization Filter" and before "CMIS security context cleaning filter"
       <filter>
      <filter-name>JSF Session Synchronized Filter</filter-name>
      <filter-class>org.alfresco.repo.web.filter.beans.SessionSynchronizedFilter</filter-class>
   </filter>
 
   <!-- ここから追加 Add descriptions start -->
   <filter>
      <filter-name>CORS</filter-name>
      <filter-class>com.thetransactioncompany.cors.CORSFilter</filter-class>
      <init-param>
         <param-name>cors.allowOrigin</param-name>
         <param-value>*</param-value>
      </init-param>
      <init-param>
         <param-name>cors.allowSubdomains</param-name>
         <param-value>true</param-value>
      </init-param>
      <init-param>
         <param-name>cors.supportedMethods</param-name>
         <param-value>GET, POST, HEAD, PUT, DELETE, OPTIONS</param-value>
      </init-param>
      <init-param>
         <param-name>cors.supportedHeaders</param-name>
         <param-value>Content-Type, Accept, Authorization</param-value>
      </init-param>
   </filter>
   <!-- ここまで追加 Add descriptions end -->
   <filter-mapping>
      <filter-name>Global Localization Filter</filter-name>
      <url-pattern>/*</url-pattern>
      <dispatcher>REQUEST</dispatcher>
   </filter-mapping>
 
   <!-- ここから追加 Add descriptions start -->
   <filter-mapping>
      <filter-name>CORS</filter-name>
      <url-pattern>/api/*</url-pattern>
      <url-pattern>/service/*</url-pattern>
      <url-pattern>/s/*</url-pattern>
      <url-pattern>/cmisbrowser/*</url-pattern>
   </filter-mapping>
   <!-- ここまで追加 Add descriptions end -->
 
   <filter-mapping>
      <filter-name>CMIS security context cleaning filter</filter-name>
      <url-pattern>/cmisws/*</url-pattern>
   </filter-mapping>

  3. Restart the Alfresco.

Reference

About 'CORS'

Cross-origin resource sharing
W3C Cross-Origin Resource Sharing
Using CORS

 Information about 'CORS' module in 'Alfresco'.

CORS - Enable Alfresco for CORS

CORS Filter installation

CORS filter configuration

Related content

Environment Guide for Alfresco connector for Confluence
Environment Guide for Alfresco connector for Confluence
Alfresco connector for Confluence
More like this
Instllation Guide for Alfresco Authentication plugin
Instllation Guide for Alfresco Authentication plugin
Alfresco connector for Confluence
More like this
Installation Guide
Installation Guide
Alfresco connector for Confluence
Read with this
Setup Guide for CORS (Cross-Origin Resource Sharing)
Setup Guide for CORS (Cross-Origin Resource Sharing)
Alfresco connector for Jira
More like this
The authentication fails the test to the Alfresco error is displayed.
The authentication fails the test to the Alfresco error is displayed.
Alfresco connector for Jira
More like this
Environment Guide for Alfresco connector for JIRA
Environment Guide for Alfresco connector for JIRA
Alfresco connector for Jira
More like this