diff --git a/README.md b/README.md index 9b0db1a..9a0d5dd 100644 --- a/README.md +++ b/README.md @@ -18,17 +18,7 @@ pip install nebari-plugin-self-registration ## Running locally with Docker -_Note_: running locally requires the creation of a `config.yaml` file within the `self-registration/dev` directory. Please create that file with these configurations before proceeding: - -``` -namespace: self-registration -coupons: -- SOME_COUPON_CODE (ex. abcdefg) -approved_domains: -- SOME_EMAIL_DOMAIN (ex. metrostar.com) -account_expiration_days: SOME_NUMBER (ex: 30) -registration_group: SOME_GROUP (ex. test-group) -``` +_Note_: running locally requires a `config.yaml` file to be present within the `self-registration/dev` directory. Please rename the `sample.config.yaml` and update as needed before proceeding: 1. Navigate to the `self-registration` directory 2. To build the docker image, run the following: diff --git a/self-registration/dev/config.sample.yaml b/self-registration/dev/config.sample.yaml new file mode 100644 index 0000000..71c4eb7 --- /dev/null +++ b/self-registration/dev/config.sample.yaml @@ -0,0 +1,7 @@ +namespace: self-registration +coupons: + - abcdefg +approved_domains: + - metrostar.com +account_expiration_days: 30 +registration_group: test-group