-
Notifications
You must be signed in to change notification settings - Fork 7.5k
Commit
- Loading branch information
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
--- | ||
title: Add or edit your run commands | ||
description: Learn how to add or edit your run commands in Docker Projects | ||
keywords: Docker, projects, docker deskotp, containerization, open, remote, local, run commands | ||
weight: 20 | ||
--- | ||
|
||
## Add a run command to a project | ||
|
||
1. Open an existing project and ensure that it is stopped. | ||
|
||
2. From the command dopdown menu, select **New run command**. | ||
Check failure on line 12 in content/manuals/projects/edit.md
|
||
|
||
3. Specify the following information for the run command: | ||
|
||
> [!TIP] | ||
> | ||
> 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. | ||
Check failure on line 18 in content/manuals/projects/edit.md
|
||
- **Name**: Specify a name to identify the run command. | ||
- **Compose files**: Select one or more Compose files from your project. | ||
- **Flags**: Optionally, select one or more flags for your run command. | ||
|
||
> [!TIP] | ||
> | ||
> 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. | ||
- **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. | ||
Check failure on line 28 in content/manuals/projects/edit.md
|
||
- **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. | ||
|
||
4. Select **Save changes**. | ||
|
||
You can now select the new run command from the dropdown menu after opening the project. | ||
Check warning on line 33 in content/manuals/projects/edit.md
|
||
|
||
## Edit a run command | ||
|
||
1. Open an existing project and ensure that it is stopped. | ||
2. Select the run command you want to change from the command dropdown menu. | ||
Check warning on line 38 in content/manuals/projects/edit.md
|
||
3. Select the **Edit** icon next to the **Run** button. | ||
4. Specify your changes and then select **Save changes**. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
--- | ||
title: Docker Projects FAQs | ||
linkTitle: FAQs | ||
description: Find common FAQs for Docker Projects | ||
keywords: faqs, docker projects, local, remote | ||
--- | ||
|
||
## Why is a Compose file required? | ||
|
||
A Compose file (`compose.yml`) defines how your application's containers should run together, including: | ||
|
||
- Services (e.g., web, database, API) | ||
- Networks for inter-container communication | ||
- Volumes for persistent data storage | ||
- Environment variables and configurations | ||
|
||
Without a Compose file, Docker Projects doesn't have a way to understand how your application should be structured or executed. | ||
|
||
## What if my project doesn’t have a Compose file? | ||
Check warning on line 19 in content/manuals/projects/faq.md
|
||
|
||
If your project doesn't include a `compose.yml` file, you need to create one before opening it in Docker Projects. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
--- | ||
title: Manage your projects | ||
description: Learn how to delete or completely remove a project. | ||
keywords: Docker, projects, docker deskotp, containerization, open, remote, local | ||
weight: 30 | ||
--- | ||
|
||
## Run a project or service | ||
|
||
1. Open a new or existing project. | ||
|
||
2. Select a run command from the dropdown menu. | ||
Check warning on line 12 in content/manuals/projects/manage.md
|
||
|
||
3. Select the **Run** button for the project or the **Play** button next to the service you'd like to run. | ||
|
||
## Stop or restart a project or service | ||
|
||
1. Open an existing project that is running. | ||
|
||
2. Select the **Stop** or **Restart** button for the project or the appropriate button next to the service. | ||
|
||
## Remove a project from Docker Desktop | ||
|
||
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. | ||
|
||
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. | ||
None of your local code is deleted when removing a project from Docker Desktop. | ||
|
||
To remove a project from Docker Desktop: | ||
Sign in to Docker Desktop, and go to Projects. | ||
Select the options menu () next to the project, and then select Remove from Docker Desktop. | ||
|
||
## Delete a project | ||
|
||
Deleting a project removes it from Docker Desktop and deletes all configuration locally and remotely from the cloud. When a project is deleted, you can no longer run the project from the **Projects** view. None of your local code is deleted when you delete a project from Docker Desktop. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,103 @@ | ||
--- | ||
title: Open a new project | ||
description: Learn how to open a new local or remote project, or an existing project in Docker Projects. | ||
keywords: Docker, projects, docker deskotp, containerization, open, remote, local | ||
weight: 10 | ||
--- | ||
|
||
## New projects | ||
|
||
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. | ||
|
||
### Open a new local project | ||
|
||
A project consists of your code and at least one Compose file. Ensure that you have a Compose file before trying to open a new project. | ||
|
||
To open a new project: | ||
|
||
1. Sign in to Docker Desktop, and go to **Projects**. | ||
|
||
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. | ||
|
||
> [!NOTE] | ||
> | ||
> A local folder can also be the folder of a Git repository that you have already cloned. | ||
3. Configure your project by giving it a name and setting the owner, then select **Next**. | ||
|
||
4. Specify how to run your project by selecting **New run command**: | ||
|
||
> [!TIP] | ||
> | ||
> 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. | ||
- **Name**: Specify a name to identify the run command. | ||
- **Compose files**: Select one or more Compose files from your project. | ||
- **Flags**: Optionally, select one or more flags for your run command. | ||
|
||
> [!TIP] | ||
> | ||
> 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. | ||
- **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. | ||
- **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. | ||
|
||
5. Select **Save changes**. | ||
|
||
Your project is now ready to run. | ||
|
||
## Open a new remote project | ||
|
||
The following steps prompt you to clone the Git repository for your project. | ||
|
||
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. | ||
|
||
To clone and open a remote project: | ||
|
||
1. Sign in to Docker Desktop, and go to **Projects**. | ||
|
||
2. Select **Clone a git repository**. This lets you specify a Git repository and a local folder to clone that repository to. The repository must contain at least your project’s code and a Compose file. | ||
|
||
3. Enter the remote source and choose the local destination to clone to. | ||
|
||
4. Select **Clone project**. | ||
|
||
5. Configure your project by giving it a name and setting the owner, then select **Next**. | ||
|
||
6. Specify how to run your project by selecting **New run command**: | ||
|
||
> [!TIP] | ||
> | ||
> 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. | ||
- **Name**: Specify a name to identify the run command. | ||
- **Compose files**: Select one or more Compose files from your project. | ||
- **Flags**: Optionally, select one or more flags for your run command. | ||
|
||
> [!TIP] | ||
> | ||
> 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. | ||
- **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. | ||
- **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. | ||
|
||
7. Select **Save changes**. | ||
|
||
## Existing projects | ||
|
||
### Open an existing local project | ||
|
||
1. Sign in to Docker Desktop, and go to **Projects**. | ||
|
||
2. Open your project by selecting your project under **Recents**, or by selecting the specific owner that your project is associated with and then select your project. | ||
|
||
## Open an existing remote project | ||
|
||
In the Projects page in Docker Desktop, existing remote projects display No local copy under the project. | ||
|
||
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. | ||
|
||
To open an existing remote project, you can choose between: | ||
|
||
- Cloning the project into a local destination. | ||
- Linking to an existing folder where the project has already been cloned |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
--- | ||
title: Share and collaborate on a project | ||
linkTitle: Collaborate | ||
description: TBD | ||
keywords: TBD | ||
--- | ||
|
||
Incoming.. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
--- | ||
title: View your project | ||
description: View information about your project or the services within your project. | ||
keywords: containers, docker projects, local, remote, docker desktop | ||
--- | ||
|
||
|
||
View a project’s readme | ||
Check failure on line 8 in content/manuals/projects/view.md
|
||
If a project has a readme file, you can view it via Docker Projects. Note that the README tab is only visible if the project has a readme file. | ||
Check failure on line 9 in content/manuals/projects/view.md
|
||
To view a project’s readme: | ||
Open a new or existing project. | ||
Select the README tab.. | ||
View logs for a project | ||
Open a new or existing project. | ||
Select the Logs tab to see all project logs. | ||
Optionally, use the menu in the top right corner of the logs to copy the logs to your clipboard or clear the logs. | ||
|
||
## View service-level information | ||
|
||
With Docker Projects, you can view the following information about your containers within your project: | ||
|
||
- Logs | ||
- Files | ||
- Network | ||
- Environment variables | ||
|
||
From the Exec tab, you can use the integrated terminal, on a running container, directly within Docker Desktop. You are able to quickly run commands within your container so you can understand its current state or debug when something goes wrong. | ||
|