From db9e90484fec97ed96046582ec6467c27651cede Mon Sep 17 00:00:00 2001 From: Monique Rio Date: Thu, 16 Jun 2022 12:00:53 -0400 Subject: [PATCH] docs: update README adds instructions for how bundle install the sftp gem --- .env-example | 1 + README.md | 7 +++++++ 2 files changed, 8 insertions(+) create mode 100644 .env-example diff --git a/.env-example b/.env-example new file mode 100644 index 0000000..22d416d --- /dev/null +++ b/.env-example @@ -0,0 +1 @@ +BUNDLE_RUBYGEMS__PKG__GITHUB__COM="Your Github Personal Access Token with read:packages access" diff --git a/README.md b/README.md index 0f3ffef..4e4a3f7 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,13 @@ build web container docker-compose build web ``` +set up your .env file +``` +cp .env-example .env +``` + +Replace the value for `BUNDLE_RUBYGEMS__PKG__GITHUB__COM` in the `.env` file with your [personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) that has `read:packages` access. + bundle install gems to a docker volume ``` docker-compose run --rm web bundle install