Dotfiles

Dotfiles are a way to customize your developer environment according to your personal needs.

To configure Gitpod to use your own dotfiles for all your workspaces, enter the URL of a dotfiles repository in your user preferences.

Gitpod will recognize and run one of the following install scripts from your dotfiles repository.

  • install.sh
  • install
  • bootstrap.sh
  • bootstrap
  • script/bootstrap
  • setup.sh
  • setup
  • script/setup

Note: Your installation script will be terminated if it exceeds 120 seconds.

Make sure to make your installation script executable with chmod 755 <install-script-name>.sh before committing and pushing to your dotfiles repository.

If there is no install script, your dotfiles will be symlinked into /home/gitpod.

Example

You can refer this demo-dotfiles template to bring your dotfiles to Gitpod.

The example below has just one dotfile called .bash_aliases. If this file is present in a workspace home directory, it will be found by the ‘.bashrc’ startup script in the Gitpod default image, so no additional install script is required.

.bash_aliases

language icon language: 
bash
echo Hello Gitpod
echo Here is my .bash_aliases dotfile

alias gitsha='git rev-parse HEAD'

Troubleshooting

The dotfiles repository installation logs are saved to /home/gitpod/.dotfiles.log and can be viewed via

language icon language: 
bash
cat /home/gitpod/.dotfiles.log

Was this helpful?