Imprint. ecodms Version: (krusty) Manual Build Number: 20 Language: Copyright 2016: ecodms GmbH Salierallee 18a Aachen Germany

Transcription

1

2 Imprint ecodms Version: (krusty) Manual Build Number: 20 Language: EN Copyright 2016: ecodms GmbH Salierallee 18a Aachen Germany Website: Phone: Seat of the Company: Aachen Court of Registration: Aachen County Court Register of Companies Management: Michael Schmitz (Dipl. -Betriebswirt [degree in business administration]) Helge Lühmann Important Information This manual supplied by ecodms GmbH is protected by copyright law. Any use of text and illustrations, particularly reproduction, which requires the translation or import into electronic systems, in whole or in part, requires the previous written approval by ecodms GmbH, Salierallee 18a, Aachen. Please note that the violation of copyright law is an offence. NO GUARANTEE All technical information and screenshots in this manual have been prepared with great care. Nevertheless, errors cannot be entirely excluded. ecodms GmbH neither provides any guarantee nor accepts any legal responsibility or liability for consequences resulting from incorrect information. The author welcomes any suggestions for improvement or information regarding errors.

3 Inhaltsverzeichnis 3 Inhaltsverzeichnis 1 System Requirements ecodms Server Virtual Machines Raspberry PI NAS Systems ecodms Client ecoice Client PDF/A Printer Microsoft Office Plug-in Libre- & OpenOffice Add-on Thunderbird Add-on Windows Installations Important Upgrade Information AllinOne Installation ecodms Server ecodms Client ecoice Client PDF/A Printer Microsoft Office Plugin Libre- & OpenOffice Add-on Java Activation Install Add-on Thunderbird Add-on postgresql: Manually Installation Important Information for Chapter Windows Uninstallations ecodms Server ecodms Client ecoice Client ecodms PDF/A Printer Microsoft Office Plugin Libre- & OpenOffice Add-on Thunderbird Add-on Important Information for Chapter Ubuntu / Debian / Raspbian Installations Important Upgrade Information Install Editor Configure apt Sources ecodms Server ecodms Server in a virtualised Linux environment ecodms Client ecoice Client ecodms PDF/A Printer Libre- & OpenOffice Add-on Java Activation Install Add-on Thunderbird Add-on Important Information for Chapter

4 Inhaltsverzeichnis 4 5 Ubuntu / Debian / Raspbian Uninstallations ecodms Server ecodms Client ecoice Client ecodms PDF/A Printer Libre- & OpenOffice Add-on Thunderbird Add-on Important Information for Chapter MacOS Installations ecodms & ecoice Clients Libre- & OpenOffice Add-on Java Activation Install Add-on Thunderbird Add-on ecodms Server, PDF/A Printer & MS Office Plug-in Important Information for Chapter MacOS Uninstallations ecodms & ecoice Clients Libre- & OpenOffice Add-on Thunderbird Add-on Important Information for Chapter NAS Installations Synology: ecodms Server License Information Licence for a New Container License for a Container Update System Requirements Install & Open Docker Search & Install the ecodms Images Create Container Container Settings Select Data Folder Change Language (English) Start Container Update Container Scaninput Folder QNAP: ecodms Server License Information Licence for a New Container License for a Container Update System Requirements Install & Open ContainerStation Search & Install the ecodms Images Container Settings Change Language (English) Select Data Folder Start Container Update Container Scaninput Folder Important Information for Chapter Backup & Restore 98

5 1. System Requirements 5 1 System Requirements Please read the system requirements before installation. For more information and details, please visit our website at ecodms Server Supported Operating Systems: Windows 7, 8, 8.1, 10 Windows Server 2008, 2012 Ubuntu LTS, LTS, LTS Debian Wheezy, Jessie System Kernel: 32 and 64 bit Processor: minimum 2 Cores or minimum 2 Processors (x86/c64) RAM: minimum 4 GB (recommended) Hard Disk Space: ca. 800 MB for the Server, additionally storage for documents Database (Windows): postgresql 9.3.X (included in the installation, if you install postresql manually, please only use version 9.3.X) (Ubuntu & Debian): postgresql (ecodms uses the respective standard database version of the distribution) Java: required (included in the installation) Storage Capacity: unlimited (depending on memory capacity) Number of simultaneous Accesses: Any (Depends on the number of purchased licenses) Database Directory: The database directory must be stored on a local disk. Network or NAS drives (share folders) are not supported., Virtual Machines If you are using a virtual machine, it must be a hardware virtual machine (HVM). ecodms does not support PV (Paravirtualization) Raspberry PI RASPBERRY PI 2 MODEL B (RASPBIAN Jessie 32-bit RAM: 1 GB CPU: 900 MHZ quad-core ARM Cortex-A7) RASPBERRY PI 3 MODEL B (RASPBIAN Jessie 32-bit RAM: 1 GB CPU: 1,2 GHz quad-core ARMv8 CPU) NAS Systems The ecodms server can be installed on a QNAP and Synology system. ecodms supports those device types from QNAP and Synology which provide container virtualisation. The "QNAP ContainerStation" integrates the virtualisation technologies LXC (Linux containers) and Docker, thus allowing the operation of several isolated Linux systems on a QNAP NAS. Using Synology, Docker can be installed via the Package Center. The ecodms server is installed via the Docker images provided especially for the two NAS systems. This image serves as a template when creating a respective ecodms container. Hardware: QNAP Synology System: Docker support (virtualisation) Processor: X86 RAM: min. 2 GB RAM (required)

6 1. System Requirements ecodms Client Supported Operating Systems: Windows 7, 8, 8.1, 10 Windows Server 2008, 2012 Ubuntu (KDE/Gnome) LTS, LTS, LTS Debian (KDE/Gnome) Wheezy, Jessie MacOS 10.8 (64bit) & higher System Kernel: 32 and 64 bit Processor Architecture: x86/x64 RAM: minimum 1 GB (recommended) Hard Disk Space: ca. 60 MB Display Resolution: minimum 1280 x 1024 Pixel 1.3 ecoice Client Supported Operating Systems: Windows 7, 8, 8.1, 10 Windows Server 2008, 2012 Ubuntu (KDE/Gnome) LTS, LTS, LTS Debian (KDE/Gnome) Wheezy, Jessie MacOS 10.8 (64bit) & higher System Kernel: 32 and 64 bit Processor Architecture: x86/x64 RAM: minimum 1 GB (recommended) Hard Disk Space: ca. 100 MB Display Resolution: minimum 1280 x 1024 Pixel File formats: TIFF and PDF Scanner Interface: TWAIN, WIA, SANE - additional scaninput folder 1.4 PDF/A Printer Supported Operating Systems: Windows 7, 8, 8.1, 10 Windows Server 2008, 2012 Ubuntu LTS, LTS, LTS Debian Wheezy, Jessie System Kernel: 32 and 64 bit Hard Disk Space: ca. 50 MB Display Resolution: minimum 1280 x 1024 Pixel Storage Format for Archiving: PDF/A Supported Applications: Printable Software 1.5 Microsoft Office Plug-in Supported Operating Systems: Windows 7, 8, 8.1, 10 Windows Server 2008, 2012 System Kernel: 32 and 64 bit Display Resolution: minimum 1280 x 1024 Pixel Storage Format for Archiving: PDF/A & Original Office Format, s from Outlook: PDF/A & EML Format Supported Applications: Word, Excel, PowerPoint, Outlook Supported Office Versions: 2007, 2010, 2013, 2016

7 1. System Requirements Libre- & OpenOffice Add-on Supported Operating Systems: Windows 7, 8, 8.1, 10 Windows Server 2008, 2012 Ubuntu LTS, LTS, LTS Debian Wheezy, Jessie MacOS 10.8 (64bit) & higher System Kernel: 32 and 64 bit Display Resolution: minimum 1280 x 1024 Pixel Storage Format for Archiving: PDF/A & Original Office Format Supported Applications: Writer, Calc, Draw, Impress Supported Office Versions: from Version Thunderbird Add-on Supported Operating Systems: Windows 7, 8, 8.1, 10 Windows Server 2008, 2012 Ubuntu LTS, LTS, LTS Debian Wheezy, Jessie MacOS 10.8 (64bit) & higher System Kernel: 32 and 64 bit Display Resolution: minimum 1280 x 1024 Pixel Storage Format for Archiving: PDF/A & EML Supported Thunderbird Versions: from Version 10.X Information: No PDF/A files are generated via the ecodms Thunderbird plugin for MacOS. Only the original is deposited as an EML file. This is NOT an error in ecodms:

