Remove drives. Added section for AWS. (#1145)
* Remove drives. Added section for AWS. * Fix AWS section. * Finished step 1. Began step 2 for AWS S3 bucket hosting. * Finished hosting asset on AWS using S3 bucket storage. * Resolved requested changes for text part. * Deleted one drive screenshots. * Refactored screenshot with the file. * Updated images. * Moved images for hosting services into using ocean market images folder. Moved asset hosting tutorial into using ocean market folder as well.
mariacarmina
GitHub
|
Before Width: | Height: | Size: 13 KiB |
|
Before Width: | Height: | Size: 26 KiB |
|
Before Width: | Height: | Size: 56 KiB |
|
Before Width: | Height: | Size: 192 KiB |
|
Before Width: | Height: | Size: 36 KiB |
|
Before Width: | Height: | Size: 38 KiB |
|
Before Width: | Height: | Size: 38 KiB |
|
Before Width: | Height: | Size: 36 KiB |
|
|
@ -43,7 +43,7 @@ The following guides will help you get started with buying and selling data:
|
|||
|
||||
* [Publish a data asset](using-ocean-market/marketplace-publish-data-asset.md)
|
||||
* [Download a data asset](using-ocean-market/marketplace-download-data-asset.md)
|
||||
* [Publishing with hosting services](building-with-ocean/asset-hosting.md)
|
||||
* [Publishing with hosting services](using-ocean-market/asset-hosting.md)
|
||||
|
||||
### Build Your Own Data Market
|
||||
|
||||
|
|
|
|||
|
|
@ -17,7 +17,7 @@
|
|||
* [Using Ocean Market](using-ocean-market/README.md)
|
||||
* [Publish a Data Asset](using-ocean-market/marketplace-publish-data-asset.md)
|
||||
* [Download a Data Asset](using-ocean-market/marketplace-download-data-asset.md)
|
||||
* [Publishing with Hosting Services](building-with-ocean/asset-hosting.md)
|
||||
* [Publishing with Hosting Services](using-ocean-market/asset-hosting.md)
|
||||
* [Liquidity Pools \[deprecated\]](using-ocean-market/remove-liquidity-using-etherscan.md)
|
||||
* [Building with Ocean](building-with-ocean/README.md)
|
||||
* [Build a Marketplace](building-with-ocean/build-a-marketplace/README.md)
|
||||
|
|
|
|||
|
|
@ -1,150 +0,0 @@
|
|||
---
|
||||
title: Publish assets using hosting services
|
||||
description: Tutorial to publish assets using hosting services like Google Drive and Azure.
|
||||
---
|
||||
|
||||
# Publishing with Hosting Services
|
||||
|
||||
### Overview
|
||||
|
||||
To publish assets on the Ocean Marketplace, publishers must provide a link(an URL) to the file. It is up to the asset publisher to decide where to host the asset. For example, a publisher can store the content on their Google Drive, AWS server, private cloud server, or other third-party hosting services. Through publishing, the URL of the asset is encrypted and stored as a part of DDO on the blockchain. Buyers don't have access directly to the URL, but they interact with the Provider, which decrypts the URL and acts as a proxy to serve the asset. The DDO only stores the location of the file, which is accessed on-demand by the Provider. Implementing a security policy that allows only the Provider to access the URL and blocks requests from other unauthorized actors is recommended. One of the possible ways to achieve this is to allow only the Provider's IP address to access the URL. But, not all hosting services provide this feature. So, the publishers must consider the security features while choosing a hosting service.
|
||||
|
||||
On Ocean Marketplace, a publisher must provide the link to the asset during publish step. Once the asset is published, this link cannot be changed. So, it is essential that the publisher correctly sets this field (shown in the below image).
|
||||
|
||||
|
||||
|
||||
### Hosting services
|
||||
|
||||
Publishers can choose any hosting service of their choice. The below section explains how to use commonly used hosting services with Ocean Marketplace.
|
||||
|
||||
#### Google Drive
|
||||
|
||||
Google Drive allows users to share files/folders with various access policies. Publishers must set the access policy such that anyone with the link can download the file when using Ocean Marketplace with Ocean Protocol's default [Provider](https://v4.provider.mumbai.oceanprotocol.com).
|
||||
|
||||
**Step 1 - Get link**
|
||||
|
||||
Open https://drive.google.com and upload the file you want to publish on the Ocean Marketplace. Right-click on the uploaded file and click the `Share` option. Set the file access policy correctly and click the `Copy link` button.
|
||||
|
||||
The file URL will be of the form `https://drive.google.com/file/d/<FILE-ID>/view?usp=sharing`, where the `<FILE-ID>` is the unique alphanumeric string. Verify if the URL is correct by entering it in a browser and check if the file is downloaded.
|
||||
|
||||
|
||||
|
||||
**Step 2 - Create a downloadable link**
|
||||
|
||||
If you paste the copied URL into the browser, it will load an HTML page. Directly pasting the link on the publish page will publish the HTML page instead of a downloadable file URL. So, let's make a downloadable file URL.
|
||||
|
||||
Note the `<FILE-ID>` from step 1 and create a URL as below.
|
||||
|
||||
`https://drive.google.com/uc?export=download&id=<FILE-ID>`
|
||||
|
||||
**Step 3 - Publish the asset using the generated link**
|
||||
|
||||
After creating a downloadable file URL, fill the `File*` field with the downloadable URL created in step 2.
|
||||
|
||||
|
||||
|
||||
_Note: Google Drive allows only shared files to be downloaded, as shown in the above steps. The above method does not work with the shared folder. As a workaround, publishers can upload a zip of a folder and upload it as a file._
|
||||
|
||||
***
|
||||
|
||||
#### Azure storage
|
||||
|
||||
Azure provides various options to host data and multiple configuration possibilities. Publishers are required to do their research and decide what would be the right choice. The below steps provide one of the possible ways to host data using Azure storage and publish it on Ocean Marketplace.
|
||||
|
||||
**Prerequisite**
|
||||
|
||||
Create an account on [Azure](https://azure.microsoft.com/en-us/). Users might also be asked to provide payment details and billing addresses that are out of this tutorial's scope.
|
||||
|
||||
**Step 1 - Create a storage account**
|
||||
|
||||
**Go to Azure portal**
|
||||
|
||||
Go to the Azure portal: https://portal.azure.com/#home and select `Storage accounts` as shown below.
|
||||
|
||||
|
||||
|
||||
**Create a new storage account**
|
||||
|
||||
|
||||
|
||||
**Fill in the details**
|
||||
|
||||
|
||||
|
||||
**Storage account created**
|
||||
|
||||
|
||||
|
||||
**Step 2 - Create a blob container**
|
||||
|
||||
|
||||
|
||||
**Step 3 - Upload a file**
|
||||
|
||||
|
||||
|
||||
**Step 4 - Share the file**
|
||||
|
||||
**Select the file to be published and click Generate SAS**
|
||||
|
||||
|
||||
|
||||
**Configure the SAS details and click `Generate SAS token and URL`**
|
||||
|
||||
|
||||
|
||||
**Copy the generated link**
|
||||
|
||||
|
||||
|
||||
**Step 5 - Publish the asset using the generated link**
|
||||
|
||||
Now, copy and paste the link in the Publish page in the Ocean Marketplace.
|
||||
|
||||
|
||||
|
||||
#### OneDrive
|
||||
|
||||
Create an account on [Microsoft](https://www.microsoft.com/en-us/microsoft-365/onedrive/online-cloud-storage).
|
||||
|
||||
**Step 1 - Upload a file**
|
||||
|
||||
Go to [OneDrive](https://onedrive.live.com/) and upload the file to be published.
|
||||
|
||||
|
||||
|
||||
**Step 2 - Get link**
|
||||
|
||||
After the file is uploaded, right click on the file and click `Embed`, and copy the link.
|
||||
|
||||
|
||||
|
||||
Copy the highlighted content as shown in the below image:
|
||||
|
||||
|
||||
|
||||
The copied content has the following format:
|
||||
|
||||
```html
|
||||
<iframe src="https://onedrive.live.com/embed?cid=<CID>&
|
||||
resid=<RES_ID>%<NUMBER>&
|
||||
authkey=<AUTH_KEY>"
|
||||
width="98" height="120" frameborder="0" scrolling="no">
|
||||
</iframe>
|
||||
```
|
||||
|
||||
**Step 3 - Generate downloadable link**
|
||||
|
||||
Copy the content from `src` field from the `iframe`. The link has the following format: `https://onedrive.live.com/embed?cid=<CID>&resid=<RES_ID>%<NUMBER>&authkey=<AUTH_KEY>`
|
||||
|
||||
Replace the `https://onedrive.live.com/embed` with `https://onedrive.live.com/download` from the above URL.
|
||||
|
||||
The downloadable file URL has the following format: `https://onedrive.live.com/download?cid=<CID>&resid=<RES_ID>%<NUMBER>&authkey=<AUTH_KEY>`
|
||||
|
||||
Enter the URL in the browser and verify if the file is downloaded correctly.
|
||||
|
||||
**Step 4 - Publish the asset using the generated link**
|
||||
|
||||
Copy and paste the link in the Publish page in the Ocean Marketplace.
|
||||
|
||||
|
||||
|
|
@ -11,7 +11,7 @@ The following guides will help you get started with buying and selling data:
|
|||
|
||||
* [Publish a data asset](marketplace-publish-data-asset.md)
|
||||
* [Download a data asset](marketplace-download-data-asset.md)
|
||||
* [Publishing with hosting services](../building-with-ocean/asset-hosting.md)
|
||||
* [Publishing with hosting services](asset-hosting.md)
|
||||
|
||||
If you are new to web3 and blockchain technologies then we suggest you first read these introductory guides:
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,214 @@
|
|||
---
|
||||
title: Publish assets using hosting services
|
||||
description: Tutorial to publish assets using hosting services like AWS and Azure.
|
||||
---
|
||||
|
||||
# Publishing with Hosting Services
|
||||
|
||||
### Overview
|
||||
|
||||
To publish assets on the Ocean Marketplace, publishers must provide a link(an URL) to the file. It is up to the asset publisher to decide where to host the asset. For example, a publisher can store the content on their AWS server, private cloud server, or other third-party hosting services. Through publishing, the URL of the asset is encrypted and stored as a part of DDO on the blockchain. Buyers don't have access directly to the URL, but they interact with the Provider, which decrypts the URL and acts as a proxy to serve the asset. The DDO only stores the location of the file, which is accessed on-demand by the Provider. Implementing a security policy that allows only the Provider to access the URL and blocks requests from other unauthorized actors is recommended. One of the possible ways to achieve this is to allow only the Provider's IP address to access the URL. But, not all hosting services provide this feature. So, the publishers must consider the security features while choosing a hosting service.
|
||||
|
||||
On Ocean Marketplace, a publisher must provide the link to the asset during publish step in the field shown in the below image.
|
||||
|
||||
|
||||
|
||||
### Hosting services
|
||||
|
||||
Publishers can choose any hosting service of their choice. The below section explains how to use commonly used hosting services with Ocean Marketplace.
|
||||
|
||||
Please use a proper hosting solution to keep your files.
|
||||
When using other systems (for example, `Google Drive`) that are not specifically
|
||||
designed for this use case, you risk not gaining traction. Systems such as `Google Drive`,
|
||||
include various virus checks and rate limiters that prevent the `Provider` to download the asset once it was purchased.
|
||||
|
||||
#### AWS
|
||||
|
||||
AWS provides various options to host data and multiple configuration possibilities. Publishers are required to do their research and decide what would be the right choice. The below steps provide one of the possible ways to host data using AWS S3 bucket and publish it on Ocean Marketplace.
|
||||
|
||||
**Prerequisite**
|
||||
|
||||
Create an account on [AWS](https://aws.amazon.com/s3/). Users might also be asked to provide payment details and billing addresses that are out of this tutorial's scope.
|
||||
|
||||
**Step 1 - Create a storage account**
|
||||
|
||||
**Go to AWS portal**
|
||||
|
||||
Go to the AWS portal for S3: https://aws.amazon.com/s3/ and select from the upper right corner `Create an AWS account` as shown below.
|
||||
|
||||
|
||||
|
||||
**Fill in the details**
|
||||
|
||||
)
|
||||
|
||||
**Create a bucket**
|
||||
|
||||
After logging into the new account, search for the available services and select `S3` type of
|
||||
storage.
|
||||
|
||||
|
||||
|
||||
In order to create a S3 bucket, choose `Create bucket`.
|
||||
|
||||
|
||||
|
||||
Fill in the form with the necessary information. Then, the bucket is up & running.
|
||||
|
||||
|
||||
|
||||
**Step 2 - Upload asset on S3 bucket**
|
||||
|
||||
Now, the asset can be uploaded by selecting the bucket name and choose `Upload`
|
||||
in the `Objects` tab.
|
||||
|
||||
|
||||
|
||||
**Add files to the bucket**
|
||||
|
||||
Get the files and add them to the bucket.
|
||||
|
||||
The file is an example used in multiple Ocean repositories, and it can be
|
||||
found [here](https://raw.githubusercontent.com/oceanprotocol/c2d-examples/main/branin_and_gpr/branin.arff).
|
||||
|
||||
|
||||
|
||||
The permissions and properties can be set afterwards, for the moment keep them as default.
|
||||
|
||||
After selecting `Upload`, make sure that the status is `Succeeded`.
|
||||
|
||||
|
||||
|
||||
**Step 3 - Access the Object URL on S3 Bucket**
|
||||
|
||||
By default, the permissions of accessing the file from S3 bucket are set to private.
|
||||
To publish an asset on the market, the S3 URL needs to be public.
|
||||
This step shows how to set up access control policies to grant permissions to others.
|
||||
|
||||
**Editing permissions**
|
||||
|
||||
Go to the `Permissions` tab and select `Edit` and then uncheck `Block all public access`
|
||||
boxes to give everyone read access to the object and click `Save`.
|
||||
|
||||
If editing the permissions is unavailable, modify the `Object Ownership` by enabling the ACLs
|
||||
as shown below.
|
||||
|
||||
|
||||
|
||||
**Modifying bucket policy**
|
||||
|
||||
In order to have the bucket granted on public access, its policy needs to be
|
||||
modified likewise.
|
||||
|
||||
Note that the `<BUCKET-NAME>` must be chosen from personal buckets' dashboard.
|
||||
|
||||
```json
|
||||
{
|
||||
"Version": "2012-10-17",
|
||||
"Statement": [
|
||||
{
|
||||
"Sid": "Public S3 Bucket",
|
||||
"Principal": "*",
|
||||
"Effect": "Allow",
|
||||
"Action": "s3:GetObject",
|
||||
"Resource": "arn:aws:s3:::<BUCKET-NAME>/*"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
After saving the changes, the bucket should appear as `Public` access.
|
||||
|
||||
|
||||
|
||||
**Verify the object URL on public access**
|
||||
|
||||
Select the file from the bucket that needs verification and select `Open`. Now it should
|
||||
be able to download the file on personal system.
|
||||
|
||||
|
||||
|
||||
|
||||
**Step 4 - Get the S3 Bucket Link & Publish Asset on Market**
|
||||
|
||||
Now that the S3 endpoint has public access, the asset will be hosted successfully.
|
||||
|
||||
Go to [Ocean Market](https://market.oceanprotocol.com/publish/1) to complete the form
|
||||
for asset creation.
|
||||
|
||||
Copy the `Object URL` that can be found at `Object Overview` from AWS S3 bucket
|
||||
and paste it in the `File` field from the form found at [step 2](https://market.oceanprotocol.com/publish/2) as it is illustrated below.
|
||||
|
||||
|
||||
|
||||
#### Azure storage
|
||||
|
||||
Azure provides various options to host data and multiple configuration possibilities. Publishers are required to do their research and decide what would be the right choice. The below steps provide one of the possible ways to host data using Azure storage and publish it on Ocean Marketplace.
|
||||
|
||||
**Prerequisite**
|
||||
|
||||
Create an account on [Azure](https://azure.microsoft.com/en-us/). Users might also be asked to provide payment details and billing addresses that are out of this tutorial's scope.
|
||||
|
||||
**Step 1 - Create a storage account**
|
||||
|
||||
**Go to Azure portal**
|
||||
|
||||
Go to the Azure portal: https://portal.azure.com/#home and select `Storage accounts` as shown below.
|
||||
|
||||
|
||||
|
||||
**Create a new storage account**
|
||||
|
||||
|
||||
|
||||
**Fill in the details**
|
||||
|
||||
|
||||
|
||||
**Storage account created**
|
||||
|
||||
|
||||
|
||||
**Step 2 - Create a blob container**
|
||||
|
||||
|
||||
|
||||
**Step 3 - Upload a file**
|
||||
|
||||
|
||||
|
||||
**Step 4 - Share the file**
|
||||
|
||||
**Select the file to be published and click Generate SAS**
|
||||
|
||||
|
||||
|
||||
**Configure the SAS details and click `Generate SAS token and URL`**
|
||||
|
||||
|
||||
|
||||
**Copy the generated link**
|
||||
|
||||
|
||||
|
||||
**Step 5 - Publish the asset using the generated link**
|
||||
|
||||
Now, copy and paste the link in the Publish page in the Ocean Marketplace.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
After Width: | Height: | Size: 8.6 KiB |
|
After Width: | Height: | Size: 9.7 KiB |
|
After Width: | Height: | Size: 16 KiB |
|
After Width: | Height: | Size: 73 KiB |
|
After Width: | Height: | Size: 54 KiB |
|
After Width: | Height: | Size: 14 KiB |
|
After Width: | Height: | Size: 18 KiB |
|
After Width: | Height: | Size: 58 KiB |
|
After Width: | Height: | Size: 43 KiB |
|
After Width: | Height: | Size: 33 KiB |
|
After Width: | Height: | Size: 7.3 KiB |
|
After Width: | Height: | Size: 34 KiB |
|
Before Width: | Height: | Size: 31 KiB After Width: | Height: | Size: 31 KiB |
|
Before Width: | Height: | Size: 146 KiB After Width: | Height: | Size: 146 KiB |
|
Before Width: | Height: | Size: 56 KiB After Width: | Height: | Size: 56 KiB |
|
Before Width: | Height: | Size: 99 KiB After Width: | Height: | Size: 99 KiB |
|
Before Width: | Height: | Size: 51 KiB After Width: | Height: | Size: 51 KiB |
|
Before Width: | Height: | Size: 123 KiB After Width: | Height: | Size: 123 KiB |
|
Before Width: | Height: | Size: 70 KiB After Width: | Height: | Size: 70 KiB |
|
Before Width: | Height: | Size: 42 KiB After Width: | Height: | Size: 42 KiB |
|
Before Width: | Height: | Size: 104 KiB After Width: | Height: | Size: 104 KiB |
|
Before Width: | Height: | Size: 34 KiB After Width: | Height: | Size: 34 KiB |