Skip to content

Update README.md #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.md #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
# Bring your Dotfiles to Gitpod
# Bring your dotfiles to Gitpod
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the title was based on this: Bring your own (Docker) image to Gitpod


Ever wondered how you can bring your personal dotfiles configurations to [Gitpod](https://www.gitpod.io/) to have your personalized ephemeral developer environments in the cloud? Here's how...
This repository shows you how to can bring your personal dotfiles configurations to [Gitpod](https://www.gitpod.io/) to personalize your ephemeral developer environments in the cloud.

## How Does this Repo. Works?
## How does this repository work?

- It has a `./setup.sh` file that contains the initial setup script to execute all the scripts to install/ configure required services under `./scripts/` to keep that X service installed on your next Gitpod Workspaces. For example, it contains following scripts:
- It has a `./setup.sh` file that contains the initial setup script to execute all the scripts to install/ configure required services under `./scripts/` to keep that X service installed on your next Gitpod workspace. For example, it contains the following scripts:
- `./scripts/gpg_configure.sh` is script to configure [GPG](https://www.gnupg.org/) key.
- `./scripts/terraform_configure.sh` is script to setup & configure [Terraform](https://www.terraform.io/).
- `./scripts/aws_cli_install.sh` to install [AWS CLI](https://aws.amazon.com/cli/).
- `./scripts/deno_configure.sh` to install & configure [deno](https://deno.land/).
- `./scripts/gcloud_cli_install.sh` to install [Google Cloud CLI](https://cloud.google.com/sdk/docs/install-sdk).

## How You Can Quickly Use this dotfiles with your Gitpod Workspaces (as template)
## How to use dotfiles with your Gitpod workspaces (as template)

- You Can generate a repo. for you by [using this template](https://github.com/gitpod-io/demo-dotfiles/generate)
- Name your Repo. (e.g.: `dotfiles`).
- You can generate your repository by [using this template](https://github.com/gitpod-io/demo-dotfiles/generate)
- Name your repository (e.g.: `dotfiles`).
- Add your `dotfiles` repository to [Gitpod Dashboard Preferences](https://gitpod.io/preferences)
- Now, everytime you will start a new workspace or just Restart your Gitpod Workspace, you will get your lovely dotfiles customisation setup.
- Now, everytime you will start a new workspace or just restart your Gitpod workspace, you will get your lovely dotfiles customisation setup.

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

Expand All @@ -35,7 +35,7 @@ To modify it out in a new development environment, click the button below:

## Examples

Here are some example `dotfiles` which you can refer:
Here are some example `dotfiles` which you can refer to:

- [webpro/awesome-dotfiles](https://github.com/webpro/awesome-dotfiles)
- [holman/dotfiles](https://github.com/holman/dotfiles)