8 2. Windows Installations 8 2 Windows Installations The following section describes how to install the available ecodms components under Windows. Ensure you make a backup before updating or upgrading. If you want to upgrade from a previous version (e.g ) to the current major release, follow the instructions in area "Important Upgrade Information". If you want to update the existing ecodms components from version (krusty) with a later version, you do not need to uninstall this version beforehand. The new software components can be installed over the existing ones. 2.1 Important Upgrade Information If you want to upgrade from a previous version (e.g ) to the current major release, follow this Upgrade Information. If you want to update the existing ecodms components from version (krusty) with a later version, you do not need to uninstall this version beforehand. In this case the new software components can be installed over the existing ones. Perform the upgrade in the following order: 1. Make sure that ecoice does not include any documents. a) These documents could be lost when you update the system. 2. Create a complete backup of the existing database. a) Use the OneClick Backup component of ecodms to create a backup. You can also use the backup script to create the backup manually. 3. For safety, we recommend you also to create a separate backup of the data directory. You have selected / entered the directory while install the ecodms Server component. As default these data are stored at %ProgramData% To save the data directory, complete the following steps: a) Use the service management of your windows system to stop the following services: i. ecosim S economicsystemindependentm oduleserver ii. ecodmspsql 8.X P ostgresqlserver8.x

9 2. Windows Installations 9 Abb. (ähnlich) 2.1: Stop Service b) After the services were stopped, you can copy the data directory. 4. Now uninstall all existing components of ecodms. To do this, follow the steps in the installation guide of your ecodms version. a) Make sure that really all components will be uninstalled. b) Be carefull that you do not mix the old and new components of ecodms. 5. Restart the computer now. 6. Now install the ecodms Server and the other components of the new version (krusty) according to this installation guide. 7. Restart the computer now. 8. Now import the backup completely and properly. a) Use the OneClick Backup component of ecodms to import the backup. You can also use the restore script to restore the database manually. b) Read the ecodms manual for more information about the restore process. 2.2 AllinOne Installation Use the AllinOneInstaller to install all necessary components (ecodms Server, ecodms Client, ecoice Client, PDF/A Printer) in one installation. The AllinOneInstaller performs the installation for all selected components one after the other. If all ecodms components are installed on one workstation, a profile is already created and shown in the ecodms Connection Manager. Please read the chapter Access Data in the ecodms Manual to get more information about the login information [3, 4, 1, 2, 5, 7]. 1. If this installation is an update, you must first exit the connection manager and ensure that all connections to ecodms are disconnected. Abb. (ähnlich) 2.2: Exit Connection Manager 2. Download the file for the "AllinOne Installer" at ecodms.de.

10 2. Windows Installations Unpack the zip file. 4. Execute the installation file "...exe". 5. Select the language for the installation of ecodms Server. a) Please read the language messages at the top of this chapter. Abb. (ähnlich) 2.3: AllinOne Installer: Language Selection 6. Click "Next" in the "Start Screen". Abb. (ähnlich) 2.4: Startscreen AllinOneInstaller 7. Select the components you want to install. Then click Next. Abb. (ähnlich) 2.5: AllinOneInstaller - Select Components

11 2. Windows Installations The installation of the selected components is prepared. This process may take some time. Abb. (ähnlich) 2.6: AllinOneInstaller - Preparing for installation 9. Follow the installation instructions for the selected components. In this case, always start at Step ecodms Server The following describes how to install ecodms Server on a Windows system [3, 4, 1, 2, 5, 7]. 1. If this installation is an update, you must first exit the connection manager and ensure that all connections to ecodms are disconnected. Abb. (ähnlich) 2.7: Exit Connection Manager 2. Download the file for the ecodms Server at ecodms.de. 3. Unpack the zip file. 4. Execute the installation file "...exe". 5. Select the language for the installation of ecodms Server. a) Please read the language messages at the top of this chapter. Abb. (ähnlich) 2.8: ecodms Server: Language Selection 6. Confirm the dialogue box with "Yes".

12 2. Windows Installations 12 Abb. (ähnlich) 2.9: ecodms Server: Information 7. Click "Next" in the "Start Screen". Abb. (ähnlich) 2.10: Start Screen ecodms Server 8. Read the License Agreement carefully and tick the check box "I accept the terms of the License Agreement". Click "Next" to continue. Abb. (ähnlich) 2.11: ecodms Server: License Agreement 9. Select the server components you want to install. We recommend you install "ecodms Server 12.05" and "PostgreS- QL". If the installation is an update, only the "ecodms Server 12.05" is displayed here for selection.

13 2. Windows Installations 13 Abb. (ähnlich) 2.12: ecodms Server: Select Components 10. Select the installation destination. You can change the suggested path by clicking "Browse". Abb. (ähnlich) 2.13: ecodms Server: Installation Destination 11. If the ecodms Server is installed for the first time, the ports selection for ecodms displays now. Select the default port for ecodms and for the database. If this is a default installation, the predefined ports should not be changed. The ports are used, for example, for the client connections and for the database. If the selected port is already occupied, an error message appears [5]. a) If postgresql is already installed in a matching version, the installation of the ecodms Server does not create a new instance. A new database (ecodms) is created in the existing instance. i. During the installation, the access data for the existing postgresql database is requested. b) If postgresql was installed manually, ensure that the postgre service is started before the ecodms Server starts. Otherwise the ecodms Server can not be started.

14 2. Windows Installations 14 Abb. (ähnlich) 2.14: ecodms Server: Enter Port 12. Select the folder in which you want ecodms to save the archived documents. We recommend you do not change the default folder. Please note that the the database directory has to be stored on a local disk. Abb. (ähnlich) 2.15: ecodms Server: Data Path 13. The setup dialogue box displays the installation information. Confirm the information with "Next". Abb. (ähnlich) 2.16: ecodms Server: Copy Files

15 2. Windows Installations The selected server components are installed. This operation may take a while. Abb. (ähnlich) 2.17: ecodms Server: Installing ecodms Server & postgresql Abb. (ähnlich) 2.18: ecodms Server: Installation postgresql 15. The installation of the ecodms Server is complete. Click "Finish". a) We recommend you the restart the system now. Abb. (ähnlich) 2.19: ecodms Server: Installation Complete 2.4 ecodms Client The Connection Manager is integrated with the installation of ecodms. With this installation, the ecodms client and the Connection Manager are installed. The following describes how to install ecodms on a Windows system [1, 2, 7]. 1. If this installation is an update, you must first exit the connection manager.

16 2. Windows Installations 16 Abb. (ähnlich) 2.20: Exit Connection Manager 2. Download the file for the "ecodms and ecoice Client" at ecodms.de. 3. Unpack the zip file. 4. Execute the installation file "...exe" for ecodms. 5. Select the language for the installation of ecodms. a) Please read the language messages at the top of this chapter. Abb. (ähnlich) 2.21: ecodms: Language Selection 6. Confirm the dialogue box with "Yes". Abb. (ähnlich) 2.22: ecodms: Message 7. Click "Next" in the "Start Screen". Abb. (ähnlich) 2.23: Start Screen ecodms 8. Read the License Agreement carefully and tick the check box "I accept the terms of the License Agreement". Click "Next" to continue.

17 2. Windows Installations 17 Abb. (ähnlich) 2.24: ecodms: License Agreement 9. Select the installation destination. You can change the suggested path by clicking "Browse". Abb. (ähnlich) 2.25: ecodms: Installation Destination 10. The setup dialogue box displays the installation information. Confirm the information with "Next". Abb. (ähnlich) 2.26: ecodms: Copy Files

18 2. Windows Installations The installation is performed. This operation may take a while. Abb. (ähnlich) 2.27: ecodms: Installation 12. The installation is complete. Click "Finish". Abb. (ähnlich) 2.28: ecodms: Installation Complete 2.5 ecoice Client The following describes how to install ecoice for editing and archiving of scanned documents on a Windows system [1, 2, 7]. 1. If this installation is an update, you must first exit the connection manager. Abb. (ähnlich) 2.29: Exit Connection Manager 2. Download the file for the ecodms Client at ecodms.de. 3. Unpack the zip file. 4. Execute the installation file "...exe" for ecoice.

19 2. Windows Installations Select the language for the installation of ecoice. a) Please read the language messages at the top of this chapter. Abb. (ähnlich) 2.30: ecoice: Language Selection 6. Confirm the dialogue box with "Yes". Abb. (ähnlich) 2.31: ecoice: Message 7. Click "Next" in the "Start Screen. Abb. (ähnlich) 2.32: Start Screen ecoice 8. Read the License Agreement carefully and tick the check box "I accept the terms of the License Agreement". Click "Next" to continue.

20 2. Windows Installations 20 Abb. (ähnlich) 2.33: ecoice: License Agreement 9. Select the installation destination. You can change the suggested path by clicking "Browse". Abb. (ähnlich) 2.34: ecoice: Installation Destination 10. The setup dialogue box displays the installation information. Confirm the information with "Next". Abb. (ähnlich) 2.35: ecoice: Copy Files

