Skip to content

Commit

Permalink
docs: suggestion ddev --version, move mkcert -install to later (#6319)…
Browse files Browse the repository at this point in the history
… [skip ci]

Co-authored-by: Stanislav Zhuk <stasadev@gmail.com>
  • Loading branch information
rfay and stasadev committed Jun 17, 2024
1 parent 1489c50 commit 4f2cda8
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 16 deletions.
43 changes: 27 additions & 16 deletions docs/content/users/install/ddev-installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,25 +8,27 @@ Once you’ve [installed a Docker provider](docker-installation.md), you’re re

### Homebrew

[Homebrew](https://brew.sh/) is the easiest and most reliable way to install and upgrade DDEV:
[Homebrew](https://brew.sh/) is the easiest and most reliable way to install and [upgrade](./ddev-upgrade.md) DDEV:

```bash
# Install DDEV
brew install ddev/ddev/ddev

# Initialize mkcert
# One-time initialization of mkcert
mkcert -install
```

### Install Script

The [install script](https://github.com/ddev/ddev/blob/master/scripts/install_ddev.sh) is another option. It downloads, verifies, and sets up the `ddev` binary:
The [install script](https://github.com/ddev/ddev/blob/master/scripts/install_ddev.sh) is another option. It downloads, verifies, and sets up the `ddev` executable:

```bash
# Download and run the install script
curl -fsSL https://ddev.com/install.sh | bash
```

??? "Do you still have an old version after installing or upgrading?"
If `ddev --version` still shows an older version than you installed or upgraded to, use `which -a ddev` to find out where another version of the `ddev` executable must be installed. See the ["Why Do I Have An Old DDEV" FAQ](../usage/faq.md#why-do-i-have-an-old-ddev).
??? "Need a specific version?"
Use the `-s` argument to specify a specific stable or prerelease version:

Expand All @@ -39,17 +41,6 @@ Once you’ve [installed a Docker provider](docker-installation.md), you’re re

## Linux

### Locally-trusted certificate with mkcert

Modern browsers require valid certificates, which mkcert can create. [Install mkcert](https://github.com/FiloSottile/mkcert#installation), and then run this:

```bash
# Initialize mkcert
mkcert -install
```

Some versions of Firefox (Developer Edition, Flatpak) may need some [extra work](https://github.com/FiloSottile/mkcert/issues/370#issuecomment-1280377305), see also [this issue](https://github.com/ddev/ddev/issues/5415).

### Debian/Ubuntu

DDEV’s Debian and RPM packages work with `apt` and `yum` repositories and most variants that use them, including Windows WSL2:
Expand All @@ -69,8 +60,16 @@ Once you’ve [installed a Docker provider](docker-installation.md), you’re re
# Update package information and install DDEV
sudo sh -c 'echo ""'
sudo apt-get update && sudo apt-get install -y ddev

# One-time initialization of mkcert
mkcert -install
```

(Some versions of Firefox (Developer Edition, Flatpak) may need some [extra work](https://github.com/FiloSottile/mkcert/issues/370#issuecomment-1280377305) with `mkcert`, see also [this issue](https://github.com/ddev/ddev/issues/5415).)

??? "Do you still have an old version after installing or upgrading?"
If `ddev --version` still shows an older version than you installed or upgraded to, use `which -a ddev` to find out where another version of the `ddev` executable must be installed. See the ["Why Do I Have An Old DDEV" FAQ](../usage/faq.md#why-do-i-have-an-old-ddev).

??? "Need to remove a previously-installed variant?"
If you previously used DDEV’s [install script](#install-script), you can remove that version:

Expand All @@ -94,6 +93,9 @@ Once you’ve [installed a Docker provider](docker-installation.md), you’re re
# Install DDEV
sudo sh -c 'echo ""'
sudo dnf install --refresh ddev

# One-time initialization of mkcert
mkcert -install
```

Signed yum repository support will be added in the future.
Expand All @@ -105,19 +107,25 @@ Once you’ve [installed a Docker provider](docker-installation.md), you’re re
```bash
# Install DDEV
yay -S ddev-bin

# One-time initialization of mkcert
mkcert -install
```

### Homebrew (AMD64 only)

```bash
# Install DDEV using Homebrew
brew install ddev/ddev/ddev

# One-time initialization of mkcert
mkcert -install
```

<!-- we’re using HTML here to customize the #install-script-linux anchor -->
<h3 id="install-script-linux">Install Script<a class="headerlink" href="#install-script-linux" title="Permanent link">¶</a></h3>

The [install script](https://github.com/ddev/ddev/blob/master/scripts/install_ddev.sh) is another option. It downloads, verifies, and sets up the `ddev` binary:
The [install script](https://github.com/ddev/ddev/blob/master/scripts/install_ddev.sh) is another option. It downloads, verifies, and sets up the `ddev` executable:

```bash
# Download and run the install script
Expand All @@ -132,6 +140,9 @@ Once you’ve [installed a Docker provider](docker-installation.md), you’re re
curl -fsSL https://ddev.com/install.sh | bash -s v1.21.4
```

??? "Do you still have an old version after installing or upgrading?"
If `ddev --version` still shows an older version than you installed or upgraded to, use `which -a ddev` to find out where another version of the `ddev` executable must be installed. See the ["Why Do I Have An Old DDEV" FAQ](../usage/faq.md#why-do-i-have-an-old-ddev).

=== "Windows"

## Windows
Expand Down Expand Up @@ -488,7 +499,7 @@ Once you’ve [installed a Docker provider](docker-installation.md), you’re re

## Manual

DDEV is a single executable, so installation on any OS is a matter of copying the `ddev` binary for your architecture into the appropriate system path on your machine.
DDEV is a single executable, so installation on any OS is a matter of copying the `ddev` executable for your architecture into the appropriate system path on your machine.

* Download and extract the latest [DDEV release](https://github.com/ddev/ddev/releases) for your architecture.
* Move `ddev` to `/usr/local/bin` with `mv ddev /usr/local/bin/` (may require `sudo`), or another directory in your `$PATH` as preferred.
Expand Down
12 changes: 12 additions & 0 deletions docs/content/users/install/ddev-upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,10 @@ Installing and upgrading DDEV are nearly the same thing, because you're upgradin
curl -fsSL https://ddev.com/install.sh | bash
```

### Verify New Version

Use `ddev --version` to find out the version of the `ddev` binary in your `$PATH`. If `ddev --version` still shows an older version than you installed or upgraded to, use `which -a ddev` to find out where another version of the `ddev` binary must be installed. See the ["Why Do I Have An Old DDEV" FAQ](../usage/faq.md#why-do-i-have-an-old-ddev).

??? "Need a specific version?"
Use the `-s` argument to specify a specific stable or prerelease version:

Expand Down Expand Up @@ -56,6 +60,10 @@ Installing and upgrading DDEV are nearly the same thing, because you're upgradin
yay -Syu ddev-bin
```

### Verify New Version

Use `ddev --version` to find out the version of the `ddev` binary in your `$PATH`. If `ddev --version` still shows an older version than you installed or upgraded to, use `which -a ddev` to find out where another version of the `ddev` binary must be installed. See the ["Why Do I Have An Old DDEV" FAQ](../usage/faq.md#why-do-i-have-an-old-ddev).

=== "Windows"

## Windows
Expand All @@ -71,6 +79,10 @@ Installing and upgrading DDEV are nearly the same thing, because you're upgradin
sudo apt-get update && sudo apt-get upgrade -y
```

### Verify New Version

Use `ddev --version` to find out the version of the `ddev` binary in your `$PATH`. If `ddev --version` still shows an older version than you installed or upgraded to, use `which -a ddev` to find out where another version of the `ddev` binary must be installed. See the ["Why Do I Have An Old DDEV" FAQ](../usage/faq.md#why-do-i-have-an-old-ddev).

### Traditional Windows

#### Chocolatey
Expand Down
3 changes: 3 additions & 0 deletions pkg/ddevapp/global_dotddev_assets/commands/host/self-upgrade
Original file line number Diff line number Diff line change
Expand Up @@ -44,3 +44,6 @@ for ddev_path in $(which -a ddev | uniq); do

esac
done
printf "\n'ddev --version' will show you the version you currently have installed.\n"
printf "'which ddev' will show you where that executable is on your filesystem.\n"
printf "See docs for more info: \nhttps://ddev.readthedocs.io/en/stable/users/install/ddev-installation/\n"

0 comments on commit 4f2cda8

Please sign in to comment.