Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
Mirror of git.apache.org/manifoldcf-integration-elasticsearch.git
Fetching latest commit…
Cannot retrieve the latest commit at this time.
|Failed to load latest commit information.|
# Licensed to the Apache Software Foundation (ASF) under one or more # contributor license agreements. See the NOTICE file distributed with # this work for additional information regarding copyright ownership. # The ASF licenses this file to You under the Apache License, Version 2.0 # (the "License"); you may not use this file except in compliance with # the License. You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. Compatibility ------------ This version of this component is fully functional with Apache ManifoldCF 1.6 and above. It is backwards compatible with earlier versions as well, except for the fact that two additional ElasticSearch fields are required for this plugin to work. Upgrading --------- If you are replacing a version of Apache ManifoldCF Plugin for ElasticSearch that is older than version 2.0, you must declare two additional fields (representing parent acls and parent deny acls), and reindex all your documents. Otherwise, the plugin will prevent you from viewing any documents. Instructions for Building Apache ManifoldCF Plugin for Elastic Search from Source ----------------------------------------------------------------------------- 1. Download the Java SE 6 JDK (Java Development Kit), or greater, from http://www.oracle.com/technetwork/java/index.html. You will need the JDK installed, and the %JAVA_HOME%\bin directory included on your command path. To test this, issue a "java -version" command from your shell and verify that the Java version is 1.6 or greater. 2. Download and install Maven 2.2.1 or later. Maven installation and configuration instructions can be found here: http://maven.apache.org/run-maven/index.html 3. Build packages Execute the following command in order to build the JAR packages and install them to the local repository: mvn install The JAR packages can be found in the target folder: target/elasticsearch-plugin-mcf-<VERSION>.jar ... where <VERSION> is the release version 4. Building distribution assemblies Execute the following command in order to build the distribution assemblies mvn package assembly:assembly 5. Fix EOL in source files Fix the archive files so the source files have the correct EOL settings: mvn antrun:run Licensing --------- Apache ManifoldCF Plugin for Elastic Search is licensed under the Apache License 2.0. See the files called LICENSE.txt and NOTICE.txt for more information. Cryptographic Software Notice ----------------------------- This distribution may include software that has been designed for use with cryptographic software. The country in which you currently reside may have restrictions on the import, possession, use, and/or re-export to another country, of encryption software. BEFORE using any encryption software, please check your country's laws, regulations and policies concerning the import, possession, or use, and re-export of encryption software, to see if this is permitted. See <http://www.wassenaar.org/> for more information. The U.S. Government Department of Commerce, Bureau of Industry and Security (BIS), has classified this software as Export Commodity Control Number (ECCN) 5D002.C.1, which includes information security software using or performing cryptographic functions with asymmetric algorithms. The form and manner of this Apache Software Foundation distribution makes it eligible for export under the License Exception ENC Technology Software Unrestricted (TSU) exception (see the BIS Export Administration Regulations, Section 740.13) for both object code and source code. The following provides more details on the included software that may be subject to export controls on cryptographic software: The Apache ManifoldCF Plugin for Elastic Search does not include any implementation or usage of cryptographic software at this time. Contact ------- o For general information visit the main project site at http://manifoldcf.apache.org