You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/manuals/projects/about.md
+16-8Lines changed: 16 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -5,33 +5,41 @@ keywords: docker projects
5
5
weight: 10
6
6
---
7
7
8
-
Docker Projects requires a Compose file (docker-compose.yml) to define your application's services, networks, and configurations. When you open a project, Docker Projects automatically detects the Compose file, allowing you to configure and run services with pre-set commands.
8
+
Docker Projects requires a Compose file (`compose.yml`) to define your application's services, networks, and configurations. When you open a project, Docker Projects automatically detects the Compose file, allowing you to configure and run services with pre-set commands.
9
9
10
10
By integrating with Docker Compose, Docker Projects ensures a consistent, easy-to-manage workflow for both individual developers and teams. Whether you're starting a new project, configuring it, or collaborating with a team, Docker Projects keeps the process simple.
11
11
12
+
Docker Projects works as follows:
13
+
12
14
1. Create or open a project. You can:
13
15
14
16
- Open a local project: Select a folder on your machine that contains your project code.
15
-
- Clone a Git repository:Provide a repository URL and clone the project into a local directory.
17
+
- Clone a Git repository:Provide a repository URL and clone the project into a local directory.
16
18
17
-
Once a project is opened, Docker Desktop detects the Compose file and prepares the project for execution.
19
+
Once a project is opened, Docker Desktop detects the Compose file and prepares the project for execution.
18
20
19
21
2. Configure and run your project with pre-configured commands. These commands:
20
22
21
23
- Work like `docker compose up`, launching services based on the Compose file.
22
24
- Can be customized with additional flags, multiple Compose files, and environment variables.
23
-
-Allow pre-run tasks, such as executing scripts before starting the services.
25
+
-Enable pre-run tasks, such as executing scripts before starting the services.
24
26
25
-
All of which means you can fine-tune your configurations without manually running complex CLI commands.
27
+
All of which means you can fine-tune your configurations without manually running complex CLI commands.
26
28
27
29
3. Collaborate and share with teams. For projects linked to a Git repository, Docker Projects stores artifacts in the cloud, enabling easy collaboration:
28
30
29
31
- Work across devices: Open a project from any machine and instantly access stored configurations.
30
-
- Share configurations: Team members can access predefined run commands, reducing setup time.
32
+
- Share configurations: Team members can access pre-defined run commands, reducing setup time.
31
33
32
-
Collaboration is seamless—new developers can join a team, open a project, and start working without complex setup steps.
34
+
Collaboration is easy — new developers can join a team, open a project, and start working without complex setup steps.
33
35
34
36
4. Manage and iterate. Once a project is up and running, Docker Projects makes it easy to monitor, update, and troubleshoot:
35
37
36
38
- View logs to debug issues and track service activity.
37
-
- Edit configurations and run commands as requirements change.
39
+
- Edit configurations and run commands as requirements change.
40
+
41
+
## What's next?
42
+
43
+
-[Learn how to open a new project](/manuals/projects/new.md)
Copy file name to clipboardExpand all lines: content/manuals/projects/edit.md
+14-7Lines changed: 14 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -9,32 +9,39 @@ weight: 40
9
9
10
10
1. Open an existing project and ensure that it is stopped.
11
11
12
-
2. From the command dopdown menu, select **New run command**.
12
+
2. From the command drop-down menu, select **New run command**.
13
13
14
14
3. Specify the following information for the run command:
15
15
16
16
> [!TIP]
17
17
>
18
-
> While configuring your run command, you can view the equivalent docker compose up command in the Run command section on the configuration page. You can also use this command to run your project from the command line. You can refer to the docker compose up reference documentation to learn more about the options you configure.
18
+
> While configuring your run command, you can view the equivalent `docker compose up` command in the **Run command** section on the configuration page. You can also use this command to run your project from the command line. You can refer to the [`docker compose up` reference documentation](/reference/cli/docker/compose/up.md) to learn more about the options you configure.
19
19
20
20
-**Name**: Specify a name to identify the run command.
21
21
-**Compose files**: Select one or more Compose files from your project.
22
22
-**Flags**: Optionally, select one or more flags for your run command.
23
23
24
24
> [!TIP]
25
25
>
26
-
> While the --env-file flag isn't currently supported, you can specify environment variables in your Compose file, or use the Tasks option to run a script that sets your environment variables.
26
+
> While the `--env-file` flag isn't currently supported, you can specify environment variables in your Compose file, or use the **Tasks** option to run a script that sets your environment variables.
27
27
28
-
-**Services that will run**: After selecting one or more Compose files, the services defined in the files will appear here. If there is more than one service, you can optionally choose to not run a service by unchecking it.
29
-
-**Tasks (Advanced options)**: Optionally specify a command to run before running the project. For example, if you want to run a bash script from the project directory named set-vars.sh, you can specify bash set-vars.sh. Or, on Windows to run a script with cmd.exe named set-vars.bat, specify set-vars.bat. Note that a task can access environment variables from your terminal profile, but it can't access local shell functions nor aliases.
28
+
-**Services that will run**: After selecting one or more Compose files, the services defined in the files will appear here. If there is more than one service, you can optionally choose to not run a service by deselecing the checkbox.
29
+
-**Tasks (Advanced options)**: Optionally specify a command to run before running the project. For example, if you want to run a bash script from the project directory named `set-vars.sh`, you can specify bash `set-vars.sh`. Or, on Windows to run a script with `cmd.exe` named `set-vars.bat`, specify `set-vars.bat`. Note that a task can access environment variables from your terminal profile, but it can't access local shell functions nor aliases.
30
30
31
31
4. Select **Save changes**.
32
32
33
-
You can now select the new run command from the dropdown menu after opening the project.
33
+
You can now select the new run command from the drop-down menu after opening the project.
34
34
35
35
## Edit a run command
36
36
37
37
1. Open an existing project and ensure that it is stopped.
38
-
2. Select the run command you want to change from the command dropdown menu.
38
+
39
+
2. Select the run command you want to change from the command drop-down menu.
40
+
39
41
3. Select the **Edit** icon next to the **Run** button.
42
+
40
43
4. Specify your changes and then select **Save changes**.
44
+
45
+
## What's next?
46
+
47
+
-[Manage your projects](/manuals/projects/manage.md)
Copy file name to clipboardExpand all lines: content/manuals/projects/manage.md
+6-4Lines changed: 6 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ weight: 50
9
9
10
10
1. Open a new or existing project.
11
11
12
-
2. Select a run command from the dropdown menu.
12
+
2. Select a run command from the drop-down menu.
13
13
14
14
3. Select the **Run** button for the project or the **Play** button next to the service you'd like to run.
15
15
@@ -21,14 +21,16 @@ weight: 50
21
21
22
22
## Remove a project from Docker Desktop
23
23
24
-
If a project is associated with a Git repository, you can remove it from Docker Desktop. When a project is deleted, you can no longer run the project from the **Projects** view, but its run configuration still exists remotely in the cloud.
24
+
If a project is associated with a Git repository, you can remove it from Docker Desktop. When a project is deleted, you can no longer run the project from the **Projects** view, but its run configuration still exists remotely in the cloud.
25
25
26
26
This means that you can later [open the project](/manuals/projects/open.md#open-an-existing-remote-project) and associate it with the remote run configuration without having to specify the run command again.
27
27
None of your local code is deleted when removing a project from Docker Desktop.
28
28
29
29
To remove a project from Docker Desktop:
30
-
Sign in to Docker Desktop, and go to Projects.
31
-
Select the options menu () next to the project, and then select Remove from Docker Desktop.
30
+
31
+
1. Sign in to Docker Desktop, and go to **Projects**.
32
+
33
+
2. Select the **More actions** menu next to the project, and then select **Remove from Docker Desktop**.
> In order to use Docker Projects, make sure you have enabled the **Access experimental features** setting on the **Features in development** tab.
11
+
8
12
## New projects
9
13
10
-
When you open a new or remote project, Docker Projects stores all your code and Docker artifacts locally. In order to run a project, it must be stored locally. In the Projects page in Docker Desktop, local projects display the local path under the project.
14
+
In order to run a new project, it must be stored locally. In the **Projects** view in Docker Desktop, local projects display the local path under the project.
11
15
12
16
### Open a new local project
13
17
@@ -17,30 +21,34 @@ To open a new project:
17
21
18
22
1. Sign in to Docker Desktop, and go to **Projects**.
19
23
20
-
2. Select one **Open a local folder**. This lets you select a local folder that contains at least your project’s code and a Compose file.
24
+
2. Select **Open a local folder**. This lets you select a local folder that contains your project’s code and a Compose file.
21
25
22
26
> [!NOTE]
23
27
>
24
28
> A local folder can also be the folder of a Git repository that you have already cloned.
25
29
26
30
3. Configure your project by giving it a name and setting the owner, then select **Next**.
27
31
32
+
> [!NOTE]
33
+
>
34
+
> If you are part of a Docker organization you have the option to [share your project](share.md) with the organization.
35
+
28
36
4. Specify how to run your project by selecting **New run command**:
29
37
30
38
> [!TIP]
31
39
>
32
-
> While configuring your run command, you can view the equivalent docker compose up command in the Run command section on the configuration page. You can also use this command to run your project from the command line. You can refer to the docker compose up reference documentation to learn more about the options you configure.
40
+
> While configuring your run command, you can view the equivalent `docker compose up` command in the **Run command** section on the configuration page. You can also use this command to run your project from the command line. You can refer to the [`docker compose up` reference documentation](/reference/cli/docker/compose/up.md) to learn more about the options you configure.
33
41
34
42
-**Name**: Specify a name to identify the run command.
35
43
-**Compose files**: Select one or more Compose files from your project.
36
44
-**Flags**: Optionally, select one or more flags for your run command.
37
45
38
46
> [!TIP]
39
47
>
40
-
> While the --env-file flag isn't currently supported, you can specify environment variables in your Compose file, or use the Tasks option to run a script that sets your environment variables.
48
+
> While the `--env-file` flag isn't currently supported, you can specify environment variables in your Compose file, or use the **Tasks** option to run a script that sets your environment variables.
41
49
42
-
-**Services that will run**: After selecting one or more Compose files, the services defined in the files will appear here. If there is more than one service, you can optionally choose to not run a service by unchecking it.
43
-
-**Tasks (Advanced options)**: Optionally specify a command to run before running the project. For example, if you want to run a bash script from the project directory named set-vars.sh, you can specify bash set-vars.sh. Or, on Windows to run a script with cmd.exe named set-vars.bat, specify set-vars.bat. Note that a task can access environment variables from your terminal profile, but it can't access local shell functions nor aliases.
50
+
-**Services that will run**: After selecting one or more Compose files, the services defined in the files will appear here. If there is more than one service, you can optionally choose to not run a service by deselecting the checkbox.
51
+
-**Tasks (Advanced options)**: Optionally specify a command to run before running the project. For example, if you want to run a bash script from the project directory named `set-vars.sh`, you can specify bash `set-vars.sh`. Or, on Windows to run a script with `cmd.exe` named `set-vars.bat`, specify `set-vars.bat`. Note that a task can access environment variables from your terminal profile, but it can't access local shell functions nor aliases.
44
52
45
53
5. Select **Save changes**.
46
54
@@ -50,7 +58,7 @@ Your project is now ready to run.
50
58
51
59
The following steps prompt you to clone the Git repository for your project.
52
60
53
-
If you have already cloned the repository outside of Docker Projects, then you can open the project as a new project and Docker Projects will automatically detect and link the repository.
61
+
If you have already cloned the repository outside of Docker Projects, then you can open the project as a new project and Docker Projects will automatically detect and link the repository.
54
62
55
63
To clone and open a remote project:
56
64
@@ -64,22 +72,26 @@ To clone and open a remote project:
64
72
65
73
5. Configure your project by giving it a name and setting the owner, then select **Next**.
66
74
75
+
> [!NOTE]
76
+
>
77
+
> If you are part of a Docker organization you have the option to [share your project](share.md) with the organization.
78
+
67
79
6. Specify how to run your project by selecting **New run command**:
68
80
69
81
> [!TIP]
70
82
>
71
-
> While configuring your run command, you can view the equivalent docker compose up command in the Run command section on the configuration page. You can also use this command to run your project from the command line. You can refer to the docker compose up reference documentation to learn more about the options you configure.
83
+
> While configuring your run command, you can view the equivalent `docker compose up` command in the **Run command** section on the configuration page. You can also use this command to run your project from the command line. You can refer to the [`docker compose up` reference documentation](/reference/cli/docker/compose/up.md) to learn more about the options you configure.
72
84
73
85
-**Name**: Specify a name to identify the run command.
74
86
-**Compose files**: Select one or more Compose files from your project.
75
87
-**Flags**: Optionally, select one or more flags for your run command.
76
88
77
89
> [!TIP]
78
90
>
79
-
> While the --env-file flag isn't currently supported, you can specify environment variables in your Compose file, or use the Tasks option to run a script that sets your environment variables.
91
+
> While the `--env-file` flag isn't currently supported, you can specify environment variables in your Compose file, or use the **Tasks** option to run a script that sets your environment variables.
80
92
81
-
-**Services that will run**: After selecting one or more Compose files, the services defined in the files will appear here. If there is more than one service, you can optionally choose to not run a service by unchecking it.
82
-
-**Tasks (Advanced options)**: Optionally specify a command to run before running the project. For example, if you want to run a bash script from the project directory named set-vars.sh, you can specify bash set-vars.sh. Or, on Windows to run a script with cmd.exe named set-vars.bat, specify set-vars.bat. Note that a task can access environment variables from your terminal profile, but it can't access local shell functions nor aliases.
93
+
-**Services that will run**: After selecting one or more Compose files, the services defined in the files will appear here. If there is more than one service, you can optionally choose to not run a service by deselecing the checkbox.
94
+
-**Tasks (Advanced options)**: Optionally specify a command to run before running the project. For example, if you want to run a bash script from the project directory named `set-vars.sh`, you can specify bash `set-vars.sh`. Or, on Windows to run a script with `cmd.exe` named `set-vars.bat`, specify `set-vars.bat`. Note that a task can access environment variables from your terminal profile, but it can't access local shell functions nor aliases.
83
95
84
96
7. Select **Save changes**.
85
97
@@ -93,11 +105,17 @@ To clone and open a remote project:
93
105
94
106
### Open an existing remote project
95
107
96
-
In the Projects page in Docker Desktop, existing remote projects display No local copy under the project.
108
+
In the **Projects** view in Docker Desktop, existing remote projects display **No local copy** under the project.
97
109
98
-
You’ll see remote projects when you remove a project from Docker Desktop, or access Docker Desktop from a new device after creating a project associated with a Git repository.
110
+
You’ll see remote projects when you are new to the team and are accessing a shared project, remove a project from Docker Desktop, or access Docker Desktop from a new device after creating a project associated with a Git repository.
99
111
100
112
To open an existing remote project, you can choose between:
101
113
102
114
- Cloning the project into a local destination.
103
115
- Linking to an existing folder where the project has already been cloned
116
+
117
+
## What's next?
118
+
119
+
-[View your project](/manuals/projects/view.md)
120
+
-[Add or edit your run commands](/manuals/projects/edit.md)
121
+
-[Manage your projects](/manuals/projects/manage.md)
Copy file name to clipboardExpand all lines: content/manuals/projects/share.md
+19-1Lines changed: 19 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -6,4 +6,22 @@ keywords: TBD
6
6
weight: 60
7
7
---
8
8
9
-
Incoming..
9
+
Docker Projects makes it easy for teams to share, manage, and collaborate on containerized applications.
10
+
11
+
Collaboration is managed by associating a project with a Docker organization, and leveraging cloud-stored configurations. This allows team members to easily access and work on the same project without needing extensive manual setup.
12
+
13
+
Once a project is associated with an organization, other team members can access it by:
14
+
15
+
1. Signing into Docker Desktop and navigating to **Projects**.
16
+
17
+
2. Selecting the correct organization tab.
18
+
19
+
3. Selecting the project from the list of shared projects.
20
+
21
+
4. Cloning the project into a local destination.
22
+
23
+
## What's next
24
+
25
+
-[View your project](/manuals/projects/view.md)
26
+
-[Add or edit your run commands](/manuals/projects/edit.md)
27
+
-[Manage your projects](/manuals/projects/manage.md)
0 commit comments