Octopus Installation


Table of contents

Related Article

Standard installation

Installation requirements

The only requirement when installing Octopus is to have a compatible Framework .Net v4.7.2 software installed. Most of the Microsoft operating systems are delivered with the right Framework software version installed.
See the Octopus system requirements article for more information.

Before you start, you will need to know your Octopus environment installation URL.

You can obtain it from a computer on which Octopus is already installed, by clicking on "Tools / Display installation kit address...", and by copying the URL in your Internet browser address bar. The installation page will automatically invite you to download the setup.exe file. When the setup.exe is launched, an automated setup will start since the application does not need any parameters.

** It is important not to save the setup.exe file. It can evolve from version to version. It is better to always download it when it is needed.

Upgrading to newer versions

Normally, when an update is available, the application will automatically update itself on its next startup.

Installation folder

Default folder

Octopus will be installed in the local data folder (LocalAppData) of the Windows user, based the Operating System:

  • Windows 2012, Windows 8, Windows 2008, Windows 7, Windows 2003, Windows Vista
    The shortcut %LocalAppData%\Octopus will point to the right folder
    Example: C:\users\dloranger\AppData\Local\Octopus
  • Windows XP
    The shortcut %HomePath%\Local Settings\Application Data\Octopus will point to the right folder
    Example: C:\documents and settings\dloranger\Application Data\Octopus

Cache folder (located in the Octopus attached files folder)

Once the attached files folder configured, Octopus will use it to store a copy of the application folder in its cache. This will allow to reduce the used bandwidth and speed up the installation of updates when you have several Octopus installations. If you have multiple teams using different folders for attached files, you will have the source il muliple places.

Installation considerations

Installation journals

In case of a problem during the installation, the system will place an Octopus.log file containing details on encountered errors in the installation folder.

 Folder security

Users who want to start Octopus must have complete control over the Octopus installation folder and all child objects required for cache recording and future software updates. The previously mentioned installation folder already provides necessary rights.

Octopus cache usage

Since Octopus downloads certain cached files related to the user, it is recommended that each user gets his own folder instead of using a shared one for multiple users.

Please note: Even if used by different users, running several Octopus instances from the same folder might generate locked file issues and error messages. This situation is to be avoided as much as possible.

Advanced installation

Portable installation

The Octopus folder (and its sub folders) contain all that is required for Octopus to work properly.  To use Octopus in a portable way, you only need to copy and paste the installation folder to a USB key and launch the executable file from there.
To manually launch the application, use ESI.Octopus.WinUI.exe.
We strongly advise to close Octopus before ejecting the external storage in Windows.

Multiple instances installation method

It is possible to simultaneously have several Octopus environment installed, which can be very practical in these situations:

  • Simultaneously access a production and a test environment in the same Windows session
  • Access two Octopus environment from two different customers (your environment and one of a customer also using Octopus)
  • Access two dfferent Octopus teams, for example for IT technicians who support multiple Octopus teams

To install additional environments

  • Rename or move the original Octopus folder 
  • Update the shortcut link on the desktop (destination folder and file location)
  • Install Octopus from the package of the second environment
  • Repeat the procedure as many times as there are environments to be installed

Automated or silent installation

To execute an automated or silent installation, you can launch the installation (setup.exe) combined with additional parameters to modify its normal behavior

Setup.exe supports the two following parameters :

/silentModeInstaller Silent installation mode  (without displaying a visual progression or confirmation)
/InstallFolderName:"<folder>" Installation to a custom location
  • You must indicate the installation folder between double quotes
  • The specified folder must not exist for the installation to be successful

You can combine both parameters to obtain a custom and silent installation.

Specific installation cases

Using Octopus from a network location

Octopus requires to be launched from a local disk. To use it from a network drive, you must convert its location to a virtual drive by using the subst command or similar Windows functions.
Note: For more information about the subst command, please refer to Microsoft technical website at technet.microsoft.com

Packaging and distributing tools

If you would like to use a packaging or distributing tool (for example, Microsoft SCCM), you will have to use the portable mode as a source, described earlier in this document. Octopus being a cloud based solution with automated updates, this installation method does not work well with repackaging.

NOTE: Make sure that you regularly update your packaging source folder to avoid breaking the update sequence.

Launch from a terminal or roaming session

If you would like to use the Octopus application in a terminal session (for example, by using Citrix or Terminal Services products), you will probably have to combine several installation or usage types based on your IT infrastructure. Make sure to discuss this with an IT expert first.

NOTE: some Citrix versions send incorrect time zone information to Octopus.  Even if Octopus has been modified to help counter these issues, we strongly recommend that you verify that your Citrix version is compatible with Octopus before starting the migration.

Using Octopus from a shared folder for different users

If you want to use Octopus on a computer with several users accessing it at different times, you will notice that the authentication box will always display the username last logged in. To avoid this situation, modify the shortcut used to specify the following login parameter this way:

ESI.Octopus.WinUI.exe /login:%username%

This will have the effect of overwriting the Windows username in the Octopus authentication box.


Help us improve our articles

Help us improve our articles