Difference between revisions of "Documentation/How Tos/Automatic Installation on Windows"
(→MSI Properties) |
|||
(24 intermediate revisions by 7 users not shown) | |||
Line 1: | Line 1: | ||
− | + | {{NeedsRework|EN}} | |
+ | {{DocBanner}} | ||
+ | {{Win|Windows related content}} | ||
+ | {{DISPLAYTITLE:Automatic Installation of {{AOo}} on Using the Windows Installer}} | ||
− | {{ | + | {{Warn|This document may no longer be completely valid for OpenOffice.org 3.x Also See: [http://user.services.openoffice.org/en/forum/viewtopic.php?f{{=}}74&t{{=}}28765&start{{=}}0 Create an unattended / silent install of OpenOffice.org 3] on the OpenOffice.org User Forum. Posted: Thu Mar 18, 2010}} |
− | {{ | + | |
− | {{ | + | |
− | {{ | + | |
== Introduction == | == Introduction == | ||
− | {{ | + | {{AOo}} can be easily installed on a central location in a network. This How To shows which parameters and properties of the installation program can be used to cooperate with an existing corporate software distribution process. A re-packaging ("snapshot") is not required. |
− | {{ | + | {{Note|Installation of Updates works correspondingly as long as the major version is the same (updating from 2.2 to 2.3, for example).}} |
== System Requirements == | == System Requirements == | ||
− | + | OpenOffice.org 2.x distributes standard MSI files for installation on Windows platforms using the Windows Installer technology. Supported platforms are Windows 2000, Windows XP or Vista. It is strongly recommended to install the latest Service packs and all available Windows Updates before starting the installation. | |
− | {{ | + | {{Note|Some of the parameters mentioned below require Windows Installer version 3.0 or higher. If required, download this version from the Microsoft web pages.}} |
Additionally, a software distribution program is needed to control the distribution of the software in the corporate environment. This is beyond the scope of this How To since their operation differs considerably from product to product. However, all of them can distribute MSI files in a network. The parameters required to control this will be described in this How To. | Additionally, a software distribution program is needed to control the distribution of the software in the corporate environment. This is beyond the scope of this How To since their operation differs considerably from product to product. However, all of them can distribute MSI files in a network. The parameters required to control this will be described in this How To. | ||
− | {{ | + | {{Note|If you are using a Terminal Server, you can install {{AOo}} using the same parameters as described below. {{AOo}} can be used by multiple users – provided the corresponding user profiles exist.}} |
− | == Downloading and Unpacking {{ | + | == Downloading and Unpacking {{AOo}} == |
− | First step is to '''download the installation files''' for {{ | + | First step is to '''download the installation files''' for {{AOo}}. You can get them for free from [https://www.openoffice.org/download/ https://www.openoffice.org/download/]. Save the downloaded file in a folder of your choice. You will get one single executable file: |
− | + | Apache_OpenOffice_4.1.9_Win_x86_install_en-US.exe | |
The actual file name may differ according to the selected language and software version. | The actual file name may differ according to the selected language and software version. | ||
Line 33: | Line 33: | ||
# Double-click the filename in the Explorer | # Double-click the filename in the Explorer | ||
# Click '''Next >''' | # Click '''Next >''' | ||
− | # Select the folder for unpacking, for instance, [/C:/ | + | # Select the folder for unpacking, for instance, [/C:/OO_Install C:\OO_Install] |
# Click '''Unpack''' | # Click '''Unpack''' | ||
# Click '''Cancel''' to terminate the installation routine at this point. | # Click '''Cancel''' to terminate the installation routine at this point. | ||
− | If you would continue the installation routine, {{ | + | If you would continue the installation routine, {{AOo}} would be installed for one user on this machine. However, the scope of this How To is a ''Silent'' or ''Unattended'' installation of {{AOo}} in a network. After unpacking you are safe to delete the downloaded exe file. |
== Unattended (Automatic) Installation == | == Unattended (Automatic) Installation == | ||
− | After unpacking, you will get a number of files, one of them being <tt> | + | After unpacking, you will get a number of files, one of them being <tt>openofficeorg4112.msi</tt> which is the central installation file. MSI files are installation programs that make use of the Windows Installer technology from Microsoft. There is a central installation utility called <tt>msiexec</tt> that manages the installation and can be controlled using parameters. |
− | For a first test installation you should select a client that has no {{ | + | For a first test installation you should select a client that has no {{AOo}} installed: |
− | {{ | + | {{Note|The user who starts the installation process must have administrator privileges.}} |
# Open a command window ('''Start''' > '''Programs''' > '''Accessories''' > '''Command Prompt''') | # Open a command window ('''Start''' > '''Programs''' > '''Accessories''' > '''Command Prompt''') | ||
− | # Change to the folder with the unpacked installation files, for instance<br><tt>cd C:\ | + | # Change to the folder with the unpacked installation files, for instance<br><tt>cd C:\OO_Install </tt> |
− | # To start an installation that requires no user interaction, issue the following command:<br><tt>start /wait msiexec /qn /norestart /i | + | # To start an installation that requires no user interaction, issue the following command:<br><tt>start /wait msiexec /qn /norestart /i openoffice419.msi</tt> |
− | {{ | + | {{Note|To view all parameters for <tt>msiexec</tt> issue the command: <tt>msiexec /?</tt>}} |
The parameters used above are: | The parameters used above are: | ||
Line 57: | Line 57: | ||
;<tt>start /wait</tt>:Since installation will be performed in the background (no output on the screen) we do not know when the installation is completed and we can move on. By using <tt>start /wait</tt> in front of the <tt>msiexec</tt> command, the command line will pause any other task until the installation routine has finished. Then, the cursor will be visible again. | ;<tt>start /wait</tt>:Since installation will be performed in the background (no output on the screen) we do not know when the installation is completed and we can move on. By using <tt>start /wait</tt> in front of the <tt>msiexec</tt> command, the command line will pause any other task until the installation routine has finished. Then, the cursor will be visible again. | ||
;<tt>msiexec</tt>:This is the Windows Installer utility | ;<tt>msiexec</tt>:This is the Windows Installer utility | ||
− | ;<tt>/qn</tt>:This parameter specifies that no user interface will be displayed during the installation: no progress bar, no dialog boxes, but also no error messages! Variations of this parameter are<br><tt>/qb</tt> for a simple interface displaying only a progress bar in Windows Installer design<br><tt>/qr</tt> for a reduced interface displaying only a progress bar in {{ | + | ;<tt>/qn</tt>:This parameter specifies that no user interface will be displayed during the installation: no progress bar, no dialog boxes, but also no error messages! Variations of this parameter are<br><tt>/qb</tt> for a simple interface displaying only a progress bar in Windows Installer design<br><tt>/qr</tt> for a reduced interface displaying only a progress bar in {{AOo}} design |
;<tt>/norestart</tt>:Some installation programs attempt to reboot the system automatically after installation. This parameter avoids that. However, after installing new software under Windows it is generally recommended to reboot the system at the earliest convenience. | ;<tt>/norestart</tt>:Some installation programs attempt to reboot the system automatically after installation. This parameter avoids that. However, after installing new software under Windows it is generally recommended to reboot the system at the earliest convenience. | ||
;<tt>/i</tt>:This is the parameter that starts the installation | ;<tt>/i</tt>:This is the parameter that starts the installation | ||
− | After calling the command you either see a progress bar or nothing (depending on the <tt>/q</tt> parameter used). After the installation has finished, the cursor will reappear on the command line. Depending on the system this may take several minutes. We have just successfully performed our first unattended installation of {{ | + | After calling the command, you either see a progress bar or nothing (depending on the <tt>/q</tt> parameter used). After the installation has finished, the cursor will reappear on the command line. Depending on the system, this may take several minutes. We have just successfully performed our first unattended installation of {{AOo}}. |
− | If you open the Windows start menu now, you will see an '''OpenOffice | + | If you open the Windows start menu now, you will see an '''OpenOffice 4.0''' entry in the '''Programs''' section, and you are ready to start {{AOo}}. This installation is for all users on that client. A separate user installation step is not required. |
− | To deinstall {{ | + | To deinstall {{AOo}} at a later time, use the following command: |
− | start /wait msiexec /qn /norestart /x | + | start /wait msiexec /qn /norestart /x openoffice4112.msi |
Using <tt>/x</tt> instead of <tt>/i</tt> starts the deinstallation process. After deinstallation you should reboot the system at the earliest convenience. | Using <tt>/x</tt> instead of <tt>/i</tt> starts the deinstallation process. After deinstallation you should reboot the system at the earliest convenience. | ||
Line 73: | Line 73: | ||
== MSI Properties == | == MSI Properties == | ||
− | This section might be invalid for | + | This section might be invalid for OpenOffice.org 3 and later. See the Specification Document |
http://specs.openoffice.org/installation/filetyperegistration/foreign_file_type_registration.odt | http://specs.openoffice.org/installation/filetyperegistration/foreign_file_type_registration.odt | ||
− | The example installation above does not allow to change default settings like the installation path for {{ | + | The example installation above does not allow to change default settings like the installation path for {{AOo}}. To use other than the default settings you can use ''MSI properties'' that are specified when <tt>msiexec</tt> is called on the command line: |
− | start /wait msiexec /qn /norestart /i | + | start /wait msiexec /qn /norestart /i openofficeorg41120.msi PROPERTY1=Value1 PROPERTY2=Value2 |
The following overview lists the available properties. | The following overview lists the available properties. | ||
Line 88: | Line 88: | ||
|-valign=top | |-valign=top | ||
| <tt>SELECT_WORD</tt> | | <tt>SELECT_WORD</tt> | ||
− | | Use {{ | + | | Use {{AOo}} as default application for MS Word files? |
* <tt>0</tt>: No | * <tt>0</tt>: No | ||
* <tt>1</tt>: Yes | * <tt>1</tt>: Yes | ||
Line 94: | Line 94: | ||
|-valign=top | |-valign=top | ||
| <tt>SELECT_EXCEL</tt> | | <tt>SELECT_EXCEL</tt> | ||
− | | Use {{ | + | | Use {{AOo}} as default application for MS Excel files? |
* <tt>0</tt>: No<br> | * <tt>0</tt>: No<br> | ||
* <tt>1</tt>: Yes | * <tt>1</tt>: Yes | ||
Line 100: | Line 100: | ||
|-valign=top | |-valign=top | ||
| <tt>SELECT_POWERPOINT</tt> | | <tt>SELECT_POWERPOINT</tt> | ||
− | | Use {{ | + | | Use {{AOo}} as default application for MS Powerpoint files? |
* <tt>0</tt>: No | * <tt>0</tt>: No | ||
* <tt>1</tt>: Yes | * <tt>1</tt>: Yes | ||
Line 106: | Line 106: | ||
|-valign=top | |-valign=top | ||
| <tt>INSTALLLOCATION</tt> | | <tt>INSTALLLOCATION</tt> | ||
− | | Installation path for {{ | + | | Installation path for {{AOo}}, enclosed in double quotes ("). If the path does not exist it will be created. |
|-valign=top | |-valign=top | ||
| <tt>COMPANYNAME</tt> | | <tt>COMPANYNAME</tt> | ||
− | | Name of the company that {{ | + | | Name of the company that {{AOo}} should be registered to, enclosed in double quotes ("). Can stay empty. |
|-valign=top | |-valign=top | ||
| <tt>USERNAME</tt> | | <tt>USERNAME</tt> | ||
− | | Name of the user that {{ | + | | Name of the user that {{AOo}} should be registered to, enclosed in double quotes ("). Can stay empty. |
|-valign=top | |-valign=top | ||
Line 121: | Line 121: | ||
| This pair of properties controls which software components are to be installed. | | This pair of properties controls which software components are to be installed. | ||
− | <tt>ALL</tt>: Installs all {{ | + | <tt>ALL</tt>: Installs all {{AOo}} components (<tt>ADDLOCAL=ALL</tt>) |
If <tt>ALL</tt> is not used, the core components have to be specified manually, as | If <tt>ALL</tt> is not used, the core components have to be specified manually, as | ||
Line 148: | Line 148: | ||
;Windows Explorer Shell Extension:<tt>gm_Optional, gm_o_Winexplorerext</tt> | ;Windows Explorer Shell Extension:<tt>gm_Optional, gm_o_Winexplorerext</tt> | ||
− | {{ | + | {{Note|The values must not be enclosed in quotes. If multiple components are listed they are separated by a comma ('''no spaces allowed'''). Note that the examples above contain spaces for screen layout reasons!}} |
If multiple modules are installed that require a common component, the component only needs to be specified once, for example: | If multiple modules are installed that require a common component, the component only needs to be specified once, for example: | ||
− | To install the | + | To install the Quickstarter and ActiveX Control Element, the components would be: |
gm_Optional,gm_o_Quickstart,gm_o_Activexcontrol | gm_Optional,gm_o_Quickstart,gm_o_Activexcontrol | ||
Line 164: | Line 164: | ||
|} | |} | ||
− | {{ | + | {{Note|These parameters only need to be used on installation. Deinstallation works without these parameters.}} |
== Examples == | == Examples == | ||
Line 170: | Line 170: | ||
=== Example 1 === | === Example 1 === | ||
− | To install {{ | + | To install {{AOo}} with the following options |
− | * use { | + | * use {{AOo}} as the default application for DOC, XLS and PPT files (recommended if you want to open MS Office files with {{AOo}} seamlessly) |
− | * use <tt>C:\ | + | * use <tt>C:\OpenOffice</tt> as the target installation folder |
* install all components except for the Database module (''Base'') | * install all components except for the Database module (''Base'') | ||
you have to issue the following command: | you have to issue the following command: | ||
− | <tt>start /wait msiexec /qn /norestart /i | + | <tt>start /wait msiexec /qn /norestart /i openoffice419.msi SELECT_WORD=1 SELECT_EXCEL=1 SELECT_POWERPOINT=1 INSTALLLOCATION="C:\Open Office" ADDLOCAL=ALL REMOVE=gm_p_Base,gm_p_Base_Bin,gm_p_Base_Help</tt> |
=== Example 2 === | === Example 2 === | ||
− | To install {{ | + | To install {{AOo}} with the following options |
− | * do ''not'' use { | + | * do ''not'' use {{AOo}} as the default application for DOC, XLS and PPT files (for example, if you have MS Office already installed on your system) |
− | * use <tt>C:\ | + | * use <tt>C:\OO</tt> as the target installation folder |
* only install the Writer component | * only install the Writer component | ||
you have to issue the following command: | you have to issue the following command: | ||
− | <tt>start /wait msiexec /qn /norestart /i | + | <tt>start /wait msiexec /qn /norestart /i openoffice419.msi SELECT_WORD=0 SELECT_EXCEL=0 SELECT_POWERPOINT=0 INSTALLLOCATION="C:\OO" ADDLOCAL=gm_Root, gm_Prg, gm_r_Files_2, gm_r_Files_3, gm_r_Files_4, gm_r_Files_5, gm_r_Files_6, gm_r_Files_7, gm_r_Files_8, gm_r_Files_9, gm_r_Fonts_OOo_Hidden, gm_p_Wrt, gm_p_Wrt_Bin, gm_p_Wrt_Help</tt> |
− | {{ | + | {{Warn|Note that the example above contains spaces '''ONLY''' for screen layout reasons! <BR><BR> |
+ | The component list behind <tt><big>ADDLOCAL</big></tt> '''MUST''' be separated by commas only!}} | ||
{{PDL1}} | {{PDL1}} | ||
− | [[Category: Documentation/ | + | [[Category:Documentation/How Tos/Installation]] |
[[Category:Documentation/Setup]] | [[Category:Documentation/Setup]] |
Latest revision as of 14:14, 20 July 2022
This document may no longer be completely valid for OpenOffice.org 3.x Also See: Create an unattended / silent install of OpenOffice.org 3 on the OpenOffice.org User Forum. Posted: Thu Mar 18, 2010 |
Contents
Introduction
Apache OpenOffice can be easily installed on a central location in a network. This How To shows which parameters and properties of the installation program can be used to cooperate with an existing corporate software distribution process. A re-packaging ("snapshot") is not required.
Installation of Updates works correspondingly as long as the major version is the same (updating from 2.2 to 2.3, for example). |
System Requirements
OpenOffice.org 2.x distributes standard MSI files for installation on Windows platforms using the Windows Installer technology. Supported platforms are Windows 2000, Windows XP or Vista. It is strongly recommended to install the latest Service packs and all available Windows Updates before starting the installation.
Some of the parameters mentioned below require Windows Installer version 3.0 or higher. If required, download this version from the Microsoft web pages. |
Additionally, a software distribution program is needed to control the distribution of the software in the corporate environment. This is beyond the scope of this How To since their operation differs considerably from product to product. However, all of them can distribute MSI files in a network. The parameters required to control this will be described in this How To.
Downloading and Unpacking Apache OpenOffice
First step is to download the installation files for Apache OpenOffice. You can get them for free from https://www.openoffice.org/download/. Save the downloaded file in a folder of your choice. You will get one single executable file:
Apache_OpenOffice_4.1.9_Win_x86_install_en-US.exe
The actual file name may differ according to the selected language and software version.
This file contains the installation package in compressed format. It has to be unpacked first:
- Double-click the filename in the Explorer
- Click Next >
- Select the folder for unpacking, for instance, [/C:/OO_Install C:\OO_Install]
- Click Unpack
- Click Cancel to terminate the installation routine at this point.
If you would continue the installation routine, Apache OpenOffice would be installed for one user on this machine. However, the scope of this How To is a Silent or Unattended installation of Apache OpenOffice in a network. After unpacking you are safe to delete the downloaded exe file.
Unattended (Automatic) Installation
After unpacking, you will get a number of files, one of them being openofficeorg4112.msi which is the central installation file. MSI files are installation programs that make use of the Windows Installer technology from Microsoft. There is a central installation utility called msiexec that manages the installation and can be controlled using parameters.
For a first test installation you should select a client that has no Apache OpenOffice installed:
- Open a command window (Start > Programs > Accessories > Command Prompt)
- Change to the folder with the unpacked installation files, for instance
cd C:\OO_Install - To start an installation that requires no user interaction, issue the following command:
start /wait msiexec /qn /norestart /i openoffice419.msi
The parameters used above are:
- start /wait
- Since installation will be performed in the background (no output on the screen) we do not know when the installation is completed and we can move on. By using start /wait in front of the msiexec command, the command line will pause any other task until the installation routine has finished. Then, the cursor will be visible again.
- msiexec
- This is the Windows Installer utility
- /qn
- This parameter specifies that no user interface will be displayed during the installation: no progress bar, no dialog boxes, but also no error messages! Variations of this parameter are
/qb for a simple interface displaying only a progress bar in Windows Installer design
/qr for a reduced interface displaying only a progress bar in Apache OpenOffice design - /norestart
- Some installation programs attempt to reboot the system automatically after installation. This parameter avoids that. However, after installing new software under Windows it is generally recommended to reboot the system at the earliest convenience.
- /i
- This is the parameter that starts the installation
After calling the command, you either see a progress bar or nothing (depending on the /q parameter used). After the installation has finished, the cursor will reappear on the command line. Depending on the system, this may take several minutes. We have just successfully performed our first unattended installation of Apache OpenOffice.
If you open the Windows start menu now, you will see an OpenOffice 4.0 entry in the Programs section, and you are ready to start Apache OpenOffice. This installation is for all users on that client. A separate user installation step is not required.
To deinstall Apache OpenOffice at a later time, use the following command:
start /wait msiexec /qn /norestart /x openoffice4112.msi
Using /x instead of /i starts the deinstallation process. After deinstallation you should reboot the system at the earliest convenience.
MSI Properties
This section might be invalid for OpenOffice.org 3 and later. See the Specification Document http://specs.openoffice.org/installation/filetyperegistration/foreign_file_type_registration.odt
The example installation above does not allow to change default settings like the installation path for Apache OpenOffice. To use other than the default settings you can use MSI properties that are specified when msiexec is called on the command line:
start /wait msiexec /qn /norestart /i openofficeorg41120.msi PROPERTY1=Value1 PROPERTY2=Value2
The following overview lists the available properties.
These parameters only need to be used on installation. Deinstallation works without these parameters. |
Examples
Example 1
To install Apache OpenOffice with the following options
- use Apache OpenOffice as the default application for DOC, XLS and PPT files (recommended if you want to open MS Office files with Apache OpenOffice seamlessly)
- use C:\OpenOffice as the target installation folder
- install all components except for the Database module (Base)
you have to issue the following command:
start /wait msiexec /qn /norestart /i openoffice419.msi SELECT_WORD=1 SELECT_EXCEL=1 SELECT_POWERPOINT=1 INSTALLLOCATION="C:\Open Office" ADDLOCAL=ALL REMOVE=gm_p_Base,gm_p_Base_Bin,gm_p_Base_Help
Example 2
To install Apache OpenOffice with the following options
- do not use Apache OpenOffice as the default application for DOC, XLS and PPT files (for example, if you have MS Office already installed on your system)
- use C:\OO as the target installation folder
- only install the Writer component
you have to issue the following command:
start /wait msiexec /qn /norestart /i openoffice419.msi SELECT_WORD=0 SELECT_EXCEL=0 SELECT_POWERPOINT=0 INSTALLLOCATION="C:\OO" ADDLOCAL=gm_Root, gm_Prg, gm_r_Files_2, gm_r_Files_3, gm_r_Files_4, gm_r_Files_5, gm_r_Files_6, gm_r_Files_7, gm_r_Files_8, gm_r_Files_9, gm_r_Fonts_OOo_Hidden, gm_p_Wrt, gm_p_Wrt_Bin, gm_p_Wrt_Help
Note that the example above contains spaces ONLY for screen layout reasons! The component list behind ADDLOCAL MUST be separated by commas only! |
Content on this page is licensed under the Public Documentation License (PDL). |