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

Documentation for cloud storage function #66

Merged
merged 4 commits into from
Feb 4, 2023

Conversation

Shofiya2003
Copy link
Collaborator

Added documentation for cloud storage function including details to configure cloud storage accounts.
Closes #47

@Shofiya2003
Copy link
Collaborator Author

uploader := utils.GetUploader(constants.CLOUD_CONTAINER_NAME, video.ID)

Here, we are storing the Azure container name in constants. Shouldn't we use an env variable for it?
@abhishekraj272 @uzaxirr

@Shofiya2003 Shofiya2003 requested review from abskrj and uzaxirr January 30, 2023 15:18
@uzaxirr
Copy link
Member

uzaxirr commented Jan 30, 2023

No, Container name isn't some security key or any much confidential info which could be used to gain access. Such things should be stored in constants i believe.

@Shofiya2003
Copy link
Collaborator Author

Right. But does the user set the container name (or it stays the same for every user) or they just provide the credentials? @uzaxirr

@uzaxirr
Copy link
Member

uzaxirr commented Jan 30, 2023

Right. But does the user set the container name (or it stays the same for every user) or they just provide the credentials? @uzaxirr

It's customisable, currently it stays the same (the value mentioned in constant) but if someone wants to change for their self-hosted instance they can do so by editing the constant's value in their fork

@Shofiya2003
Copy link
Collaborator Author

Alrighty. Then we should not create it as an env variable. Thank you for the explanation.

AWS_S3_BUCKET_NAME: "AWS_S3_BUCKET_NAME",

Shouldn't we have the s3 bucket name and region as constants too?

@abskrj
Copy link
Member

abskrj commented Feb 1, 2023

@Shofiya2003 bucket name and region should be configurable from user side, cos bucket name is unique and people can deploy it on any region so, should be set by user only.

Container inside the bucket is generated by the code and can be common on every bucket. Container is just a folder inside the bucket.

@Shofiya2003
Copy link
Collaborator Author

Okay
Do you want me to make any changes to the doc?
@abhishekraj272 @uzaxirr

Copy link
Member

@uzaxirr uzaxirr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!
This is a good starting point. We can improve and iterate over it later on as well

@uzaxirr uzaxirr merged commit 4f95245 into ZeStream:dev Feb 4, 2023
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

Successfully merging this pull request may close these issues.

Document setting up Cloud Storage
3 participants