> For the complete documentation index, see [llms.txt](https://eth-limo.gitbook.io/documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://eth-limo.gitbook.io/documentation/ipfs-pinning-providers/filebase/using-the-filebase-public-ipfs-gateway.md).

# Using the Filebase Public IPFS Gateway

#### The Filebase public IPFS gateway is: <a href="#the-filebase-public-ipfs-gateway-is" id="the-filebase-public-ipfs-gateway-is"></a>

`https://ipfs.filebase.io/ipfs/<CID>`

The Filebase Public IPFS Gateway has an effective rate limit of 200 RPM (requests per minute).

The Filebase Public IPFS Gateway only serves content stored on Filebase.

Gateways can serve the CID of a folder instead of just a single file. In this scenario, it will return a file directory tree that contains the files located in the folder.

For example, the following IPFS gateway URL leads to a folder directory of files:

`https://ipfs.filebase.io/ipfs/QmWTqpfKyPJcGuWWg73beJJiL6FrCB5yX8qfcCF4bHvane`

Gateways can also be used to serve static websites. The following URL leads to a static webpage, hosted on IPFS using a folder containing a static HTML file and image files:

`https://ipfs.filebase.io/ipfs/QmYRpH3myNKG2XeaBmdidec3R5HcF9PYBHUVHfks5ysTpq/`

For background on how gateways retrieve content and the difference between public, dedicated, and self-hosted gateways, see [IPFS Gateways](/documentation/ipfs/ipfs-gateways.md).

## Creating a Dedicated Gateway <a href="#creating-a-dedicated-gateway" id="creating-a-dedicated-gateway"></a>

Navigate to the [Gateways page](https://console.filebase.com/gateways) on the Filebase web console.

Select the ‘Create Gateway’ button in the upper right corner.

<figure><img src="https://3012111568-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fn4PkwKyPvID2082agde0%2Fuploads%2Fgit-blob-2b34603941cb6283bfddd0359d0183082c28f359%2Ffilebase-19.png?alt=media" alt=""><figcaption></figcaption></figure>

A new window will open prompting you to provide a gateway name and select the gateway’s access level.

Gateway names are subject to the same naming restrictions as bucket names. All gateway names must be lowercase, between 3-63 characters, and must be unique.

<figure><img src="https://3012111568-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fn4PkwKyPvID2082agde0%2Fuploads%2Fgit-blob-450accf10a1e86a46d1a05e10c3df2dc3463b027%2Ffilebase-20.png?alt=media" alt=""><figcaption></figcaption></figure>

Gateways can be public, private, or scoped.

#### Public Gateways <a href="#public-gateways" id="public-gateways"></a>

To create a public gateway, select ‘Public’. This can be changed after the gateway has been created.

<figure><img src="https://3012111568-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fn4PkwKyPvID2082agde0%2Fuploads%2Fgit-blob-2d0c212ace41696be5a30a84156823b73845add8%2Ffilebase-21.png?alt=media" alt=""><figcaption></figcaption></figure>

#### Private Gateways <a href="#private-gateways" id="private-gateways"></a>

To create a private gateway, select ‘Private’. This can be changed after the gateway has been created.

<figure><img src="https://3012111568-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fn4PkwKyPvID2082agde0%2Fuploads%2Fgit-blob-87a7ba411f15b40d740bd6c3742b7198247fe44c%2Ffilebase-22.png?alt=media" alt=""><figcaption></figcaption></figure>

#### Scoped Gateways <a href="#scoped-gateways" id="scoped-gateways"></a>

To create a scoped gateway, select ‘Private’, then select a bucket name from the drop-down menu for the scoped gateway to serve. Scoped gateways only serve content located in the bucket that they are restricted to.

Note: If a gateway is configured to serve a root CID, it cannot also be configured to be restricted to a bucket. The root CID configuration must be cleared to configure a bucket restriction.

<figure><img src="https://3012111568-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fn4PkwKyPvID2082agde0%2Fuploads%2Fgit-blob-66a7b5041105f5ef54389ad920856d1cdb4f2a21%2Ffilebase-23.png?alt=media" alt=""><figcaption></figcaption></figure>

Alternatively, if you want to set a bucket restriction for a gateway that was previously created, you can set the restriction by navigating to the [Buckets](https://console.filebase.com/buckets) menu and selecting the three menu dots for the bucket you’d like to restrict your gateway to. Then select ‘Set Restriction’.

<figure><img src="https://3012111568-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fn4PkwKyPvID2082agde0%2Fuploads%2Fgit-blob-0cdce64f7b5ee394c97b737b57d9a00b3aa4554c%2Ffilebase-24.png?alt=media" alt=""><figcaption></figcaption></figure>

When prompted, select the gateway you want configured to use the selected bucket.

<figure><img src="https://3012111568-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fn4PkwKyPvID2082agde0%2Fuploads%2Fgit-blob-925728c3b3686086ba3b63829417cc0065688dcd%2Ffilebase-25.png?alt=media" alt=""><figcaption></figcaption></figure>

#### Removing a Bucket Restriction <a href="#removing-a-bucket-restriction" id="removing-a-bucket-restriction"></a>

To remove the bucket restriction on a gateway, navigate to the [Gateways](https://console.filebase.com/gateways) page, select the three menu dots on the right-hand side, then select ‘Clear Bucket Restrictions'

<figure><img src="https://3012111568-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fn4PkwKyPvID2082agde0%2Fuploads%2Fgit-blob-c49f4234660a0b64ee54fea8749f09a9ca80e02c%2Ffilebase-26.png?alt=media" alt=""><figcaption></figcaption></figure>

You will be prompted to confirm the removal.

<figure><img src="https://3012111568-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fn4PkwKyPvID2082agde0%2Fuploads%2Fgit-blob-4d824e66ff3937f83d8f976b3de5bd50d6b20f97%2Ffilebase-27.png?alt=media" alt=""><figcaption></figcaption></figure>

#### Interacting With Gateways <a href="#interacting-with-gateways" id="interacting-with-gateways"></a>

Once a gateway has been created, a subdomain record is created that points to your dedicated gateway. For example, the dedicated gateway called 'documentation' will use the gateway URL:

<https://documentation.myfilebase.com/>

**Toggling Private/Public Access**

To toggle between public and private access for a dedicated gateway, use the toggle switch that functions identically to the public and private access toggle switch for buckets.

<figure><img src="https://3012111568-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fn4PkwKyPvID2082agde0%2Fuploads%2Fgit-blob-de70de485f35cabf95490bb78fcb462c931995ee%2Ffilebase-28.png?alt=media" alt=""><figcaption></figcaption></figure>

To interact with the gateway, you can select the three menu dots to open a list of options.

<figure><img src="https://3012111568-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fn4PkwKyPvID2082agde0%2Fuploads%2Fgit-blob-56bc7d3cc8aa7fa9281ce3c95d3f325578f713b3%2Ffilebase-29.png?alt=media" alt=""><figcaption></figcaption></figure>

To open the gateway URL, select ‘Open’.

<figure><img src="https://3012111568-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fn4PkwKyPvID2082agde0%2Fuploads%2Fgit-blob-765abf279b886302b9479c973d0964c4769d4c2e%2Ffilebase-30.png?alt=media" alt=""><figcaption></figcaption></figure>

By default, the URL will return the following webpage:

<figure><img src="https://3012111568-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fn4PkwKyPvID2082agde0%2Fuploads%2Fgit-blob-31deb5fbfd8326dc6cab92e6b80292f77590eb6d%2Ffilebase-31.png?alt=media" alt=""><figcaption></figcaption></figure>

This webpage is returned since there is no CID included in the URL. However, gateways can be configured to serve a CID or file as its root. This means instead of this default webpage, you can configure a different default static webpage or another file to be viewed by default rather than this error message.

This is most commonly used to serve static websites from a domain. Using this feature, <http://documentation.myfilebase.com/> would return the file you selected, without having to enter a CID or path in the URL.

## Setting a CID as the Root of the Dedicated Gateway <a href="#setting-a-cid-as-the-root-of-the-dedicated-gateway" id="setting-a-cid-as-the-root-of-the-dedicated-gateway"></a>

Note: If a gateway is configured to be restricted to a bucket, it cannot be configured to have a root CID. The bucket restriction configuration will need to be cleared before a root CID can be configured for the gateway.

To configure this, navigate to the [Buckets](https://console.filebase.com/buckets) menu, and select an IPFS bucket.

<figure><img src="https://3012111568-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fn4PkwKyPvID2082agde0%2Fuploads%2Fgit-blob-e068f28e7333c603f4844a7c60903ddf06875c7b%2Ffilebase-32.png?alt=media" alt=""><figcaption></figcaption></figure>

Once inside the bucket, select the file you’d like to set as the root file by selecting the three menu dots on the right-hand side.

<figure><img src="https://3012111568-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fn4PkwKyPvID2082agde0%2Fuploads%2Fgit-blob-caec9c00c36800065a18259242274422bfdd8a8e%2Ffilebase-33.png?alt=media" alt=""><figcaption></figcaption></figure>

Select ‘Set as Root’.

<figure><img src="https://3012111568-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fn4PkwKyPvID2082agde0%2Fuploads%2Fgit-blob-9ca9c8a9a06fd98b42b4df4bcb628b584547e3d0%2Ffilebase-34.png?alt=media" alt=""><figcaption></figcaption></figure>

Then choose the dedicated gateway you’d like to use.

<figure><img src="https://3012111568-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fn4PkwKyPvID2082agde0%2Fuploads%2Fgit-blob-382b6c848d6193e064b0e9ff6687b342f692578a%2Ffilebase-35.png?alt=media" alt=""><figcaption></figcaption></figure>

Now, when you open the gateway, you’ll see the file you set as the root file displayed rather than the default error message.

<figure><img src="https://3012111568-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fn4PkwKyPvID2082agde0%2Fuploads%2Fgit-blob-b42311edeeee50f75241b531c776915196b7fa96%2Ffilebase-36.png?alt=media" alt=""><figcaption></figcaption></figure>

#### Removing a Root CID From a Gateway <a href="#removing-a-root-cid-from-a-gateway" id="removing-a-root-cid-from-a-gateway"></a>

To remove a CID set as the root CID for a dedicated gateway, navigate to the [Gateways](https://console.filebase.com/gateways) page, then select the three menu dots and select ‘Clear Root CID’.

<figure><img src="https://3012111568-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fn4PkwKyPvID2082agde0%2Fuploads%2Fgit-blob-7d2f848875cdeaa59a0dfae561f9980914816c36%2Ffilebase-37.png?alt=media" alt=""><figcaption></figcaption></figure>

You will be prompted to confirm the removal.

<figure><img src="https://3012111568-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fn4PkwKyPvID2082agde0%2Fuploads%2Fgit-blob-6f66808abf60b03ebdf4c3b072be0c7269ab56c1%2Ffilebase-38.png?alt=media" alt=""><figcaption></figcaption></figure>

#### Deleting a Gateway <a href="#deleting-a-gateway" id="deleting-a-gateway"></a>

To delete a dedicated gateway, navigate to the [Gateways](https://console.filebase.com/gateways) page in the Filebase web console dashboard.

<figure><img src="https://3012111568-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fn4PkwKyPvID2082agde0%2Fuploads%2Fgit-blob-4943e70b867f8152c12a8aa829383876ca08bc9a%2Ffilebase-39.png?alt=media" alt=""><figcaption></figcaption></figure>

Select the options menu by clicking the three dots on the right-hand side corresponding with the gateway you want to remove. Then select ‘Delete’.

<figure><img src="https://3012111568-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fn4PkwKyPvID2082agde0%2Fuploads%2Fgit-blob-c29183d2871572a14f4de4efe69ccf16aa0eb657%2Ffilebase-40.png?alt=media" alt=""><figcaption></figcaption></figure>

You will be prompted to confirm the removal.

### **Filebase IPFS Image Optimization** <a href="#filebase-ipfs-image-optimization" id="filebase-ipfs-image-optimization"></a>

Filebase provides an image optimization functionality directly through the Filebase IPFS dedicated gateway feature.

Through this feature, image load time and the overall image experience can be improved.

Any image file that is uploaded to Filebase can be manipulated through query string parameters. To utilize image optimization, at least one option must be specified:

* **Resize**:

  ```
  ?img-width=300
  ```
* **Quality**:

  ```
  ?img-quality=75
  ```
* **Format**:

  ```
  ?img-format=auto
  ```

For example, if the default image URL is:

`https://documentation.myfilebase.com/ipfs/QmVnf5PnSUvjrPkc9tDgpwqcreKWh7xVyXDwDmS6xwchWp`

the resized variant is:

```
https://documentation.myfilebase.com/ipfs/QmVnf5PnSUvjrPkc9tDgpwqcreKWh7xVyXDwDmS6xwchWp?img-width=300
```

You can [sign up](https://filebase.com/signup) for a free Filebase account to get started with IPFS today.