21 2. Windows Installations The installation is performed. This operation may take a while. Abb. (ähnlich) 2.36: ecoice: Installation 12. The installation is complete. Click "Finish". Abb. (ähnlich) 2.37: ecoice: Installation Complete 2.6 PDF/A Printer The following describes how to install ecodms PDF/A Printer on a Windows system [1, 2, 7]. 1. Download the file for the "ecodms PDF/A Printer" at ecodms.de. 2. Unpack the zip file. 3. Execute the installation file "...exe". 4. Select the language for the installation of ecodms PDF/A printer. a) Please read the language messages at the top of this chapter.

22 2. Windows Installations 22 Abb. (ähnlich) 2.38: PDF/A Printer: Language Selection 5. Confirm the dialogue box with "Yes". Abb. (ähnlich) 2.39: PDF/A Printer: Message 6. Click "Next" in the "Start Screen". Abb. (ähnlich) 2.40: Start Screen PDF/A Printer 7. Read the License Agreement carefully and tick the check box "I accept the terms of the License Agreement". Click "Next" to continue.

23 2. Windows Installations 23 Abb. (ähnlich) 2.41: PDF/A Printer: License Agreement 8. Select the installation destination. You can change the suggested path by clicking "Browse". Abb. (ähnlich) 2.42: PDF/A Printer: Installation Destination 9. The setup dialogue box displays the installation information. Confirm the information with "Next". Abb. (ähnlich) 2.43: PDF/A Printer: Copy Files

24 2. Windows Installations The installation is performed. This operation may take a while. Abb. (ähnlich) 2.44: PDF/A Printer: Installation 11. Confirm the Windows confirmation prompt with "Install". Abb. (ähnlich) 2.45: PDF/A Printer: Confirmation Prompt 12. The installation is complete. a) Please read the information in the window. b) Click "Finish". Abb. (ähnlich) 2.46: PDF/A Printer: Installation Complete

25 2. Windows Installations Microsoft Office Plugin The following describes how to install ecodms MS Office Plug-in on a Windows system [1, 2, 7, 6]. 1. Please exit all MS Office programmes BEFORE the installation! 2. Download the file for the ecodms MS Office Plug-in at ecodms.de. 3. Unpack the zip file. 4. Execute the "setup.exe" file (NOT: ecodmsofficepluginsetup.msi) to start the installer. 5. In the first step you must accept the License Agreement for Microsoft.NET Framework. To do so, click "I accept". If this "Framework" is already installed on your computer, the setup skips this step. Abb. (ähnlich) 2.47: MS Office Plugin - License: Framework 6. The "Framework" installation follows. This operation may take a while. If this "Framework" is already installed on your computer, the setup skips this step. Abb. (ähnlich) 2.48: MS Office Plugin - Installation Framework

26 2. Windows Installations The setup wizard for the actual plugin installation opens. Click "Next". Abb. (ähnlich) 2.49: MS Office Plugin - Start Setup Wizard 8. Read the License Agreement carefully and tick the checkbox "I accept the terms of the License Agreement". Click "Next" to continue. Abb. (ähnlich) 2.50: MS Office Plugin - ecodms License Agreement 9. Select the installation destination. You can change the suggested path by clicking "Change".

27 2. Windows Installations 27 Abb. (ähnlich) 2.51: MS Office Plugin - Installation Destination 10. Click "Install" to start the installation. Abb. (ähnlich) 2.52: MS Office Plugin - Start Installation 11. The installation is performed. This operation may take a while.

28 2. Windows Installations 28 Abb. (ähnlich) 2.53: MS Office Plugin - Installation 12. The installation is complete. Click "Finish". Abb. (ähnlich) 2.54: MS Office Plugin - Installation Complete 13. The MS Office programmes can be started again. 2.8 Libre- & OpenOffice Add-on The following describes how to install ecodms Add-on for LibreOffice and OpenOffice on a Windows system [1, 2, 7, 6] Java Activation To install and use the ecodms Office Add-on, Java must be enabled in LibreOffice / OpenOffice. Proceed as follows [1, 2, 7, 6]: 1. Start one of the Office applications. 2. Tools -> Options 3. LibreOffice -> Extended

29 2. Windows Installations Java Options: Enable the option "Use a Java runtime environment". 5. Select the manufacturer. a) If your device does not have any Java Installation, please install Java before installing the Office Add-on. You can usually download java for free on the internet. b) The instructions, information, license agreements and system requirements of the respective manufacturer apply. 6. Save the settings with OK. Abb. (ähnlich) 2.55: Enable Java in Office Install Add-on If Java is enabled, you can install the add-on as follows [1, 2, 7, 6]: 1. Download the add-on in the download area at 2. Unpack the zip file. 3. Start one of the Office programmes (here: LibreOffice Writer). 4. Click "Menu - Extras - Extension Manager". Abb. (ähnlich) 2.56: LibreOffice: Tools -> Extension Manager

30 2. Windows Installations Click the "Add" button in the "Extension Manager". Abb. (ähnlich) 2.57: LibreOffice: Extension Manager 6. Select the "OXT" file for the "ecodms Plugin" and click "Open". Abb. (ähnlich) 2.58: LibreOffice: Extension Manager - Select File 7. Confirm any confirmation prompt according to your installation needs. Abb. (ähnlich) 2.59: Confirmation Prompt: User Environment

31 2. Windows Installations The installation is complete. You must restart the programme for the final activation of the plugin. Abb. (ähnlich) 2.60: LibreOffice: Installation Complete 9. The ecodms icon should now be displayed in the Office applications. As an alternative you can use the new menu item ecodms. 2.9 Thunderbird Add-on The following describes how to install ecodms Thunderbird Add-on on a Windows system [1, 2, 7, 6]. 1. Download the add-on in the download area at 2. Unpack the zip file. 3. Start "Thunderbird". 4. Click "Menu - Extras - Add-ons". Abb. (ähnlich) 2.61: Thunderbird: Extras -> Add-ons

32 2. Windows Installations Select the function "Install Add-on from File..." in the "Add-ons Manager". Abb. (ähnlich) 2.62: Thunderbird: Install Add-on from File 6. Select the "XPI" file for the "ecodms Plugin" and click "Open". Abb. (ähnlich) 2.63: Thunderbird: Select Add-on 7. Confirm the confirmation prompt and click "Install Now" to start the installation. Abb. (ähnlich) 2.64: Thunderbird: Install Add-on

33 2. Windows Installations To finalise the installation and to conclude the activation of the function, you must restart "Thunderbird". To do so, click "Restart Now". Abb. (ähnlich) 2.65: Thunderbird: Restart 9. The ecodms function is now installed as an extension and is available as an executable function on the toolbar of the programme. Abb. (ähnlich) 2.66: Thunderbird: ecodms Installation Complete 2.10 postgresql: Manually Installation You need the postgresql database in order to install and use the ecodms Server successfully. Usually the database is installed together with the ecodms Server. However, if a manual installation is planned or required, complete the following steps [3, 4, 1, 2, 5]: 1. If an error occurred in the postgresql installation during the installation of the server and the database, uninstall all previously installed ecodms components and restart the computer / server. 2. Enter the address in your internet browser 3. Click the menu item Downloads. 4. Select an operating system (here as an example: Windows) 5. Click AllinOneInstaller in the download area. 6. Now select the Windows 8.4.X.X version.

34 2. Windows Installations A download window opens. 8. Start the download of postgresql-8.4.x-x-windows.exe and save the file on your computer in a destination folder (for example desktop). 9. To open the console a) in Windows 7, click the start icon (Windows icon) and then enter the command cmd in the entry window b) in Windows XP, click Start -> Execute on the toolbar and then enter the command cmd. 10. Then enter the following commands in the open window and confirm them with Enter cd DestinationPath Filename install_runtimes O Example: cd Desktop postgresql-9.3.x-x-windows install_runtimes Now follow the installation wizard. Important Information for Chapter 2 [1] During the installation the firewall might inquire whether the application is allowed to access the network. Confirm this with Yes. [2] Ensure you make a backup before updating, upgrading or a reinstallation or uninstallation. If you want to upgrade from a previous version (e.g ) to the current major release, follow the instructions in the area Ïmportant Upgrade Information". If you want to update the existing ecodms components from version (krusty) with a later version, you do not need to uninstall this version beforehand. The new software components can be installed over the existing ones. Do not mix the components of an earlier ecodms version (eg 12.05, 11.06) with this version. After an upgrade, a downgrade is only possible to an older ecodms version when there is a full backup of the previous version. [3] If ecodms has been uninstalled and you want to reinstall, the computer must be restarted first. [4] On Windows systems, the installation must be executed by a local administrator (not a domain administrator). [5] The database folder (postgresql) must not contain any spaces, umlauts or special characters and must be located on a local hard disk. To do so, do not use a network drive or an NAS drive (no share folder). If postgresql is already installed, the installation of the ecodms server does not create a new instance. A new database (ecodms) is created in the existing instance. If postgresql was installed manually, you must disable the postgresql installation when the ecodms server is installed afterwards. If postgresql was installed manually, ensure that it was the postgresql version supported by ecodms (postgresql 9.3.X - 32bit). During the installation, the access data for the existing postgresql database is requested. If the existing postgresql version does not match the ecodms version, postgresql - if not disabled in the ecodms installer - is installed parallel to the existing system. If postgresql was installed manually, ensure that the postgre service is started before the ecodms server starts. Otherwise the ecodms server can not be started. [6] The prerequisite for the use of this Plugin is the installation of the current software components of ecodms Server, ecodms Client and ecodms PDF/A Printer. [7] You can install server and clients in different languages. The view of the classification attributes and messages depends on the language you have selected for the ecodms server component.

