3df90fc9b8
Are you looking for something? Here is all of the GitHub Docs history in one single commit. Enjoy! 🎉
82 lines
5.5 KiB
Markdown
82 lines
5.5 KiB
Markdown
---
|
|
title: Configuring Codespaces for your project
|
|
intro: You can set up a default configuration for every new codespace for your repository to ensure that contributors have all the tools and settings they need in their online development environment.
|
|
product: '{{ site.data.reusables.gated-features.codespaces }}'
|
|
permissions: People with write permissions to a repository can create or edit the default codespace configuration.
|
|
redirect_from:
|
|
- /github/developing-online-with-github-codespaces/configuring-github-codespaces-for-your-project
|
|
versions:
|
|
free-pro-team: '*'
|
|
---
|
|
|
|
{{ site.data.reusables.codespaces.release-stage }}
|
|
|
|
### About default codespace configurations
|
|
|
|
{{ site.data.reusables.codespaces.about-configuration }}
|
|
|
|
If you don't define a configuration in your repository, {{ site.data.variables.product.prodname_dotcom }} creates a codespace with a base Linux image. The base Linux image includes tools for Node.js, JavaScript, TypeScript, Python, C++, Java, C#, .NET Core, PHP, and PowerShell. For more information about the base Linux image, see the [`microsoft/vscode-dev-containers`](https://github.com/microsoft/vscode-dev-containers/tree/master/containers/codespaces-linux) repository.
|
|
|
|
{{ site.data.reusables.codespaces.about-personalization }} {{ site.data.reusables.codespaces.codespace-config-order }} For more information, see "[Personalizing {{ site.data.variables.product.prodname_codespaces }} for your account](/github/developing-online-with-codespaces/personalizing-codespaces-for-your-account)."
|
|
|
|
You can create a default codespace configuration using a pre-built container configuration for your project type, or you can create a custom configuration specific to your project's needs.
|
|
|
|
{{ site.data.variables.product.prodname_codespaces }} uses settings contained in a file named `devcontainer.json` in the root of the repository or in a `.devcontainer` folder. You can use `devcontainer.json` to set default settings for the entire codespace environment, including the {{ site.data.variables.product.prodname_vscode }} editor, but you can also set editor-specific settings in a file named `.vscode/settings.json`.
|
|
|
|
Changes to a repository's codespace configuration apply only to every new codespace and do not affect any existing codespace.
|
|
|
|
### Using a pre-built container configuration
|
|
|
|
You can use any pre-built container configuration for {{ site.data.variables.product.prodname_vscode }} that is available in the [`vscode-dev-containers`](https://github.com/microsoft/vscode-dev-containers) repository. Pre-built container definitions include a common configuration for a particular project type, and can help you quickly get started with a configuration that already has the appropriate container options, {{ site.data.variables.product.prodname_vscode }} settings, and {{ site.data.variables.product.prodname_vscode }} extensions that should be installed.
|
|
|
|
1. Clone or download the [`vscode-dev-containers`](https://github.com/microsoft/vscode-dev-containers) repository.
|
|
1. In the `vscode-dev-containers` repository, navigate to the [`containers`](https://github.com/microsoft/vscode-dev-containers/tree/master/containers) folder, then choose a container configuration for your project's needs. We'll use the [Node.js & JavaScript](https://aka.ms/vscode-dev-containers/definitions/node) container configuration as an example.
|
|
1. From the [`Node.js & JavaScript`](https://aka.ms/vscode-dev-containers/definitions/node) folder, copy the `.devcontainer` folder to the root of your project's repository.
|
|
1. Commit and push the new configuration to your project's repository on {{ site.data.variables.product.prodname_dotcom }}.
|
|
|
|
Each new codespace created from a branch which contains the `.devcontainer` folder will be configured according to the folder's contents. For more information, see "[Creating a codespace](/github/developing-online-with-codespaces/creating-a-codespace)."
|
|
|
|
### Creating a custom codespace configuration
|
|
|
|
If none of the pre-built configurations meet your needs, you can create a custom configuration by adding a `devcontainer.json` file to the root of your repository or a `.devcontainer` folder. In the file, you can use supported configuration keys to specify aspects of the codespace's environment, like which {{ site.data.variables.product.prodname_vscode }} extensions will be installed.
|
|
|
|
{{ site.data.reusables.codespaces.vscode-settings-order }}
|
|
|
|
You can define default editor settings for {{ site.data.variables.product.prodname_vscode }} in two places.
|
|
|
|
* Editor settings defined in `.vscode/settings.json` are applied as _Workspace_-scoped settings in the codespace.
|
|
* Editor settings defined in the `settings` key in `devcontainer.json` are applied as _Remote [Codespaces]_-scoped settings in the codespace.
|
|
|
|
### Supported codespace configuration keys
|
|
|
|
You can use configuration keys supported by {{ site.data.variables.product.prodname_codespaces }} in `devcontainer.json`.
|
|
|
|
#### General settings
|
|
|
|
- `name`
|
|
- `settings`
|
|
- `extensions`
|
|
- `forwardPorts`
|
|
- `devPort`
|
|
- `postCreateCommand`
|
|
|
|
#### Docker, Dockerfile, or image settings
|
|
|
|
- `image`
|
|
- `dockerFile`
|
|
- `context`
|
|
- `containerEnv`
|
|
- `remoteEnv`
|
|
- `containerUser`
|
|
- `remoteUser`
|
|
- `updateRemoteUserUID`
|
|
- `mounts`
|
|
- `workspaceMount`
|
|
- `workspaceFolder`
|
|
- `runArgs`
|
|
- `overrideCommand`
|
|
- `shutdownAction`
|
|
- `dockerComposeFile`
|
|
|
|
For more information about the available settings for `devcontainer.json`, see [devcontainer.json reference](https://aka.ms/vscode-remote/devcontainer.json) in the {{ site.data.variables.product.prodname_vscode }} documentation.
|