Skip to content
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

Jump to bottom

Update README file #22

Merged
merged 3 commits into from
Jul 5, 2024
Merged

Update README file #22

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ca0b5c8
update README file with local dev configuration
DenisaCG Jul 5, 2024
09185ea
update info
DenisaCG Jul 5, 2024
9f93ac5
lint extension
DenisaCG Jul 5, 2024
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
2 changes: 1 addition & 1 deletion .env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
JP_S3_BUCKET=<S3 Bucket Name>
JP_S3_ROOT=<Path to directory within S3 Bucket to act as root>
JP_S3_ROOT=<Path to directory within S3 Bucket to act as root (optional)>
JP_S3_REGION=<S3 Bucket Region>
JP_S3_ENDPOINT=<S3 Custom Endpoint>
JP_S3_ACCESS_KEY_ID=<S3 Access Key ID / IAM Access Key ID>
Expand Down
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,14 @@ By default, the `jlpm build` command generates the source maps for this extensio
jupyter lab build --minimize=False
```

### Local enviroment variables

For the local development of the extension, enviroment variables are used to define the required bucket name, region and endpoint, as well as the access key id and secret key, with the additional possibility of defining a different root folder.

Rename the `.env.example` file to `.env` and update it with the values needed for your local configuration.

Note: Unless configured differently, the `S3` bucket endpoint should follow the format: `https://s3.<bucket-region>.amazonaws.com`.

### Development uninstall

```bash
Expand Down
Loading