35 3. Windows Uninstallations 35 3 Windows Uninstallations The following section describes how to uninstall ecodms components under Windows [2, 3, 1]. 3.1 ecodms Server The following explains the uninstall process of the ecodms server under Windows [2, 3, 1]. 1. First, close all connection managers and make sure that no user is connected with the server. Abb. (ähnlich) 3.1: Close Connection Manager 2. Select -> Programmes -> ecodms Server on the control panel. 3. Now execute the "Uninstall" process / function. 4. Confirm the question whether you want to uninstall the programme with "Yes". Cancel the process with "No". Abb. (ähnlich) 3.2: ecodms Server - Uninstallation - Question 5. The first uninstallation steps start. This operation may take a while. 6. To start the uninstall process, confirm the security message related to the database and data backup with "Continue". Click "Cancel" to abort the process. a) Please note that by uninstalling the ecodms server under Windows, the entire database of ecodms will be deleted. The ecodms server component as well as the postgresql database with all archived documents, settings and information are deleted. You can only restore the data if you created a complete and clean backup before uninstalling.

36 3. Windows Uninstallations 36 Abb. (ähnlich) 3.3: ecodms Server - Uninstallation - Database Information 7. The uninstall process is performed. This operation may take a while. Abb. (ähnlich) 3.4: ecodms Server - Uninstallation - Processing 8. The uninstall process is complete. The ecodms server has been removed from your system. a) If you want to reinstall the system afterwards, you must previously restart the computer!

37 3. Windows Uninstallations 37 Abb. (ähnlich) 3.5: ecodms Server - Uninstallation - Completed 3.2 ecodms Client The following explains the uninstall process of the ecodms client under Windows [1]. 1. First, close all connection managers and make sure that no user is connected with the server. Abb. (ähnlich) 3.6: Close Connection Manager 2. Select -> Programmes -> ecodms Server on the control panel. 3. Now execute the "Uninstall" process / function. 4. Confirm the question whether you want to uninstall the programme with "Yes". Cancel the process with "No". Abb. (ähnlich) 3.7: ecodms Client - Uninstallation - Question 5. The uninstall process is performed. This operation may take a while. 6. The uninstallation is complete and the ecodms client has been removed from your system.

38 3. Windows Uninstallations 38 Abb. (ähnlich) 3.8: ecodms Client - Uninstallation - Completed 3.3 ecoice Client The following explains the uninstall process of the ecoice client under Windows [1]. 1. First, close all connection managers and make sure that no user is connected with the server. Abb. (ähnlich) 3.9: Close Connection Manager 2. Select -> Programmes -> ecodms Server on the control panel. 3. Now execute the "Uninstall" process / function. 4. Confirm the question whether you want to uninstall the programme with "Yes". Cancel the process with "No". Abb. (ähnlich) 3.10: ecoice Client - Uninstallation - Question 5. The uninstall process is performed. This operation may take a while. 6. The uninstallation is complete and the ecoice client has been removed from your system.

39 3. Windows Uninstallations 39 Abb. (ähnlich) 3.11: ecoice Client - Uninstallation - Completed 3.4 ecodms PDF/A Printer The following explains the uninstall process of the ecodms PDF/A Printer under Windows [1]. 1. First, close all connection managers and make sure that no user is connected with the server. Abb. (ähnlich) 3.12: Close Connection Manager 2. Select -> Programmes -> ecodms Server on the control panel. 3. Now execute the "Uninstall" process / function. 4. Confirm the question whether you want to uninstall the programme with "Yes". Cancel the process with "No". Abb. (ähnlich) 3.13: ecodms PDF/A Printer - Uninstallation - Question 5. The uninstall process is performed. This operation may take a while. 6. The uninstallation is complete and the ecodms PDF/A Printer has been removed from your system.

40 3. Windows Uninstallations 40 Abb. (ähnlich) 3.14: ecodms PDF/A Printer - Uninstallation - Completed 3.5 Microsoft Office Plugin The following describes how to uninstall ecodms MS Office Plug-in on a Windows system [1]. 1. First, exit all Office Applications. 2. Select Programs -> "ecodms Office Plugin" in the control panel. 3. Use the "Uninstall" function. 4. The uninstallation is prepared. Abb. (ähnlich) 3.15: MS Office Plugin - Uninstallation: Preparation 5. The uninstall process is performed. This operation may take a while. Abb. (ähnlich) 3.16: MS Office Plugin - Uninstallation: Execution 6. The uninstallation is complete and the ecodms MS Office Plug-in was removed from your system.

41 3. Windows Uninstallations Libre- & OpenOffice Add-on The following describes how to uninstall ecodms Libre- and OpenOffice Add-on on a Windows system [1]. 1. Start one of the Office programmes (here: LibreOffice Writer). 2. Click "Menu - Extras - Extension Manager". Abb. (ähnlich) 3.17: LibreOffice: Extras -> Extension Manager 3. Select the "ecodms Plugin" in the "Extension Manager" and click the "Remove" button. Abb. (ähnlich) 3.18: LibreOffice: Extension Manager 4. Confirm any confirmation prompt with "OK".

42 3. Windows Uninstallations 42 Abb. (ähnlich) 3.19: Confirmation Prompt: User Environment 5. You have now uninstalled the plugin. You must restart the programme to remove the plugin completely. 3.7 Thunderbird Add-on The following describes how to uninstall ecodms Thunderbird Add-on on a Windows system [1]. 1. Start "Thunderbird". 2. Click "Menu - Extras - Add-ons". Abb. (ähnlich) 3.20: Thunderbird: Extras -> Add-ons 3. Select the "ecodmsthunderbirdadd-on" extension in the "Add-ons Manager" and click the "Remove" button.

43 3. Windows Uninstallations 43 Abb. (ähnlich) 3.21: Thunderbird: Uninstall Add-on 4. To finalise the uninstall process and to remove the function completely, you must restart "Thunderbird". To do so, click "Restart Now". Abb. (ähnlich) 3.22: Thunderbird: Restart Important Information for Chapter 3

44 3. Windows Uninstallations 44 [1] Ensure you make a backup before updating, upgrading or a reinstallation or uninstallation. If you want to upgrade from a previous version (e.g ) to the current major release, follow the instructions in the area Ïmportant Upgrade Information". If you want to update the existing ecodms components from version (krusty) with a later version, you do not need to uninstall this version beforehand. The new software components can be installed over the existing ones. Do not mix the components of an earlier ecodms version (eg 12.05, 11.06) with this version. After an upgrade, a downgrade is only possible to an older ecodms version when there is a full backup of the previous version. [2] If ecodms has been uninstalled and you want to reinstall, the computer must be restarted first. [3] If the installation is a standard installation (ecodms Server (ecosims) including database via the ecodms installer) and you delete ecodms server components, all ecodms data is also deleted irrevocably. You can only restore all the archived files, information settings etc. if you created a comprehensive and clean backup of the entire database before uninstalling. Without a backup you will not be able to restore your data after uninstalling.

