Porter Documentation
Getting Started
Install Porter

Install Porter

Join our mailing list for announcements of releases and announcements of new features. Connect with other Porter users and contributors on Slack.

Install or Upgrade

The examples below use a hard-coded version of Porter. There may be a newer version available which you can check for on our release page. Set VERSION to the most recent release version number.

MacOS

export VERSION="v1.1.0"
curl -L https://cdn.porter.sh/$VERSION/install-mac.sh | bash

Linux

export VERSION="v1.1.0"
curl -L https://cdn.porter.sh/$VERSION/install-linux.sh | bash

Windows

$VERSION="v1.1.0"
(New-Object System.Net.WebClient).DownloadFile("https://cdn.porter.sh/$VERSION/install-windows.ps1", "install-porter.ps1")
.\install-porter.ps1

Running multiple versions

If you have multiple versions of Porter installed on the same machine, you can switch between then by setting the PORTER_HOME environment variable and adding the desired version of Porter to your PATH.

Bash

export PORTER_HOME=~/.porterv1
export PATH=$PORTER_HOME:$PATH
# Check that you are using the desired version of porter
porter version

Windows

$env:PORTER_HOME="$env:USERPROFILE\.porterv1"
$env:PATH+=";$env:PORTER_HOME"
# Check that you are using the desired version of porter
porter version

Clean Install

To perform a clean installation of Porter:

  1. Remove the PORTER_HOME directory, which by default is located at ~/.porter.

  2. Start over with a fresh database. If you were using an external database, update your porter configuration file to use a different database.

    Otherwise, if you had not specified a storage plugin or database in the configuration file, then your database is located in a container in Docker. Remove the mongodb container and volume, so that when Porter is run again, it creates a new database:

    docker rm -f porter-mongodb-docker-plugin
docker volume rm porter-mongodb-docker-plugin-data

  3. Install Porter following the instructions on this page.

Latest

Install the most recent tagged v1 release of porter and the exec mixin.

Latest MacOS 

curl -L https://cdn.porter.sh/latest/install-mac.sh | bash

Latest Linux 

curl -L https://cdn.porter.sh/latest/install-linux.sh | bash

Latest Windows

You will need to create a PowerShell Profile if you do not have one.

iwr "https://cdn.porter.sh/latest/install-windows.ps1" -UseBasicParsing | iex

Air-gapped Install

To run the installation script in an air-gapped environment, create an air-gapped installation package with the bundle-linux.sh script. Note that mixins are not currently included in the air-gapped-bundle.

curl -L https://raw.githubusercontent.com/getporter/porter/main/scripts/bundle/bundle-linux.sh | bash

Then extract and install Porter.

tar -xzf porter-air-gapped-install-latest.tar.gz -C .
cd porter-air-gapped-install-latest
bash install-bundle.sh

Note: The install-bundle.sh script starts mongo. If mongo ever has to be restarted use the following command.

docker run --name porter-mongodb-docker-plugin -d -p 27018:27017 -v mongodb_data:/data/db --restart always mongo:8.0-noble

Canary

Install the most recent build of Porter and the exec mixin from the main branch.

This saves you the trouble of cloning and building porter and its mixin repositories yourself. The build may not be stable, but it will have new features that we are developing.

Canary MacOS 

curl -L https://cdn.porter.sh/canary/install-mac.sh | bash

Canary Linux 

curl -L https://cdn.porter.sh/canary/install-linux.sh | bash

Canary Windows

You will need to create a PowerShell Profile if you do not have one.

iwr "https://cdn.porter.sh/canary/install-windows.ps1" -UseBasicParsing | iex

Mixins

We have a number of mixins to help you get started. Only the exec mixin is installed with Porter v1.0.0+, other mixins should be installed separately.

You can update an existing mixin, or install a new mixin using the porter mixin install command:

$ porter mixin install terraform --version v1.0.0-rc.1
installed terraform mixin v1.0.0-rc.1 (090064b)

All the Porter-authored mixins are published to https://cdn.porter.sh/mixins/atom.xml.

Plugins

We have a couple plugins which extend Porter and integrate with other cloud providers and software.

You can update an existing plugin, or install a new plugin using the porter plugin install command:

$ porter plugin install azure --version v1.0.0-rc.1
installed azure plugin v1.0.0-rc.1 (d0d98f4)

All the Porter-authored plugins are published to https://cdn.porter.sh/plugins/atom.xml.

Install Script Parameters

The installation scripts provide the following parameters. Parameters can be specified with environment variables for the macOS and Linux scripts, and on Windows they are named parameters in the script.

PORTER_HOME

Location where Porter is installed (defaults to ~/.porter).

Posix Shells

export PORTER_HOME=/alt/porter/home
curl -L REPLACE_WITH_INSTALL_URL | bash

PowerShell

iwr REPLACE_WITH_INSTALL_URL -OutFile install-porter.ps1 -UseBasicParsing
.\install-porter.ps1 -PORTER_HOME C:\alt\porter\home

PORTER_MIRROR

Base URL where Porter assets, such as binaries and atom feeds, are downloaded. This lets you set up an internal mirror. Note that atom feeds and index files should be updated in the mirror to point to the mirrored location. Porter does not alter the contents of these files.

Posix Shells

export PORTER_MIRROR=https://example.com/porter
curl -L REPLACE_WITH_INSTALL_URL | bash

PowerShell

iwr REPLACE_WITH_INSTALL_URL -OutFile install-porter.ps1 -UseBasicParsing
.\install-porter.ps1 -PORTER_MIRROR https://example.com/porter

URL Structure

Configuring a mirror of Porter’s assets is out of scope of this document. Reach out on the Porter mailing list for assistance.

Below is the general structure for Porter’s asset URLs:

PERMALINK/
  - install-linux.sh
  - install-mac.sh
  - install-windows.ps1
  - porter-GOOS-GOARCH[FILE_EXT]
mixins/
  - atom.xml
  - index.json
  - MIXIN/PERMALINK/MIXIN-GOOS-GOARCH[FILE_EXT]
plugins/
  - atom.xml
  - index.json
  - PLUGIN/PERMALINK/PLUGIN-GOOS-GOARCH[FILE_EXT]

Command Completion

Porter provides autocompletion support for Bash, Fish, Zsh, and PowerShell.

If you use Bash the completion script depends on Bash v4.1 or newer and bash-completion v2.

The default version for macOS is Bash v3.2 and bash-completion v1. The completion command will not work properly with these versions. The Kubernetes project has detailed information for upgrading Bash and installing bash-completion here.

Initial Setup

The initial setup is to generate a completion script file and have your shell environment source it when you start your shell.

The completion command will generate its output to standard out and you can capture the output into a file. This file should be put in a place where your shell reads completion files.

An example for Bash:

porter completion bash > /usr/local/etc/bash_completion.d/porter

Once your completion script file is in place you will have to source it for your current shell or start a new shell session.

Completion Usage

To list available commands for Porter, in your terminal run

$ porter [tab][tab]

To find a specific command that starts with bu

$ porter bu[tab][tab]

build    bundles

Commands that have sub-commands will be displayed with completions as well

$ porter credentials [tab][tab]

delete    edit    generate    list    show

Note: Completion commands are available for Porter’s built-in commands and flags, future plans include dynamic completion for your project.

Migrate from Porter v0 to v1