1
0
mirror of synced 2025-12-22 11:26:57 -05:00
Files
docs/content/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account.md
Amy Burns c863678e73 New organization for codespaces docs (#18910)
* adding new tables and linking to info on audit logs

* editing some text:

* adding new info on how to add image registry login

* adding link and fixing table

* formatting

* formatting

* Apply suggestions from code review

Co-authored-by: Laura Coursen <lecoursen@github.com>

* updaing private image registry secret info and other improvements

* some minor fixes

* fixing test errors

* rewriting registry secret section

* rewriting registry secret section

* updating link to reflect title

* Update content/github/developing-online-with-codespaces/managing-encrypted-secrets-for-codespaces.md

Co-authored-by: Laura Coursen <lecoursen@github.com>

* updating bullet point

* moving codespaces to top-level item

* fixing duplicated redirect

* Adding some organization for contributors

* adding learning codespaces to index file

* do not error out if category array is empty

* Apply suggestions from code review

Co-authored-by: Kevin Heis <heiskr@users.noreply.github.com>

* fixing broken link

* Document choosing machine type for a codespace in the GitHub UI (#19055)

* Document choosing machine type in the GitHub UI

* Replace link placeholder with actual path

* Update content/codespaces/changing-the-machine-type-for-your-codespace.md

Co-authored-by: Amy Burns <timeyoutakeit@github.com>

Co-authored-by: Amy Burns <timeyoutakeit@github.com>

* reoganizing based on CD

* putting machine type doc in correct location

* fixing broken redirects

* removing quickstart example from index page

* updating main index file

* Fixing broken links

* adding intros

* adding js quickstart (#18960)

* adding js quickstart

* clarify walkthrough

* adding more images and last few sections

* fixing broken links

* fixing broken links and formatting

* formatting fixes

* Apply suggestions from code review

Co-authored-by: hubwriter <hubwriter@github.com>

* adding index file for learn folder

* adding some feedback changes

* adding some review comments

* fixing broken links

Co-authored-by: hubwriter <hubwriter@github.com>

* doing some additional re-org

* fixing topics

* adding Codespaces as a topic

* fixing so title matches slug

* Update data/reusables/codespaces/codespaces-machine-types.md

Co-authored-by: Meg Bird <megbird@github.com>

* expanding intro

Co-authored-by: Laura Coursen <lecoursen@github.com>
Co-authored-by: Sarah Schneider <sarahs@github.com>
Co-authored-by: Kevin Heis <heiskr@users.noreply.github.com>
Co-authored-by: hubwriter <hubwriter@github.com>
Co-authored-by: Meg Bird <megbird@github.com>
2021-05-03 17:06:49 +00:00

4.0 KiB

title, intro, product, permissions, redirect_from, versions, topics
title intro product permissions redirect_from versions topics
Personalizing Codespaces for your account {% data variables.product.prodname_codespaces %} uses your `dotfiles` repository on {% data variables.product.product_name %} to personalize every new codespace that you create. {% data reusables.gated-features.codespaces %} Anyone can create a `dotfiles` repository to personalize {% data variables.product.prodname_codespaces %} for their user account.
/github/developing-online-with-github-codespaces/personalizing-github-codespaces-for-your-account
/github/developing-online-with-codespaces/personalizing-codespaces-for-your-account
free-pro-team
*
Codespaces

{% data reusables.codespaces.release-stage %}

Dotfiles are files and folders on Unix-like systems starting with . that control the configuration of applications and shells on your system. You can store and manage your dotfiles in a repository on {% data variables.product.prodname_dotcom %}. For advice and tutorials about what to include in your dotfiles repository, see GitHub does dotfiles.

If your user account on {% data variables.product.prodname_dotcom %} owns a public repository named dotfiles, {% data variables.product.prodname_dotcom %} automatically uses this repository to personalize your codespace environment. Private dotfiles repositories are not currently supported.

Your dotfiles repository might include your shell aliases and preferences, any tools you want to install, or any other codespace personalization you want to make.

Codespace personalization using your dotfiles repository applies to any codespace you create. Project maintainers can also define a default configuration that applies to every codespace for a repository, created by anyone. {% data reusables.codespaces.codespace-config-order %} For more information, see "Configuring {% data variables.product.prodname_codespaces %} for your project."

When you create a new codespace, {% data variables.product.prodname_dotcom %} clones your dotfiles repository to the codespace environment, and looks for one of the following files to set up the environment.

  • install.sh
  • install
  • bootstrap.sh
  • bootstrap
  • setup.sh
  • setup

If none of these files are found, then any files or folders in dotfiles starting with . are symlinked to the codespace's ~ or $HOME directory.

Any changes to your dotfiles repository will apply only to each new codespace, and do not affect any existing codespace.

{% note %}

Note: Currently, {% data variables.product.prodname_codespaces %} does not support personalizing the User settings for the {% data variables.product.prodname_vscode %} editor with your dotfiles repository. You can set default Workspace and Remote [Codespaces] settings for a specific project in the project's repository. For more information, see "Configuring {% data variables.product.prodname_codespaces %} for your project."

{% endnote %}

You can also configure settings for your user account to add encrypted secrets, enable GPG verification, and allow your codespaces to access other repositories. For more information, see "Managing encrypted secrets for {% data variables.product.prodname_codespaces %}", "Managing GPG verification for {% data variables.product.prodname_codespaces %}", and "Managing access and security for {% data variables.product.prodname_codespaces %}."

Further reading