45 4. Ubuntu / Debian / Raspbian Installations 45 4 Ubuntu / Debian / Raspbian Installations The following section describes how to install the available ecodms components under Ubuntu, Debian and Raspbian. 4.1 Important Upgrade Information If you want to upgrade from a previous version (e.g ) to the current major release, follow this Upgrade Information. If you want to update the existing ecodms components from version (krusty) with a later version, you do not need to uninstall this version beforehand. In this case the new software components can be installed over the existing ones. Perform the upgrade in the following order: 1. Make sure that ecoice does not include any documents. a) These documents could be lost when you update the system. 2. Create a complete backup of the existing database. a) Use the backup script to create the backup manually. 3. Now uninstall all existing components of ecodms. To do this, follow the steps in the installation guide of your ecodms version. a) Do not remove the postgresql database! b) Make sure that really all components will be uninstalled. c) Be carefull that you do not mix the old and new components of ecodms. 4. Restart the computer now. 5. Now install the ecodms Server and the other components of the new version (krusty) according to the new installation instructions. a) The database is automatically updated to the new version. 6. Restart the computer now. 4.2 Install Editor To install the ecodms components, you need an editor. To install, proceed the following steps: 1. Open the console (terminal) and enter the following command to install mcedit : sudo apt-get install mc 2. Confirm your entry with Enter. 3. The editor will now be installed on your device. a) The instructions, information, license agreements and system requirements of the respective manufacturer apply. 4.3 Configure apt Sources Before you can install the ecodms components, you must first define the necessary apt sources. Proceed as follows [2, 1, 3, 5]. 1. Now open the "sources.list" file for editing as follows:

46 4. Ubuntu / Debian / Raspbian Installations 46 sudo mcedit /etc/apt/sources.list a) You can also create your own sources list for the installation as follows: sudo mcedit /etc/apt/sources.list.d/ecodms.list 2. Add the following rows (in accordance with your operating system) to the end of the file: 32bit / Ubuntu LTS deb / 64bit / Ubuntu LTS deb / 32bit / Ubuntu LTS deb / 64bit / Ubuntu LTS deb / 32bit / Ubuntu LTS deb / 64bit / Ubuntu LTS deb / 32bit / Debian Wheezy deb / 64bit / Debian Wheezy deb / 32bit / Debian Jessie deb / 64bit / Debian Jessie deb / 32bit / Debian Jessie (Raspbian for Raspberry PI) deb / 3. Save your entry with "F2". 4. Exit the editor with"f10" or ESC (depending on the operating system). 5. Import the Public Key of ecodms Repositories : wget -O - sudo apt-key add - 6. Before you can install the individual components, the package sources must be updated with sudo apt-get update

47 4. Ubuntu / Debian / Raspbian Installations ecodms Server The following describes how to install ecodms Server on a Ubuntu / Debian system [2, 1, 3, 5]. 1. If this installation is an update, you must first exit the connection manager and ensure that all connections to ecodms are disconnected. Abb. (ähnlich) 4.1: Exit Connection Manager 2. A precondition for this installation is that the apt-sources were edited as described in this manual. 3. Open the console. 4. Start the installation with sudo apt-get install ecodmsserver 5. Confirm the displayed questions / warnings with YES by entering Y [...]Do you want to continue?[...] [...]Do you want to install these packages without checking?[...] This process may take a while. 6. Select language and confirm with Enter. 7. The "License Agreement" is displayed. Please read the agreement carefully and accept it. Use the Tab key to skip to "OK" and confirm with "Enter". 8. The installation now continues. This process may take a while ecodms Server in a virtualised Linux environment If the ecodms Server is installed in a virtualised Linux environment, there may be some difficulties when starting the ecodms Server, depending on the type of virtualisation. The cause of the issue is that the random values supplied by the VM required to generate keys are either missing or insufficient. To solve this issue, please enter the following commands in the console [2, 1, 3, 5]: sudo service ecodms stop sudo apt-get install haveged sudo service ecodms start 4.5 ecodms Client The following describes how to install ecodms Client on a Ubuntu / Debian system [1, 3, 5]. 1. If this installation is an update, you must first exit the connection manager and ensure that all connections to ecodms are disconnected. Abb. (ähnlich) 4.2: Exit Connection Manager 2. A precondition for this installation is that the apt-sources were edited as described in this manual.

48 4. Ubuntu / Debian / Raspbian Installations Open the console. 4. Start the installation with sudo apt-get install ecodmsclient 5. Confirm the displayed question / warning with YES by entering Y [...]Do you want to install the packages without checking?[...] This process may take a while. 6. Select language and confirm with Enter. 7. The installation is now performed and is then complete Debian. This process may take a while. 4.6 ecoice Client The following describes how to install ecoice Client on a Ubuntu / Debian system [1, 3, 5]. 1. If this installation is an update, you must first exit the connection manager and ensure that all connections to ecodms are disconnected. Abb. (ähnlich) 4.3: Exit Connection Manager 2. A precondition for this installation is that the apt-sources were edited as described in this manual. 3. Open the console. 4. Start the installation with sudo apt-get install ecoice 5. Confirm the displayed question / warning with YES by entering Y [...]Do you want to install the packages without checking?[...] This process may take a while. 6. Select language and confirm with Enter. 7. The installation is performed. This process may take a while. 4.7 ecodms PDF/A Printer The following describes how to install ecodms PDF/A Printer on a Ubuntu / Debian system [1, 3, 5]. 1. If this installation is an update, you must first exit the connection manager and ensure that all connections to ecodms are disconnected. Abb. (ähnlich) 4.4: Exit Connection Manager

49 4. Ubuntu / Debian / Raspbian Installations A precondition for this installation is that the apt-sources were edited as described in this manual. 3. Open the console. 4. Start the installation with sudo apt-get install ecodmsprinter 5. Confirm the displayed question / warning with YES by entering Y [...]Do you want to install the packages without checking?[...] This process may take a while. 6. The installation is performed. This process may take a while. 4.8 Libre- & OpenOffice Add-on The following describes how to install ecodms Libre- and OpenOffice Add-on on a Ubuntu / Debian system [1, 3, 5] Java Activation To install and use the ecodms Office Add-on, Java must be enabled in LibreOffice / OpenOffice. Proceed as follows [1, 5, 4]: 1. Start one of the Office applications. 2. Tools -> Options 3. LibreOffice -> Extended 4. Java Options: Enable the option "Use a Java runtime environment". 5. Select the manufacturer. a) If your device does not have any Java Installation, please install Java before installing the Office Add-on. Office should be closed during the installation of Java. i. OpenOffice: Enter the following command in your console: sudo apt-get install openoffice.org-java-common ii. LibreOffice: Enter the following command in your console: sudo apt-get install libreoffice-java-common b) The instructions, information, license agreements and system requirements of the respective manufacturer apply. 6. Save the settings with OK. Abb. (ähnlich) 4.5: Enable Java in Office

50 4. Ubuntu / Debian / Raspbian Installations Install Add-on If Java is enabled, you can install the add-on as follows [1, 5, 4]: 1. Download the add-on in the download area at 2. Unpack the zip file. 3. Start one of the Office programmes (here: LibreOffice Writer). 4. Click "Menu - Extras - Extension Manager". Abb. (ähnlich) 4.6: LibreOffice: Tools -> Extension Manager 5. Click the "Add" button in the "Extension Manager". Abb. (ähnlich) 4.7: LibreOffice: Extension Manager 6. Select the "OXT" file for the "ecodms Plugin" and click "Open".

51 4. Ubuntu / Debian / Raspbian Installations 51 Abb. (ähnlich) 4.8: LibreOffice: Extension Manager - Select File 7. Confirm any confirmation prompt according to your installation needs. Abb. (ähnlich) 4.9: Confirmation Prompt: User Environment 8. The installation is complete. You must restart the programme for the final activation of the plugin. Abb. (ähnlich) 4.10: LibreOffice: Installation Complete 9. The ecodms icon should now be displayed in the Office applications. As an alternative you can use the new menu item ecodms.

52 4. Ubuntu / Debian / Raspbian Installations Thunderbird Add-on The following describes how to install ecodms Thunderbird Add-on on a Ubuntu / Debian system [1, 3, 5]. 1. Download the add-on in the download area at 2. Unpack the zip file. 3. Start "Thunderbird". 4. Click "Menu - Extras - Add-ons". Abb. (ähnlich) 4.11: Thunderbird: Extras -> Add-ons 5. Select the function "Install Add-on from File..." in the "Add-ons Manager". Abb. (ähnlich) 4.12: Thunderbird: Install Add-on from File 6. Select the "XPI" file for the "ecodms Plugin" and click "Open".

53 4. Ubuntu / Debian / Raspbian Installations 53 Abb. (ähnlich) 4.13: Thunderbird: Select Add-on 7. Confirm the confirmation prompt and click "Install Now" to start the installation. Abb. (ähnlich) 4.14: Thunderbird: Install Add-on 8. To finalise the installation and to conclude the activation of the function, you must restart "Thunderbird". To do so, click "Restart Now". Abb. (ähnlich) 4.15: Thunderbird: Restart 9. The ecodms function is now installed as an extension and is available as an executable function on the toolbar of the

