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.

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

bug: connection string example is inconsistent with implementation #717

Closed
houz42 opened this issue Aug 23, 2021 · 4 comments
Closed

bug: connection string example is inconsistent with implementation #717

houz42 opened this issue Aug 23, 2021 · 4 comments

Comments

@houz42
Copy link

houz42 commented Aug 23, 2021

The document shows an example connection string:

s3://?credential=hmac:xxxx:xxxx&endpoint=http://s3.us-east-2.amazonaws.com

While the endpoint in it will not be parsed correctly by the s3 service.
The s3 service uses go-endpoint to parse the endpoint value, which defines endpoints as the form of http:s3.us-east-2.amazonaws.com, no // after the http:

I am using:

  • go-storage: v4.4.1
  • s3-service: v2.3.0

By the way, I'am happy to fix it, but not sure which solution is preferred:

  • make go-endpoint respect the // notation,
  • or update the doc
@Xuanwo
Copy link
Contributor

Xuanwo commented Aug 23, 2021

Oooops, our docs is incorrect.

We need to use http:s3.us-east-2.amazonaws.com here.

Can you send a PR to site to fix it? Thanks so much!

@Xuanwo
Copy link
Contributor

Xuanwo commented Aug 23, 2021

And the problem is so common that we are considering add support for :// too.

Tracked at beyondstorage/go-endpoint#15

@Xuanwo
Copy link
Contributor

Xuanwo commented Aug 23, 2021

For your convenience: the docs located at https://github.com/beyondstorage/site/blob/master/docs/go-storage/operations/index.md

GitHub
Source files of https://beyondstorage.io. Contribute to beyondstorage/site development by creating an account on GitHub.

houz42 added a commit to houz42/site that referenced this issue Aug 24, 2021
Xuanwo pushed a commit to beyondstorage/site that referenced this issue Aug 24, 2021
* fix incorrect connection string example

see beyondstorage/go-storage#717 for more details.

* fix second example
@Xuanwo
Copy link
Contributor

Xuanwo commented Aug 24, 2021

Fixed in beyondstorage/site#192, thanks for report!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants