Skip to content

Commit

Permalink
Add sample config. Update readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
jbouder committed May 13, 2024
1 parent dfaf083 commit c39c706
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 11 deletions.
12 changes: 1 addition & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
7 changes: 7 additions & 0 deletions self-registration/dev/config.sample.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
namespace: self-registration
coupons:
- abcdefg
approved_domains:
- metrostar.com
account_expiration_days: 30
registration_group: test-group

0 comments on commit c39c706

Please sign in to comment.