Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
3812966
add top level support topic
craig-osterhout Jul 13, 2022
b522f38
fix links
craig-osterhout Jul 13, 2022
4272bf9
remove link that no longer exists
craig-osterhout Jul 13, 2022
d17f279
create a global setting section for DD (#15122)
aevesdocker Jul 14, 2022
4c8f139
fix typo
craig-osterhout Jul 14, 2022
ddba778
Merge pull request #15126 from craig-osterhout/toc-typo
thaJeztah Jul 14, 2022
75e73aa
Merge pull request #15120 from craig-osterhout/ENGDOCS-760-support
craig-osterhout Jul 14, 2022
3f5009e
Merge pull request #15121 from craig-osterhout/ENGDOCS-813
craig-osterhout Jul 14, 2022
f02e3ea
ENGDOCS-812 get-started screenshots (#15100)
craig-osterhout Jul 14, 2022
e93034c
desktop: settings: update keywords, fix typo
thaJeztah Jul 15, 2022
ed272c5
desktop: settings: fix headings
thaJeztah Jul 15, 2022
ed76ad6
desktop: settings: update link to proxy settings
thaJeztah Jul 15, 2022
672a6c0
desktop: settings: sync general, resources, advanced sections
thaJeztah Jul 15, 2022
a9fa8db
desktop: settings: reformat and sync file sharing section
thaJeztah Jul 15, 2022
8d70cf6
desktop: settings: reformat and sync kubernetes section
thaJeztah Jul 15, 2022
cc44c7c
desktop: settings: windows: sync with macOS version
thaJeztah Jul 15, 2022
0bbcb6c
desktop: settings: sync software updates section
thaJeztah Jul 15, 2022
fe7fe7e
desktop: settings: remove note about changes in 4.2.0
thaJeztah Jul 15, 2022
a9b15d6
desktop: settings: remove "-settings" suffix from URLs
thaJeztah Jul 15, 2022
7b7a947
desktop: settings: fix some trailing whitespace
thaJeztah Jul 15, 2022
b603428
Merge pull request #15130 from thaJeztah/sync_desktop_settings
usha-mandya Jul 15, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions _data/toc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1144,7 +1144,7 @@ manuals:
- path: /desktop/install/windows-install/
title: Install on Windows
- path: /desktop/install/linux-install/
title: Insall on Linux
title: Install on Linux
- sectiontitle: Installation per Linux distro
section:
- path: /desktop/install/debian/
Expand Down Expand Up @@ -1181,6 +1181,14 @@ manuals:
title: Logs and troubleshooting
- path: /desktop/dashboard/
title: Dashboard
- sectiontitle: Change settings
section:
- path: /desktop/settings/mac/
title: On Mac
- path: /desktop/settings/windows/
title: On Windows
- path: /desktop/settings/linux/
title: On Linux
- path: /desktop/networking/
title: Explore networking features
- sectiontitle: Dev Environments (Beta)
Expand Down Expand Up @@ -1277,8 +1285,6 @@ manuals:
title: Windows FAQs
- path: /desktop/faqs/linuxfaqs/
title: Linux FAQs
- path: /desktop/support/
title: Get support
- path: /desktop/feedback/
title: Give feedback
- path: /desktop/release-notes/
Expand Down Expand Up @@ -1590,3 +1596,6 @@ manuals:
title: Getting help
- path: /release-notes/
title: Release notes

- path: /support/
title: Get Support
2 changes: 1 addition & 1 deletion compose/gettingstarted.md
Original file line number Diff line number Diff line change
Expand Up @@ -273,7 +273,7 @@ mount is denied, or a service cannot start, try enabling file or drive sharing.
Volume mounting requires shared drives for projects that live outside of
`C:\Users` (Windows) or `/Users` (Mac), and is required for _any_ project on
Docker Desktop for Windows that uses [Linux containers](../desktop/windows/index.md#switch-between-windows-and-linux-containers).
For more information, see [File sharing](../desktop/mac/index.md#file-sharing) on Docker
For more information, see [File sharing](../desktop/settings/mac.md#file-sharing) on Docker
for Mac, and the general examples on how to
> [Manage data in containers](../storage/volumes.md).
>
Expand Down
2 changes: 1 addition & 1 deletion desktop/faqs/windowsfaqs.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Desktop. For more information, see [Docker Desktop fails to start when anti-viru
### Can I change permissions on shared volumes for container-specific deployment requirements?

Docker Desktop does not enable you to control (`chmod`)
the Unix-style permissions on [shared volumes](../windows/index.md#file-sharing) for
the Unix-style permissions on [shared volumes](../settings/windows.md#file-sharing) for
deployed containers, but rather sets permissions to a default value of
[0777](http://permissions-calculator.org/decode/0777/){: target="_blank" rel="noopener" class="_"}
(`read`, `write`, `execute` permissions for `user` and for
Expand Down
Binary file added desktop/images/settings.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added desktop/images/whale-x.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion desktop/install/linux-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ Log out and log back in so that your group membership is re-evaluated.
Docker Desktop for Linux and Docker Engine can be installed side-by-side on the
same machine. Docker Desktop for Linux stores containers and images in an isolated
storage location [within a VM](linux-install.md#why-docker-desktop-for-linux-runs-a-vm) and offers
controls to restrict [its resources](../linux/index.md#resources). Using a dedicated storage
controls to restrict [its resources](../settings/linux.md#resources). Using a dedicated storage
location for Docker Desktop prevents it from interfering with a Docker Engine
installation on the same machine.

Expand Down
156 changes: 1 addition & 155 deletions desktop/linux/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,164 +4,10 @@ keywords: linux, tutorial, run, docker, local, machine
title: Docker Desktop for Linux user manual
---

Welcome to Docker Desktop! The Docker Desktop for Linux user manual provides information on how to configure and manage your Docker Desktop settings.

Docker Desktop is an easy-to-install application that enables you to build and share containerized applications and microservices.
The Docker Desktop for Linux user manual provides information on how to manage your credentials.

For information about Docker Desktop download, system requirements, and installation instructions, see [Install Docker Desktop](../install/linux-install.md).

## Settings

The Docker **Settings** menu allows you to configure your Docker settings such as installation, updates, version channels, Docker Hub login,
and more.

Choose the Docker menu ![whale menu](images/whale-x.png){: .inline} > **Settings** from the
menu bar and configure the runtime options described below.

### General

![Settings](images/menu/prefs-general.png){:width="750px"}

On the **General** tab, you can configure when to start Docker and specify other settings:

- **Start Docker Desktop when you log in**: Automatically starts Docker Desktop when you open your session.

- **Send usage statistics**: Docker Desktop sends diagnostics, crash reports, and usage data. This information helps Docker improve and troubleshoot the application. Clear the check box to opt out.

- **Show weekly tips**: Displays useful advice and suggestions about using Docker.

- **Open Docker Desktop dashboard at startup**: Automatically opens the dashboard when starting Docker Desktop.

- **Enable Docker Compose V1/V2 compatibility mode**: Select this option to enable the `docker-compose` command to use Docker Compose V2.

### Resources

The **Resources** tab allows you to configure CPU, memory, disk, proxies, network, and other resources.

#### Advanced

On the Advanced tab, you can limit resources available to Docker.

![Advanced Preference
settings-advanced](images/menu/prefs-advanced.png){:width="750px"}

Advanced settings are:

- **CPUs**: By default, Docker Desktop is set to use half the number of processors
available on the host machine. To increase processing power, set this to a
higher number; to decrease, lower the number.

- **Memory**: By default, Docker Desktop is set to use 25% of your host's memory. To increase the RAM, set this to a higher number. To decrease it, lower the number.

- **Swap**: Configure swap file size as needed. The default is 1 GB.

- **Disk image size**: Specify the size of the disk image.

- **Disk image location**: Specify the location of the Linux volume where containers and images are stored.

You can also move the disk image to a different location. If you attempt to move a disk image to a location that already has one, you get a prompt asking if you want to use the existing image or replace it.

#### File sharing

Use File sharing to allow local directories on the Linux host to be shared with Linux containers.
This is especially useful for
editing source code in an IDE on the host while running and testing the code in a container.
By default the `/home/<user>` directory is shared. If your project is outside this directory then it must be added
to the list. Otherwise you may get `Mounts denied` or `cannot start service` errors at runtime.

File share settings are:

- **Add a Directory**: Click `+` and navigate to the directory you want to add.

- **Remove a Directory**: Click `-` next to the directory you want to remove

- **Apply & Restart** makes the directory available to containers using Docker's
bind mount (`-v`) feature.

> Tips on shared folders, permissions, and volume mounts
>
* Share only the directories that you need with the container. File sharing
introduces overhead as any changes to the files on the host need to be notified
to the Linux VM. Sharing too many files can lead to high CPU load and slow
filesystem performance.
>
* Shared folders are designed to allow application code to be edited
on the host while being executed in containers. For non-code items
such as cache directories or databases, the performance will be much
better if they are stored in the Linux VM, using a [data volume](../../storage/volumes.md)
(named volume) or [data container](../../storage/volumes.md).

#### Proxies

To configure HTTP proxies, switch on the **Manual proxy configuration** setting.

Your proxy settings, however, will not be propagated into the containers you start.
If you wish to set the proxy settings for your containers, you need to define
environment variables for them, just like you would do on Linux, for example:

```console
$ docker run -e HTTP_PROXY=http://proxy.example.com:3128 alpine env

PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
HOSTNAME=b7edf988b2b5
TERM=xterm
HOME=/root
HTTP_PROXY=http://proxy.example.com:3128
```

For more information on configuring the Docker CLI to automatically set proxy variables for both `docker run` and `docker build`
see [Configure the Docker client](/network/proxy#configure-the-docker-client).

#### Network

Docker Desktop uses a private IPv4 network for internal services such as a DNS server and an HTTP proxy. In case the choice of subnet clashes with something in your environment, specify a custom subnet using the **Network** setting.

### Docker Engine

The Docker Engine page allows you to configure the Docker daemon to determine how your containers run.

Type a JSON configuration file in the box to configure the daemon settings. For a full list of options, see the Docker Engine
[dockerd commandline reference](/engine/reference/commandline/dockerd/){:target="_blank" rel="noopener" class="_"}.

Click **Apply & Restart** to save your settings and restart Docker Desktop.

### Experimental Features

On the **Experimental Features** page, you can specify whether or not to enable experimental features.

Experimental features provide early access to future product functionality. These features are intended for testing and feedback only as they may change between releases without warning or can be removed entirely from a future release. Experimental features must not be used in production environments. Docker does not offer support for experimental features.

### Kubernetes

Docker Desktop includes a standalone Kubernetes server, so
that you can test deploying your Docker workloads on Kubernetes. To enable Kubernetes support and install a standalone instance of Kubernetes running as a Docker container, select **Enable Kubernetes**.

- Select **Show system containers (advanced)** to view internal containers when using Docker commands.

- Select **Reset Kubernetes cluster** to delete all stacks and Kubernetes resources. For more information, see [Kubernetes](../kubernetes.md){:target="_blank" rel="noopener" class="_"}.

- Click **Apply & Restart** for your changes to take effect.

### Reset

> Reset and Restart options
>
> On Docker Desktop Linux, the **Restart Docker Desktop**, **Reset to factory defaults**, and other reset options are available from the **Troubleshoot** menu.

For information about the reset options, see [Logs and Troubleshooting](troubleshoot.md).

### Software Updates

The **Software Updates** section notifies you of any updates available to Docker Desktop. When there's a new update, click the **Release Notes** option to learn what's included in the updated version.

> **Disable automatic check for updates**
>
> Turn off the check for updates by clearing the **Automatically check for updates** check box. This disables notifications in the Docker menu and also the notification badge that appears on the Docker Dashboard. To check for updates manually, select the **Check for updates** option in the Docker menu.

## Dashboard

The Docker Dashboard enables you to interact with containers and applications and manage the lifecycle of your applications directly from your machine. The Dashboard UI shows all running, stopped, and started containers with their state. It provides an intuitive interface to perform common actions to inspect and manage containers and existing Docker Compose applications. For more information, see [Docker Dashboard](../dashboard.md).

## Credentials management

Docker Desktop relies on [`pass`](https://www.passwordstore.org/){: target="_blank" rel="noopener" class="_"} to store credentials in gpg2-encrypted files.
Expand Down
8 changes: 4 additions & 4 deletions desktop/linux/troubleshoot.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: Logs and troubleshooting
---

{% include upgrade-cta.html
body="Did you know that Docker Desktop offers support for developers on a paid Docker subscription (Pro, Team, or Business)? Upgrade now to benefit from Docker Support. Click [here](#support) to learn more."
body="Did you know that Docker Desktop offers support for developers on a paid Docker subscription (Pro, Team, or Business)? Upgrade now to benefit from Docker Support. Click [here](../../support/index.md) to learn more."
target-url="https://www.docker.com/pricing?utm_source=docker&utm_medium=webreferral&utm_campaign=docs_driven_upgrade_desktop_support"
%}

Expand All @@ -22,9 +22,9 @@ The Troubleshoot page contains the following options:

* **Restart Docker Desktop**: Select to restart Docker Desktop.

* **Support**: Users with a paid Docker subscription can use this option to send a support request. Other users can use this option to diagnose any issues in Docker Desktop. For more information, see [Diagnose and feedback](#diagnose-and-feedback) and [Support](#support).
* **Support**: Users with a paid Docker subscription can use this option to send a support request. Other users can use this option to diagnose any issues in Docker Desktop. For more information, see [Diagnose and feedback](#diagnose-and-feedback) and [Support](../../support/index.md).

* **Reset Kubernetes cluster**: Select this option to delete all stacks and Kubernetes resources. For more information, see [Kubernetes](index.md#kubernetes).
* **Reset Kubernetes cluster**: Select this option to delete all stacks and Kubernetes resources. For more information, see [Kubernetes](../settings/linux.md#kubernetes).

* **Clean / Purge data**: This option resets all Docker data _without_ a
reset to factory defaults. Selecting this option results in the loss of existing settings.
Expand Down Expand Up @@ -146,7 +146,7 @@ to learn how to view the Docker Daemon logs.
If you are using mounted volumes and get runtime errors indicating an
application file is not found, access to a volume mount is denied, or a service
cannot start, such as when using [Docker Compose](../../compose/gettingstarted.md),
you might need to enable [file sharing](index.md#file-sharing).
you might need to enable [file sharing](../settings/linux.md#file-sharing).

Volume mounting requires shared drives for projects that live outside of the
`/home/<user>` directory. Go to ![whale menu](images/whale-x.png){: .inline} >
Expand Down
2 changes: 1 addition & 1 deletion desktop/mac/apple-silicon.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ $ softwareupdate --install-rosetta
### Known issues

- Some command line tools do not work when Rosetta 2 is not installed.
- The old version 1.x of `docker-compose`. We recommend that you use Compose V2 instead. Either type `docker compose` or enable the **Use Docker Compose V2** option in the [General preferences tab](./index.md#general).
- The old version 1.x of `docker-compose`. We recommend that you use Compose V2 instead. Either type `docker compose` or enable the **Use Docker Compose V2** option in the [General preferences tab](../settings/mac.md#general).
- The `docker scan` command and the underlying `snyk` binary.
- The `docker-credential-ecr-login` credential helper.
- Not all images are available for ARM64 architecture. You can add `--platform linux/amd64` to run an Intel image under emulation. In particular, the [mysql](https://hub.docker.com/_/mysql?tab=tags&page=1&ordering=last_updated) image is not available for ARM64. You can work around this issue by using a [mariadb](https://hub.docker.com/_/mariadb?tab=tags&page=1&ordering=last_updated) image.
Expand Down
Loading