54 4. Ubuntu / Debian / Raspbian Installations 54 programme. Abb. (ähnlich) 4.16: Thunderbird: ecodms Installation Complete Important Information for Chapter 4 [1] Ensure you make a backup before updating, upgrading or a reinstallation or uninstallation. If you want to upgrade from a previous version (e.g ) to the current major release, follow the instructions in the area Ïmportant Upgrade Information". If you want to update the existing ecodms components from version (krusty) with a later version, you do not need to uninstall this version beforehand. The new software components can be installed over the existing ones. Do not mix the components of an earlier ecodms version (eg 12.05, 11.06) with this version. After an upgrade, a downgrade is only possible to an older ecodms version when there is a full backup of the previous version. [2] If ecodms has been uninstalled and you want to reinstall, the computer must be restarted first. [3] The database folder (postgresql) must not contain any spaces, umlauts or special characters and must be located on a local hard disk. To do so, do not use a network drive or an NAS drive (no share folder). If postgresql is already installed, the installation of the ecodms server does not create a new instance. A new database (ecodms) is created in the existing instance. If postgresql was installed manually, you must disable the postgresql installation when the ecodms server is installed afterwards. If postgresql was installed manually, ensure that it was the postgresql version supported by ecodms (postgresql 9.3.X - 32bit). During the installation, the access data for the existing postgresql database is requested. If the existing postgresql version does not match the ecodms version, postgresql - if not disabled in the ecodms installer - is installed parallel to the existing system. If postgresql was installed manually, ensure that the postgre service is started before the ecodms server starts. Otherwise the ecodms server can not be started. [4] The prerequisite for the use of this Plugin is the installation of the current software components of ecodms Server, ecodms Client and ecodms PDF/A Printer. [5] You can install server and clients in different languages. The view of the classification attributes and messages depends on the language you have selected for the ecodms server component.

55 5. Ubuntu / Debian / Raspbian Uninstallations 55 5 Ubuntu / Debian / Raspbian Uninstallations The following section describes how to uninstall ecodms components under Ubuntu, Debian and Raspbian. 5.1 ecodms Server The following describes how to uninstall ecodms Server on a Ubuntu / Debian system [3, 2, 1]. 1. First, exit all "Connection Managers" and disconnect all existing connections to the ecodms Server. Abb. (ähnlich) 5.1: Exit Connection Manager 2. Open the console. 3. Perform the uninstall process with the following command: sudo apt-get remove ecodmsserver 5.2 ecodms Client The following describes how to uninstall ecodms Client on a Ubuntu / Debian system [2]. 1. First, exit all "Connection Managers" and disconnect all existing connections to the ecodms Server. Abb. (ähnlich) 5.2: Exit Connection Manager 2. Open the console. 3. Perform the uninstall process with the following command: sudo apt-get remove ecodmsclient 5.3 ecoice Client The following describes how to uninstall ecoice Client on a Ubuntu / Debian system [2].

56 5. Ubuntu / Debian / Raspbian Uninstallations First, exit all "Connection Managers" and disconnect all existing connections to the ecodms Server. Abb. (ähnlich) 5.3: Exit Connection Manager 2. Open the console. 3. Perform the uninstall process with the following command sudo apt-get remove ecoice 5.4 ecodms PDF/A Printer The following describes how to uninstall ecoice PDF/A Printer on a Ubuntu / Debian system [2]. 1. Open the console. 2. Perform the uninstall process with the following command: sudo apt-get remove ecodmsprinter 5.5 Libre- & OpenOffice Add-on The following describes how to uninstall ecodms Libre- and OpenOffice Add-on on a Ubuntu / Debian system [2]. 1. Start one of the Office programmes (here: LibreOffice Writer). 2. Click "Menu - Extras - Extension Manager". Abb. (ähnlich) 5.4: LibreOffice: Extras -> Extension Manager

57 5. Ubuntu / Debian / Raspbian Uninstallations Select the "ecodms Plugin" in the "Extension Manager" and click the "Remove" button. Abb. (ähnlich) 5.5: LibreOffice: Extension Manager 4. Confirm any confirmation prompt with "OK". Abb. (ähnlich) 5.6: Confirmation Prompt: User Environment 5. You have now uninstalled the plugin. You must restart the programme to remove the plugin completely. 5.6 Thunderbird Add-on The following describes how to uninstall ecodms Thunderbird Add-on on a Ubuntu / Debian system [2]. 1. Start "Thunderbird". 2. Click "Menu - Extras - Add-ons".

58 5. Ubuntu / Debian / Raspbian Uninstallations 58 Abb. (ähnlich) 5.7: Thunderbird: Extras -> Add-ons 3. Select the "ecodmsthunderbirdadd-on" extension in the "Add-ons Manager" and click the "Remove" button. Abb. (ähnlich) 5.8: Thunderbird: Uninstall Add-on 4. To finalise the uninstall process and to remove the function completely, you must restart "Thunderbird". To do so, click "Restart Now".

59 5. Ubuntu / Debian / Raspbian Uninstallations 59 Abb. (ähnlich) 5.9: Thunderbird: Restart Important Information for Chapter 5 [1] By uninstalling the ecodms Server component postgresql will not be deleted. Uninstalling the database must be done manually after server uninstalling when needed. [2] Ensure you make a backup before updating, upgrading or a reinstallation or uninstallation. If you want to upgrade from a previous version (e.g ) to the current major release, follow the instructions in the area Ïmportant Upgrade Information". If you want to update the existing ecodms components from version (krusty) with a later version, you do not need to uninstall this version beforehand. The new software components can be installed over the existing ones. Do not mix the components of an earlier ecodms version (eg 12.05, 11.06) with this version. After an upgrade, a downgrade is only possible to an older ecodms version when there is a full backup of the previous version. [3] If ecodms has been uninstalled and you want to reinstall, the computer must be restarted first.

60 6. MacOS Installations 60 6 MacOS Installations The following section describes how to install the available ecodms components under MacOS. 6.1 ecodms & ecoice Clients The following describes how to install ecodms and ecoice Client on a MacOS system [1, 3]. 1. If this installation is an update, you must first exit the connection manager and ensure that all connections to ecodms are disconnected. Abb. (ähnlich) 6.1: Exit Connection Manager 2. Download the file for the "ecodms and ecoice Client" at ecodms.de. 3. Unpack the zip file. 4. Execute the installation file "...mpkg". 5. Click "Continue" in the "Introduction Screen". Abb. (ähnlich) 6.2: MacOS Clients: Introduction 6. Select the language in the License Window. You will find a selection box above the license terms.

61 6. MacOS Installations 61 Abb. (ähnlich) 6.3: MacOS Clients: License (Language) 7. Read the License agreement carefully and click "Continue". Abb. (ähnlich) 6.4: MacOS Clients: License Agreement 8. Confirm the License agreement with "Accept".

62 6. MacOS Installations 62 Abb. (ähnlich) 6.5: MacOS Clients: Accept License Agreement 9. Select the installation destination. You can change the suggested path by clicking "Change installation destination". Abb. (ähnlich) 6.6: MacOS Clients: Installation Destination 10. You may be asked to enter your system access data to continue the installation. Enter your MacOS access data and click "Install Software" to start the installation.

63 6. MacOS Installations 63 Abb. (ähnlich) 6.7: MacOS Clients: Enter Access Data 11. The installation is performed. This operation may take a while. Abb. (ähnlich) 6.8: MacOS Clients: Installation 12. The installation is complete. Click "Close".

64 6. MacOS Installations 64 Abb. (ähnlich) 6.9: MacOS Clients: Installation Complete 6.2 Libre- & OpenOffice Add-on The following describes how to install ecodms Add-on for LibreOffice and OpenOffice on a MacOS system [1, 3, 2] Java Activation To install and use the ecodms Office Add-on, Java must be enabled in LibreOffice / OpenOffice. Proceed as follows [1, 3, 2]: 1. Start one of the Office applications. 2. Tools -> Options 3. LibreOffice -> Extended 4. Java Options: Enable the option "Use a Java runtime environment". 5. Select the manufacturer. a) If your device does not have any Java Installation, please install Java before installing the Office Add-on. You can usually download java for free on the internet. b) The instructions, information, license agreements and system requirements of the respective manufacturer apply. 6. Save the settings with OK.

65 6. MacOS Installations 65 Abb. (ähnlich) 6.10: Enable Java in Office Install Add-on If Java is enabled, you can install the add-on as follows [1, 3, 2]: 1. Download the add-on in the download area at 2. Unpack the zip file. 3. Start one of the Office programmes (here: LibreOffice Writer). 4. Click "Menu - Extras - Extension Manager". Abb. (ähnlich) 6.11: LibreOffice: Tools -> Extension Manager 5. Click the "Add" button in the "Extension Manager".

