loading table of contents...

2.1.3.4. Upgrading

If you have an existing installation of Docmenta and you want to upgrade to a newer Docmenta version, then proceed as follows:
  1. Download the new version of the Docmenta war package (see Section 2.1.2, “Download”). If the downloaded file has extension .zip, then unpack the archive, to get the .war file.
  2. Create a backup of the file WEB-INF/docma.properties, which is located within the deployed Docmenta application (e.g. if you are using Tomcat, create a backup of the file <Tomcat installdir>/webapps/docmenta/WEB-INF/docma.properties).
  3. Undeploy the old Docmenta war application from your web-server.
    For example, if you are using Tomcat, stop the web-server and remove the file docmenta.war (if existent) and the folder docmenta which are both located in the <Tomcat installdir>/webapps directory.
  4. Deploy the the new war package.
    For example, if you are using Tomcat, copy the downloaded Docmenta .war file to the <Tomcat installdir>/webapps directory. Start the web-server if not already running. If the auto-deploy option of the web-server is enabled, then the .war file will automatically be extracted to a folder with same name (but without .war extension). Otherwise manually extract the .war file with an unzip tool.
  5. Copy the backup of the docma.properties file (see step 2) into the WEB-INF directory of the deployed Docmenta web-application (overwriting the existing docma.properties file).
After deployment of the war package (step 4), the location of the previously configured document-store directory is lost (see Section 2.1.4, “Setup” for information on the document-store directory). Therefore a backup of the configuration-file WEB-INF/docma.properties needs to be created in step 2, which is then copied back to the original location (step 5). If you do not create a backup of this configuration file, then you have to re-enter the information as described in chapter Section 2.1.4, “Setup”.
Important!
If you have placed the document-store directory inside of the Docmenta web-application directory, then, before undeploying the Docmenta web-application (step 3), you have to move the document-store directory out of the web-application directory. After deployment of the new war package (step 4), move the document-store directory back to its original location. Otherwise all product documentation and application settings will be lost! However, it is discouraged to place the document-store directory inside of the web-application directory.
Upgrading using the Windows installer package
If you have an existing Docmenta installation that was installed using the Windows installer package, then you can upgrade the installation by downloading a newer version of the Windows installer package and by selecting the directory of the existing installation as the destination folder during the installation process (see Section 2.1.3.3, “Installing the Windows installer package”). The installer will detect that an existing Tomcat installation already exists in this folder and ask whether you want to overwrite the existing installation or not. If you select yes, then the installer will create a backup of the file docma.properties, delete the complete Tomcat folder and reinstall Tomcat including the new version of the Docmenta web-application. Finally, the installer copies the backup of the file docma.properties back to its original location.
Important!
The Windows installer completely removes the existing Tomcat installation and reinstalls Tomcat. The Windows installer only creates a backup of the file docma.properties. This means that any configuration settings that you may have incorporated into the Tomcat configuration files and any additional web-applications that you may have deployed will be lost. Therefore, please create a backup of any files that you have modified or placed within the Tomcat installation folder, before overwriting the installation. Otherwise these files will be lost!