ZNTA-2225 - still require hibernate search base sys prop

zanata · Oct 3, 2017 · 29656ef · 29656ef
1 parent 1ddf365
commit 29656ef
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 6 deletions.
diff --git a/docs/release-notes.md b/docs/release-notes.md
@@ -1,8 +1,8 @@
 ## 4.4.0
 ##### Infrastructure Changes
 Zanata now requires a system propery 'zanata.home' as the root for all its file system storage needs.
-Previously defined 'zanata.file.directory' and 'hibernate.search.default.indexBase' will still work.
-But if you omit them, they will be derived from 'zanata.home' as sub directories.
+Previously defined 'zanata.file.directory' will still work.
+But if you omit it, it will be derived from 'zanata.home' as sub directories.
 
 ##### Changes
  * [ZNTA-2184](https://zanata.atlassian.net/browse/ZNTA-2225) - Define zanata.home system property and derive other properties from it

diff --git a/docs/user-guide/system-admin/configuration/installation.md b/docs/user-guide/system-admin/configuration/installation.md
@@ -97,13 +97,13 @@ Zanata will store some files on file system. You will need to define a system pr
 The value should be a path that has read and write permission from jboss user. You can define individual system properties for each storage below or they will derive from above zanata.home directory (e.g. as sub directory).
 
 - zanata.file.directory
-- hibernate.search.default.indexBase
 
-You can also define a system property for Javamelody (the server monitoring tool Zanata uses)
+You can also define a system property for Javamelody (the server monitoring tool Zanata uses) and for Hibernate search index. It's recommended you define them as sub directory of zanata.home.
 ```xml
 <system-properties>
   ...
   <property name="javamelody.storage-directory" value="${zanata.home}/stats"/>
+  <property name="hibernate.search.default.indexBase" value="${zanata.home}/indexes"/>
   ...
 </system-properties>
 ``` 

diff --git a/server/docker/conf/zanata-config.cli b/server/docker/conf/zanata-config.cli
@@ -11,6 +11,7 @@ batch
 # ==== system properties /system-property=foo:add(value=bar) ====
 /system-property="zanata.home":add(value="${user.home}/zanata")
 /system-property="javamelody.storage-directory":add(value="${zanata.home}/stats")
+/system-property="hibernate.search.default.indexBase":add(value="${zanata.home}/indexes")
 /system-property="jboss.as.management.blocking.timeout":add(value="1000")
 /system-property="zanata.security.authpolicy.internal":add(value="zanata.internal")
 /system-property="zanata.security.authpolicy.openid":add(value="zanata.openid")

diff --git a/server/services/src/main/java/org/zanata/config/SystemPropertyConfigStore.java b/server/services/src/main/java/org/zanata/config/SystemPropertyConfigStore.java
@@ -55,14 +55,15 @@ public class SystemPropertyConfigStore implements ConfigStore {
             "zanata.email.defaultfromaddress";
     public static final String KEY_DOCUMENT_FILE_STORE =
             "zanata.file.directory";
+    // this is used by hibernate search so we still need to define it.
     private static final String KEY_HIBERNATE_SEARCH_INDEX_BASE =
             "hibernate.search.default.indexBase";
     // unfortunately we can't derive javamelody directory from zanata.home because it's used inside javamelody
     private static final String KEY_JAVAMELODY_STORAGE_DIRECTORY =
             "javamelody.storage-directory";
     private static final String KEY_ZANATA_HOME = "zanata.home";
     private static final Set<String> REQUIRED_PROP_KEYS = ImmutableSet
-            .of(KEY_ZANATA_HOME, KEY_JAVAMELODY_STORAGE_DIRECTORY);
+            .of(KEY_ZANATA_HOME, KEY_JAVAMELODY_STORAGE_DIRECTORY, KEY_HIBERNATE_SEARCH_INDEX_BASE);
 
     /**
      * Server-wide switch to enable/disable OAuth support
@@ -130,7 +131,7 @@ public String getDocumentFileStorageLocation() {
     }
 
     public String getHibernateSearchIndexBase() {
-        return System.getProperty(KEY_HIBERNATE_SEARCH_INDEX_BASE, new File(getZanataHome(), "indexes").getAbsolutePath());
+        return System.getProperty(KEY_HIBERNATE_SEARCH_INDEX_BASE);
     }
 
     public String getZanataHome() {