66 6. MacOS Installations 66 Abb. (ähnlich) 6.12: LibreOffice: Extension Manager 6. Select the "OXT" file for the "ecodms Plugin" and click "Open". Abb. (ähnlich) 6.13: LibreOffice: Extension Manager - Select File 7. Confirm any confirmation prompt according to your installation needs. Abb. (ähnlich) 6.14: Confirmation Prompt: User Environment 8. The installation is complete. You must restart the programme for the final activation of the plugin.

67 6. MacOS Installations 67 Abb. (ähnlich) 6.15: LibreOffice: Installation Complete 9. The ecodms icon should now be displayed in the Office applications. As an alternative you can use the new menu item ecodms. 6.3 Thunderbird Add-on The following describes how to install ecodms Thunderbird Add-on on a MacOS system [1, 3, 2]. 1. Download the add-on in the download area at 2. Unpack the zip file. 3. Start "Thunderbird". 4. Click "Menu - Extras - Add-ons". Abb. (ähnlich) 6.16: Thunderbird: Extras -> Add-ons

68 6. MacOS Installations Select the function "Install Add-on from File..." in the Add-ons Manager. Abb. (ähnlich) 6.17: Thunderbird: Install Add-on from File 6. Select the "XPI" file for the "ecodms Plugin" and click "Open". Abb. (ähnlich) 6.18: Thunderbird: Select Add-on 7. Confirm the confirmation prompt and click "Install Now" to start the installation. Abb. (ähnlich) 6.19: Thunderbird: Install Add-on

69 6. MacOS Installations To finalise the installation and to conclude the activation of the function, you must restart "Thunderbird". To do so, click "Restart Now". Abb. (ähnlich) 6.20: Thunderbird: Restart 9. The ecodms function is now installed as an extension and is available as an executable function on the toolbar of the programme. Abb. (ähnlich) 6.21: Thunderbird: ecodms Installation Complete 6.4 ecodms Server, PDF/A Printer & MS Office Plug-in The ecodms Server and ecodms PDF/A Printer are not on offer for Mac due to the lack of demand. The same applies to the MS Office plugin, for which the interfaces on the Microsoft side are not complete in a MacOS version. In this case, however, you can use the OpenOffice and LibreOffice Add-on. We recommend you install the ecodms server under Windows, Ubuntu, Debian (for example, on a virtual machine) or on a supported NAS device. Then you can access the server with the MacOS clients and setup a connection via the connection manager. Important Information for Chapter 6 [1] Ensure you make a backup before updating, upgrading or a reinstallation or uninstallation. If you want to upgrade from a previous version (e.g ) to the current major release, follow the instructions in the area Ïmportant Upgrade Information". If you want to update the existing ecodms components from version (krusty) with a later version, you do not need to uninstall this version beforehand. The new software components can be installed over the

70 6. MacOS Installations 70 existing ones. Do not mix the components of an earlier ecodms version (eg 12.05, 11.06) with this version. After an upgrade, a downgrade is only possible to an older ecodms version when there is a full backup of the previous version. [2] The prerequisite for the use of this Plugin is the installation of the current software components of ecodms Server, ecodms Client and ecodms PDF/A Printer. [3] You can install server and clients in different languages. The view of the classification attributes and messages depends on the language you have selected for the ecodms server component.

71 7. MacOS Uninstallations 71 7 MacOS Uninstallations The following section describes how to uninstall ecodms components under MacOS. 7.1 ecodms & ecoice Clients The following describes how to uninstall ecodms and ecoice Client on a MacOS system [1]. 1. First, exit all "Connection Managers" and disconnect all existing connections to the ecodms Server. Abb. (ähnlich) 7.1: Exit Connection Manager 2. Open the "Finder" and select the name of your Mac or your MacBook in the left menu bar. 3. Select the internal drive of your computer. 4. Select the "Program files" subfolder. Here you can see all installed programmes. 5. Drag and drop the ecodms or ecoice programme or programme folder into the recycle bin in the dock. a) This uninstalls the programme. 6. If necessary, you can empty the recycle bin later. 7.2 Libre- & OpenOffice Add-on The following describes how to uninstall ecodms Libre- and OpenOffice Add-on on a MacOS system [1]. 1. Start one of the Office programmes (here: LibreOffice Writer). 2. Click "Menu - Extras - Extension Manager".

72 7. MacOS Uninstallations 72 Abb. (ähnlich) 7.2: LibreOffice: Extras -> Extension Manager 3. Select the "ecodms Plugin" in the "Extension Manager" and click the "Remove" button. Abb. (ähnlich) 7.3: LibreOffice: Extension Manager 4. Confirm any confirmation prompt with "OK".

73 7. MacOS Uninstallations 73 Abb. (ähnlich) 7.4: Confirmation Prompt: User Environment 5. You have now uninstalled the plugin. You must restart the programme to remove the plugin completely. 7.3 Thunderbird Add-on The following describes how to uninstall ecodms Thunderbird Add-on on a MacOS system [1]. 1. Start "Thunderbird". 2. Click "Menu - Extras - Add-ons". Abb. (ähnlich) 7.5: Thunderbird: Extras -> Add-ons 3. Select the "ecodmsthunderbirdadd-on" extension in the "Add-ons Manager" and click the "Remove" button.

74 7. MacOS Uninstallations 74 Abb. (ähnlich) 7.6: Thunderbird: Uninstall Add-on 4. To finalise the uninstall process and to remove the function completely, you must restart "Thunderbird". To do so, click "Restart Now". Abb. (ähnlich) 7.7: Thunderbird: Restart Important Information for Chapter 7

75 7. MacOS Uninstallations 75 [1] Ensure you make a backup before updating, upgrading or a reinstallation or uninstallation. If you want to upgrade from a previous version (e.g ) to the current major release, follow the instructions in the area Ïmportant Upgrade Information". If you want to update the existing ecodms components from version (krusty) with a later version, you do not need to uninstall this version beforehand. The new software components can be installed over the existing ones. Do not mix the components of an earlier ecodms version (eg 12.05, 11.06) with this version. After an upgrade, a downgrade is only possible to an older ecodms version when there is a full backup of the previous version.

76 8. NAS Installations 76 8 NAS Installations The acronym "NAS" stands for "network attached storage". Such a system enables storing and providing data in a network. In contrast to the ordinary hard disk storage located directly in or connected with a computer and which, as a rule, is only available to the users that work directly with that PC, NAS systems allow network access from throughout the network. In this case it is a "store that is connected to a network", which means network-attached storage or, for short, "NAS". Apart from providing storage in a network, an "NAS" has many more functions to offer. The devices supported by ecodms have their own operating system. 8.1 Synology: ecodms Server The "Synology" NAS system is manufactured by the Taiwanese company "Synology Inc.". ecodms supports those device types that allow container virtualisation via "Docker". The Docker virtualisation technology can be installed via the "Synology Package Centre". This allows the operation of several isolated Linux systems on a "Synology NAS". ecodms provides dedicated Docker images for "Synology" to install the ecodms Server on the "NAS system". This image serves as a template when creating a respective ecodms container. Docker is an open source software which can be used on Linux-based operating system to isolate applications inside software containers by means of virtualisation. Users who wish to install several ecodms instances on a piece of hardware, for example, can implement this using the ecodms Docker solution. The process for installing the available ecodms components on a Synology NAS system is described here License Information Please note the following information regarding existing Licenses Licence for a New Container If you are already using an ecodms licence for the full version and also want to use this licence for the Docker container, you must deactivate the licence first. Otherwise you cannot activate the new container. Please follow the steps for deactivation and activation, as shown in the ecodms manual License for a Container Update If you want to update the Docker container, the existing ecodms licence becomes invalid. Before updating the container, all active licences must therefore be deactivated. Otherwise activation following an update is no longer possible. Please follow the steps for deactivation and activation, as shown in the ecodms manual System Requirements Please read our system requirements before installing. For more information and details, please visit our website at Hardware: Synology System: Docker support (virtualisation) Processor: X86 RAM: min. 2 GB RAM (required) Install & Open Docker Install the Docker app in the Package Centre of your Synology system and then open the application.

77 8. NAS Installations 77 Abb. (ähnlich) 8.1: Synology - Package Centre Search & Install the ecodms Images 1. In the Registration area of the Docker app, search for the ecodms image with the name "ecodms/allinone" (see red arrow in the figure). 2. Then install the package by a) right-clicking the image and b) then clicking Download This Image (see purple arrow in the figure). c) If you have already installed a package, delete the local image "ecodms/allinone" before installing the new image. Otherwise "Docker" will install the local image without including any interim updates. Abb. (ähnlich) 8.2: Synology - Docker - ecodms Image Create Container 1. In the next step, create the container with the wizard.

