Difference between revisions of "Install on Windows"

From FreeCAD Documentation
Jump to navigation Jump to search
m (13 revisions)
(Marked this version for translation)
(32 intermediate revisions by 16 users not shown)
Line 1: Line 1:
The easiest way to '''install FreeCAD on Windows''' is by using the installer. This page describes the usage and the features of the ''Microsoft Installer'' for more installation options.
+
<languages/>
 +
<translate>
  
=== Simple Installation ===
+
<!--T:38-->
FreeCAD installer is delivered in .msi (Windows Installer) format.
+
{{docnav
 +
|[[Feature list|Feature list]]
 +
|[[Install on Linux/Unix|Install on Linux/Unix]]
 +
}}
  
You can download the latest .msi file from the [http://sourceforge.net/project/showfiles.php?group_id=49159&package_id=206659 official FreeCAD Download page]. After downloading the file, just double-click on it to start the installation process.
+
<!--T:1-->
 +
You can install FreeCAD on Windows by downloading one of the installers below:
  
=== Command Line Installation ===
+
<!--T:37-->
With the ''msiexec.exe'' command line utility, additional features are available, like non-interactive installation and administrative installation.
+
{{DownloadWindowsStable}}
  
==== Non-interactive Installation ====
+
<!--T:2-->
 +
After downloading the .exe (NSIS Installer) file, double-click on it to start the installation process.
 +
 
 +
<!--T:3-->
 +
Below is more information about some technical options. Nevertheless, most users don't need more than the above .exe files. Head to [[Getting started|Get started]] after installation is complete.
 +
 
 +
== Simple NSIS Installer Installation == <!--T:4-->
 +
 
 +
<!--T:43-->
 +
The easiest way to '''install FreeCAD on Windows''' is by using the downloadable installer bundle above. This page describes the usage and features of the ''NSIS Installer'' for more installation options.
 +
 
 +
<!--T:5-->
 +
If you would like to download a development version (which may be unstable), see the [[Download|Download]] page.
 +
 
 +
== Chocolatey == <!--T:40-->
 +
 
 +
<!--T:44-->
 +
However, it is highly recommended that you use a package manager such as Chocolatey to keep your software updated. You can installed Chocolatey following [https://chocolatey.org/install these instructions] and then open a PowerShell terminal as admin and run:
 +
 
 +
</translate>
 +
{{Code|code=
 +
choco install freecad
 +
}}
 +
<translate>
 +
 
 +
<!--T:41-->
 +
every once in a while you can update your software with
 +
 
 +
</translate>
 +
{{Code|code=
 +
choco upgrade freecad
 +
}}
 +
<translate>
 +
 
 +
<!--T:42-->
 +
to get the latest version available on Chocolatey repository. If there are any issues with the chocolatey package, you may contact maintainers on [https://chocolatey.org/packages/freecad this page].
 +
 
 +
== Command line installation == <!--T:6-->
 +
 
 +
<!--T:45-->
 +
With the ''msiexec.exe'' command line utility, additional features such as non-interactive installation and administrative installation are available.  See examples below.
 +
 
 +
=== Non-interactive installation === <!--T:7-->
 +
 
 +
<!--T:46-->
 
With the command line
 
With the command line
  
  msiexec /i FreeCAD<version>.msi
+
</translate>
 +
{{Code|code=
 +
msiexec /i FreeCAD<version>.msi
 +
}}
 +
<translate>
  
installation can be initiated programmatically. Additional parameters can be passed at the end of this command line, like
+
<!--T:8-->
 +
installation can be initiated programmatically. Additional parameters can be passed at the end of the command line, for example
  
  msiexec /i FreeCAD-2.5.msi TARGETDIR=r:\FreeCAD25
+
</translate>
 +
{{Code|code=
 +
msiexec /i FreeCAD-2.5.msi TARGETDIR=R:\FreeCAD25
 +
}}
 +
<translate>
  
==== Limited user interface ====
+
=== Limited user interface === <!--T:9-->
The amount of user interface that installer displays can be controlled with /q options, in particular:
 
  
 +
<!--T:47-->
 +
The amount of user control permitted by the installer can be controlled with /q options:
 +
 +
<!--T:10-->
 
* /qn - No interface
 
* /qn - No interface
* /qb - Basic interface - just a small progress dialog
+
* /qb - Basic interface - display only a progress dialog with Cancel button
 
* /qb! - Like /qb, but hide the Cancel button
 
* /qb! - Like /qb, but hide the Cancel button
* /qr - Reduced interface - display all dialogs that don't require user interaction (skip all modal dialogs)
+
* /qr - Reduced interface - display all dialogs that do not require user interaction (skip all modal dialogs)
 
* /qn+ - Like /qn, but display "Completed" dialog at the end
 
* /qn+ - Like /qn, but display "Completed" dialog at the end
 
* /qb+ - Like /qb, but display "Completed" dialog at the end  
 
* /qb+ - Like /qb, but display "Completed" dialog at the end  
  
==== Target directory ====
+
=== Target directory === <!--T:11-->
 +
 
 +
<!--T:48-->
 
The property TARGETDIR determines the root directory of the FreeCAD installation. For example, a different installation drive can be specified with
 
The property TARGETDIR determines the root directory of the FreeCAD installation. For example, a different installation drive can be specified with
  
TARGETDIR=R:\FreeCAD25
+
</translate>
 +
{{Code|code=
 +
TARGETDIR=R:\FreeCAD25
 +
}}
 +
<translate>
  
 +
<!--T:12-->
 
The default TARGETDIR is [WindowsVolume\Programm Files\]FreeCAD<version>.
 
The default TARGETDIR is [WindowsVolume\Programm Files\]FreeCAD<version>.
  
==== Installation for All Users ====
+
=== Installation for All Users === <!--T:13-->
 +
 
 +
<!--T:49-->
 
Adding
 
Adding
  
  ALLUSERS=1
+
</translate>
 +
{{Code|code=
 +
ALLUSERS=1
 +
}}
 +
<translate>
  
causes an installation for all users. By default, the non-interactive installation install the package just for the current user, and the interactive installation offers a dialog which defaults to "all users" if the user is sufficiently privileged.
+
<!--T:14-->
 +
causes an installation usable by all users. By default, a non-interactive (/i) installation makes the package usable by the current user (the one performing the installation) only; an interactive installation presents a dialog which defaults to "all users" if the user performing the installation is sufficiently privileged.
  
==== Feature Selection ====
+
=== Feature Selection === <!--T:15-->
 +
 
 +
<!--T:50-->
 
A number of properties allow selection of features to be installed, reinstalled, or removed. The set of features for the FreeCAD installer is
 
A number of properties allow selection of features to be installed, reinstalled, or removed. The set of features for the FreeCAD installer is
  
 +
<!--T:16-->
 
* DefaultFeature - install the software proper, plus the core libraries
 
* DefaultFeature - install the software proper, plus the core libraries
* Documentation - install documentation
+
* Documentation - install the documentation
 
* Source code - install the sources  
 
* Source code - install the sources  
 
* ... ToDo
 
* ... ToDo
  
 +
<!--T:17-->
 
In addition, ALL specifies all features. All features depend on DefaultFeature, so installing any feature automatically installs the default feature as well. The following properties control features to be installed or removed
 
In addition, ALL specifies all features. All features depend on DefaultFeature, so installing any feature automatically installs the default feature as well. The following properties control features to be installed or removed
  
* ADDLOCAL - list of feature to be installed on the local machine
+
<!--T:18-->
* REMOVE - list of features to be removed
+
* ADDLOCAL - list of features to be installed on the local machine
 +
* REMOVE - list of features to be removed from the local machine
 
* ADDDEFAULT - list of features added in their default configuration (which is local for all FreeCAD features)
 
* ADDDEFAULT - list of features added in their default configuration (which is local for all FreeCAD features)
 
* REINSTALL - list of features to be reinstalled/repaired
 
* REINSTALL - list of features to be reinstalled/repaired
* ADVERTISE - list of feature for which to perform an advertise installation  
+
* ADVERTISE - list of features for which to perform an advertise installation  
  
 +
<!--T:19-->
 
There are a few additional properties available; see the MSDN documentation for details.
 
There are a few additional properties available; see the MSDN documentation for details.
  
 +
<!--T:20-->
 
With these options, adding
 
With these options, adding
  
  ADDLOCAL=Extensions
+
</translate>
 +
{{Code|code=
 +
ADDLOCAL=Extensions
 +
}}
 +
<translate>
  
 +
<!--T:21-->
 
installs the interpreter itself and registers the extensions, but does not install anything else.
 
installs the interpreter itself and registers the extensions, but does not install anything else.
  
=== Uninstallation ===
+
== Uninstallation == <!--T:22-->
 +
 
 +
<!--T:51-->
 
With
 
With
  
  msiexec /x FreeCAD<version>.msi
+
</translate>
 +
{{Code|code=
 +
msiexec /x FreeCAD<version>.msi
 +
}}
 +
<translate>
  
 +
<!--T:23-->
 
FreeCAD can be uninstalled. It is not necessary to have the MSI file available for uninstallation; alternatively, the package or product code can also be specified. You can find the product code by looking at the properties of the Uninstall shortcut that FreeCAD installs in the start menu.
 
FreeCAD can be uninstalled. It is not necessary to have the MSI file available for uninstallation; alternatively, the package or product code can also be specified. You can find the product code by looking at the properties of the Uninstall shortcut that FreeCAD installs in the start menu.
  
=== Administrative installation ===
+
== Administrative installation == <!--T:24-->
 +
 
 +
<!--T:52-->
 
With
 
With
  
  msiexec /a FreeCAD<version>.msi
+
</translate>
 +
{{Code|code=
 +
msiexec /a FreeCAD<version>.msi
 +
}}
 +
<translate>
  
 +
<!--T:25-->
 
an "administrative" (network) installation can be initiated. The files get unpacked into the target directory (which should be a network directory), but no other modification is made to the local system. In addition, another (smaller) msi file is generated in the target directory, which clients can then use to perform a local installation (future versions may also offer to keep some features on the network drive altogether).
 
an "administrative" (network) installation can be initiated. The files get unpacked into the target directory (which should be a network directory), but no other modification is made to the local system. In addition, another (smaller) msi file is generated in the target directory, which clients can then use to perform a local installation (future versions may also offer to keep some features on the network drive altogether).
  
 +
<!--T:26-->
 
Currently, there is no user interface for administrative installations, so the target directory must be passed on the command line.
 
Currently, there is no user interface for administrative installations, so the target directory must be passed on the command line.
  
There is no specific uninstall procedure for an administrative install - just delete the target directory if no client uses it anymore.
+
<!--T:27-->
 +
There is no specific uninstall procedure for an administrative install - simply delete the target directory if no client uses it anymore.
  
=== Advertisement ===
+
== Advertisement == <!--T:28-->
 +
 
 +
<!--T:53-->
 
With
 
With
  
  msiexec /jm FreeCAD<version>.msi
+
</translate>
 +
{{Code|code=
 +
msiexec /jm FreeCAD<version>.msi
 +
}}
 +
<translate>
 +
 
 +
<!--T:29-->
 +
it would be possible, in principle, to "advertise" FreeCAD to a machine (with /ju to a user). This would cause the icons to appear in the start menu and the extensions to become registered, without the software actually being installed. The first usage of a feature would cause that feature to be installed.
  
it would be possible, in principle, to "advertise" FreeCAD to a machine (with /ju to a user). This would cause the icons to appear in the start menu, and the extensions to become registered, without the software actually being installed. The first usage of a feature would cause that feature to be installed.
+
<!--T:30-->
 +
The FreeCAD installer currently only supports advertisement of start menu entries, but no advertisement of shortcuts.
  
The FreeCAD installer currently supports just advertisement of start menu entries, but no advertisement of shortcuts.
+
== Automatic installation on a group of machines == <!--T:31-->
  
=== Automatic Installation on a Group of Machines ===
+
<!--T:54-->
With Windows Group Policy, it is possible to automatically install FreeCAD an a group of machines. To do so, perform the following steps:
+
With Windows Group Policy, it is possible to automatically install FreeCAD on a group of machines. To do so, perform the following steps:
 
#Log on to the domain controller
 
#Log on to the domain controller
 
#Copy the MSI file into a folder that is shared with access granted to all target machines.
 
#Copy the MSI file into a folder that is shared with access granted to all target machines.
Line 104: Line 217:
 
#In Computer Configuration/Software Installation, choose New/Package
 
#In Computer Configuration/Software Installation, choose New/Package
 
#Select the MSI file through the network path
 
#Select the MSI file through the network path
#Optionally, select that you want the FreeCAD to be deinstalled if the computer leaves the scope of the policy.  
+
#Optionally, select that you want FreeCAD to be de-installed if the computer leaves the scope of the policy.  
  
 +
<!--T:32-->
 
Group policy propagation typically takes some time - to reliably deploy the package, all machines should be rebooted.
 
Group policy propagation typically takes some time - to reliably deploy the package, all machines should be rebooted.
  
=== Installation on Linux using Crossover Office ===
+
== Installation on Linux using Crossover Office == <!--T:33-->
 +
 
 +
<!--T:34-->
 +
You can install the windows version of FreeCAD on a Linux system using ''CXOffice 5.0.1''.  Run ''msiexec'' from the CXOffice command line.  Assuming the install package is in the "software" directory on drive "Y:":
 +
 
 +
</translate>
 +
{{Code|code=
 +
msiexec /i Y:\\software\\FreeCAD<version>.msi
 +
}}
 +
<translate>
 +
 
 +
<!--T:39-->
 +
FreeCAD is running, but it has been reported that the OpenGL display does not work, like with other programs running under [[wikipedia:Wine (software)|Wine]] i.e. Google [[wikipedia:SketchUp|SketchUp]].
  
You can install the windows version of FreeCAD on a Linux system using ''CXOffice 5.0.1''.  Run ''msiexec'' from the CXOffice command line, assuming that the install package is placed in the "software" directory which is mapped to the drive letter "Y:":
+
<!--T:35-->
msiexec /i Y:\\software\\FreeCAD<version>.msi
+
{{docnav
FreeCAD is running, but it has been reported that the OpenGL display does not work, like with other programms running under [[wikipedia:Wine (software)|Wine]] i.e. Google [[wikipedia:SketchUp|SketchUp]].
+
|[[Feature list|Feature list]]
 +
|[[Install on Linux/Unix|Install on Linux/Unix]]
 +
}}
  
{{userdocnavi}}
+
</translate>
 +
{{Userdocnavi{{#translation:}}}}

Revision as of 20:41, 13 March 2020

Other languages:
Bahasa Indonesia • ‎Deutsch • ‎English • ‎Türkçe • ‎español • ‎français • ‎hrvatski • ‎italiano • ‎polski • ‎português • ‎português do Brasil • ‎română • ‎svenska • ‎čeština • ‎български • ‎русский • ‎українська • ‎中文 • ‎中文(中国大陆)‎ • ‎日本語

You can install FreeCAD on Windows by downloading one of the installers below:

Windows.png Windows 32 bit (sha256)

Windows.png Windows 64 bit (sha256)


After downloading the .exe (NSIS Installer) file, double-click on it to start the installation process.

Below is more information about some technical options. Nevertheless, most users don't need more than the above .exe files. Head to Get started after installation is complete.

Simple NSIS Installer Installation

The easiest way to install FreeCAD on Windows is by using the downloadable installer bundle above. This page describes the usage and features of the NSIS Installer for more installation options.

If you would like to download a development version (which may be unstable), see the Download page.

Chocolatey

However, it is highly recommended that you use a package manager such as Chocolatey to keep your software updated. You can installed Chocolatey following these instructions and then open a PowerShell terminal as admin and run:

choco install freecad

every once in a while you can update your software with

choco upgrade freecad

to get the latest version available on Chocolatey repository. If there are any issues with the chocolatey package, you may contact maintainers on this page.

Command line installation

With the msiexec.exe command line utility, additional features such as non-interactive installation and administrative installation are available. See examples below.

Non-interactive installation

With the command line

msiexec /i FreeCAD<version>.msi

installation can be initiated programmatically. Additional parameters can be passed at the end of the command line, for example

msiexec /i FreeCAD-2.5.msi TARGETDIR=R:\FreeCAD25

Limited user interface

The amount of user control permitted by the installer can be controlled with /q options:

  • /qn - No interface
  • /qb - Basic interface - display only a progress dialog with Cancel button
  • /qb! - Like /qb, but hide the Cancel button
  • /qr - Reduced interface - display all dialogs that do not require user interaction (skip all modal dialogs)
  • /qn+ - Like /qn, but display "Completed" dialog at the end
  • /qb+ - Like /qb, but display "Completed" dialog at the end

Target directory

The property TARGETDIR determines the root directory of the FreeCAD installation. For example, a different installation drive can be specified with

TARGETDIR=R:\FreeCAD25

The default TARGETDIR is [WindowsVolume\Programm Files\]FreeCAD<version>.

Installation for All Users

Adding

ALLUSERS=1

causes an installation usable by all users. By default, a non-interactive (/i) installation makes the package usable by the current user (the one performing the installation) only; an interactive installation presents a dialog which defaults to "all users" if the user performing the installation is sufficiently privileged.

Feature Selection

A number of properties allow selection of features to be installed, reinstalled, or removed. The set of features for the FreeCAD installer is

  • DefaultFeature - install the software proper, plus the core libraries
  • Documentation - install the documentation
  • Source code - install the sources
  • ... ToDo

In addition, ALL specifies all features. All features depend on DefaultFeature, so installing any feature automatically installs the default feature as well. The following properties control features to be installed or removed

  • ADDLOCAL - list of features to be installed on the local machine
  • REMOVE - list of features to be removed from the local machine
  • ADDDEFAULT - list of features added in their default configuration (which is local for all FreeCAD features)
  • REINSTALL - list of features to be reinstalled/repaired
  • ADVERTISE - list of features for which to perform an advertise installation

There are a few additional properties available; see the MSDN documentation for details.

With these options, adding

ADDLOCAL=Extensions

installs the interpreter itself and registers the extensions, but does not install anything else.

Uninstallation

With

msiexec /x FreeCAD<version>.msi

FreeCAD can be uninstalled. It is not necessary to have the MSI file available for uninstallation; alternatively, the package or product code can also be specified. You can find the product code by looking at the properties of the Uninstall shortcut that FreeCAD installs in the start menu.

Administrative installation

With

msiexec /a FreeCAD<version>.msi

an "administrative" (network) installation can be initiated. The files get unpacked into the target directory (which should be a network directory), but no other modification is made to the local system. In addition, another (smaller) msi file is generated in the target directory, which clients can then use to perform a local installation (future versions may also offer to keep some features on the network drive altogether).

Currently, there is no user interface for administrative installations, so the target directory must be passed on the command line.

There is no specific uninstall procedure for an administrative install - simply delete the target directory if no client uses it anymore.

With

msiexec /jm FreeCAD<version>.msi

it would be possible, in principle, to "advertise" FreeCAD to a machine (with /ju to a user). This would cause the icons to appear in the start menu and the extensions to become registered, without the software actually being installed. The first usage of a feature would cause that feature to be installed.

The FreeCAD installer currently only supports advertisement of start menu entries, but no advertisement of shortcuts.

Automatic installation on a group of machines

With Windows Group Policy, it is possible to automatically install FreeCAD on a group of machines. To do so, perform the following steps:

  1. Log on to the domain controller
  2. Copy the MSI file into a folder that is shared with access granted to all target machines.
  3. Open the MMC snapin "Active Directory users and computers"
  4. Navigate to the group of computers that need FreeCAD
  5. Open Properties
  6. Open Group Policies
  7. Add a new policy, and edit it
  8. In Computer Configuration/Software Installation, choose New/Package
  9. Select the MSI file through the network path
  10. Optionally, select that you want FreeCAD to be de-installed if the computer leaves the scope of the policy.

Group policy propagation typically takes some time - to reliably deploy the package, all machines should be rebooted.

Installation on Linux using Crossover Office

You can install the windows version of FreeCAD on a Linux system using CXOffice 5.0.1. Run msiexec from the CXOffice command line. Assuming the install package is in the "software" directory on drive "Y:":

msiexec /i Y:\\software\\FreeCAD<version>.msi

FreeCAD is running, but it has been reported that the OpenGL display does not work, like with other programs running under Wine i.e. Google SketchUp.