78 8. NAS Installations Select the ecodms file in the "Image" area. 3. Now click "Start - Start with wizard". Abb. (ähnlich) 8.3: Synology - Create Container Container Settings 1. In the next step assign a name to the container. Here you can enter, for example, ecodms. 2. Now you can make the "Port Settings". The following figure shows an example for the configuration of "port forwarding". a) Container port: 8180 (API) External access via port b) Container port: 8080 (web interface) External access via port c) Container port: (PostgreSQL) External access via port (d) d) Container port: (ecodms) External access via ecodms connection manager (17001) 3. Click Next to continue.

79 8. NAS Installations 79 Abb. (ähnlich) 8.4: Synology - Step 1 - Container Settings 4. In "Step 2" you do not need to make any changes. a) Click Continue.

80 8. NAS Installations 80 Abb. (ähnlich) 8.5: Synology - Step 2 - Container Settings Select Data Folder A window opens displaying your current settings. 1. Click "Extended Settings" (see purple arrow in figure).

81 8. NAS Installations 81 Abb. (ähnlich) 8.6: Synology - Extended Container Settings 2. Now click "Add Folder" (see red arrow in figure). Abb. (ähnlich) 8.7: Synology - Extended Container Settings - Add Folder

82 8. NAS Installations Now select the location where you want to save your ecodms data (see figure). Abb. (ähnlich) 8.8: Synology - Extended Container Settings - Target Path 4. It is important that a) you have selected /srv/data as mount path for the container (see red arrow on left in figure) and b) the Read only restriction is disabled (see red arrow on right in figure). c) the Administrators group has read and write access to the selected permission. 5. To finish the container, click "OK". Abb. (ähnlich) 8.9: Synology - Extended Container Settings - Volume

83 8. NAS Installations Change Language (English) As an option, you can change the language from german to english. To do so, enter the following environment variable under environment in the extended container settings when creating a container [1]: LANG=eng Abb. (ähnlich) 8.10: Synology - Extended Settings - Change Language Start Container After you have successfully created the container, you can start it in the "Docker" interface in the "Container" area. 1. You can connect to ecodms via the selected port (here: 17001; refer to the section Container Settings ) at the address of the disk station. 2. Upon initial starting, it may take a while until the system can access ecodms.

84 8. NAS Installations 84 Abb. (ähnlich) 8.11: Synology - Start Container Update Container If an ecodms container is already setup, you can update it as follows: To update a container, delete the existing container and the local image of the installation. Then create the new container with the same data folder. To do this, follow steps to in this manual Scaninput Folder To use an additional "volume" for the Scaninput, complete the following steps: 1. Requirement: Update to the latest container version. a) When starting the container, the display should contain the following text (example): i. "###INFO### Image created: :26:26 ###INFO### 2. Create a "new common folder".

85 8. NAS Installations 85 Abb. (ähnlich) 8.12: Synology - Create new common folder 3. Assign a name. Abb. (ähnlich) 8.13: Synology - Assign Folder Name 4. Assign the permissions for the Admin user and any number of other users.

86 8. NAS Installations 86 Abb. (ähnlich) 8.14: Synology - Folder Permissions 5. Mount the folder in the container as "Volume". a) Stop the container. b) The mount path in the container is called /srv/scaninput

87 8. NAS Installations 87 Abb. (ähnlich) 8.15: Synology - Mount Path 6. Start the container. a) The output should resemble the following figure. Abb. (ähnlich) 8.16: Synology - Start Container (Output) 8.2 QNAP: ecodms Server "QNAP" is an acronym for "Quality Network Appliance Provider". The Taiwanese company "QNAP Systems, Inc." manufactures the "QNAP" NAS system. ecodms supports those device types that provide container virtualisation. The "QNAP ContainerStation" integrates the virtualisation technologies LXC (Linux containers) and Docker, thus allowing the operation of several isolated Linux systems on a "QNAP NAS" and the download of a broad range of apps. ecodms provides dedicated Docker images for "QNAP" to install the ecodms Server on the "NAS system". This image serves as a template when creating a respective ecodms container. Docker is an open source software which can be used on Linux-based operating system to isolate applications inside software containers by means of virtualisation. Users who wish to install several ecodms instances on a piece of hardware, for example, can implement this using the ecodms Docker solution.

88 8. NAS Installations 88 The process for installing the available ecodms components on a Synology NAS system is described here License Information Please note the following information regarding existing Licenses Licence for a New Container If you are already using an ecodms licence for the full version and also want to use this licence for the Docker container, you must deactivate the licence first. Otherwise you cannot activate the new container. Please follow the steps for deactivation and activation, as shown in the ecodms manual License for a Container Update If you want to update the Docker container, the existing ecodms licence becomes invalid. Before updating the container, all active licences must therefore be deactivated. Otherwise activation following an update is no longer possible. Please follow the steps for deactivation and activation, as shown in the ecodms manual System Requirements Please read our system requirements before installing. For more information and details, please visit our website at Hardware: QNAP System: Docker support (virtualisation) Processor: X86 RAM: min. 2 GB RAM (required) Install & Open ContainerStation In the AppCentre of your "QNAP system", install the "ContainerStation" app and then open the application. Abb. (ähnlich) 8.17: QNAP - AppCenter - Installation ContainerStation

89 8. NAS Installations Search & Install the ecodms Images 1. In the "ContainerStation" app, search for the "ecodms image" with the name "ecodms/allinone" (see red arrow in the figure). 2. Then install the package by clicking "Install" (see purple arrow in figure). a) If you have already installed a package, delete the local image "ecodms/allinone" before installing the new image. Otherwise "ContainerStation" will install the local image without including any interim updates. Abb. (ähnlich) 8.18: QNAP - ContainerStation - ecodms Image Container Settings Information: If you want to setup the "Scaninput" folder at the same time, you must do this when you create the container. You cannot mount Scaninput afterwards. 1. In the next step assign a name to the container. Here you can enter, for example, ecodms.

90 8. NAS Installations 90 Abb. (ähnlich) 8.19: QNAP - Container Settings 2. Click "Extended Settings". 3. Select the "Network" entry. 4. Now you can make the "Port Settings". The following figure shows an example for the configuration of "port forwarding". a) Container port: 8180 (API) External access via port b) Container port: 8080 (web interface) External access via port c) Container port: (PostgreSQL) External access via port d) Container port: (ecodms) External access via ecodms connection manager (17001) 5. Then click "Freigabe..." in the Container window.

91 8. NAS Installations 91 Abb. (ähnlich) 8.20: QNAP - Extended Container Settings Change Language (English) As an option, you can change the language from german to english. To do so, enter the following environment variable under environment in the extended container settings when creating a container [1]: LANG=eng

92 8. NAS Installations 92 Abb. (ähnlich) 8.21: QNAP - Extended Container Settings - Change Language Select Data Folder 1. Select the location where you want to save your ecodms data (see figure) in the "Freigabe" area. 2. It is important that a) you have selected /srv/data as mount path for the container ( Include point ) (see red arrow) and b) the read / write permissions (s. purple arrow), and c) that the Administrators group has read and write access to the selected Freigabe. 3. To finish the container, click "OK".

93 8. NAS Installations 93 Abb. (ähnlich) 8.22: QNAP - Freigabe Container Settings Start Container After you have successfully created the container, you can start it in the "ContainerStation" interface. 1. You can connect to ecodms via the selected port (here: 17001; refer to the section Container Settings ) at the address of the QNAP. 2. Upon initial starting, it may take a while until the system can access ecodms.

94 8. NAS Installations 94 Abb. (ähnlich) 8.23: QNAP - Start Container Update Container If an ecodms container is already setup, you can update it as follows: To update a container, delete the existing container and the local image of the installation. Then create the new container with the same data folder. To do this, follow steps to in this manual Scaninput Folder To use an additional "volume" for the Scaninput, complete the following steps: 1. Requirement: Update to the latest container version. a) When starting the container, the display should contain the following text (example): i. "###INFO### Image created: :26:26 ###INFO### 2. Create a "Freigabe" folder.

95 8. NAS Installations 95 Abb. (ähnlich) 8.24: QNAP - Create Freigabe Folder 3. Assign a name. Abb. (ähnlich) 8.25: QNAP - Assign Folder Name 4. Assign the permissions for the Admin user and any number of other users.

96 8. NAS Installations 96 Abb. (ähnlich) 8.26: QNAP - Folder Freigabe 5. Mount the folder in the container as "Volume". a) The mount path in the container is called /srv/scaninput Abb. (ähnlich) 8.27: QNAP - Mount Path 6. Start the container. a) The output should resemble the following figure.

97 8. NAS Installations 97 Abb. (ähnlich) 8.28: QNAP - Start Container (Output) Important Information for Chapter 8 [1] You can install server and clients in different languages. The view of the classification attributes and messages depends on the language you have selected for the ecodms server component.