https://github.com/trmid/pool-limo
A static gateway service for .pool domains
https://github.com/trmid/pool-limo
Last synced: about 1 year ago
JSON representation
A static gateway service for .pool domains
- Host: GitHub
- URL: https://github.com/trmid/pool-limo
- Owner: trmid
- Created: 2023-02-05T17:14:10.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-02-08T22:17:01.000Z (over 3 years ago)
- Last Synced: 2025-02-09T01:24:13.849Z (over 1 year ago)
- Language: HTML
- Homepage: https://pool.limo
- Size: 2.07 MB
- Stars: 7
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## About
`pool.limo` is a gateway service to serve decentralized websites managed by a `.pool` domain. You can learn more about `.pool` domains at [names.pooly.me](https://names.pooly.me/).
## Limitations
`pool.limo` is inspired by ENS gateways like [eth.limo](https://eth.limo). However, pool.limo takes a different approach to bring operational costs to a minimum. If you're used to using `eth.limo`, here are some of the differences to expect:
| | pool.limo | eth.limo |
|--------------------|--------------------------|--------------------|
| Hosting | static | dynamic |
| Name Resolution | client-side | server-side |
| Content Resolution | IPFS/(IPNS gateway only) | IPFS/IPNS/Skynet |
| SEO Optimized | no | partial |
| Requires JavaScript| yes | no |
| Service Workers | no support | full support |
| Data Collection | none | caches request |
*If there is more demand (and funding) for the advanced features that other gateways offer, they may be added to the pool.limo service in the future.*
## Summary
`pool.limo` is a great service for serving simple decentralized content **FOR FREE** through your `.pool` name, but is not designed for production-grade applications.
# How to Host a Website with pool.limo
## Step 1: Buy a `.pool` domain
- Go to [names.pooly.me](https://names.pooly.me/) and purchase a new name if you don't already have one.
## Step 2: Create a decentralized website
- Create a static website and pin the files to your local IPFS node or on a pinning service like [pinata](https://pinata.cloud).
- If you don't know how to code a static website, you can start by copying and pasting this template into a text editor and saving the file as `index.html`:
```html
Page Title
This is a Heading
This is a paragraph.
```
- You can edit the text that is in-between the tags. Example:
```html
Your text here.
```
- While editing, you can view your changes by opening the `index.html` file with your browser
- Once you are done editing the file, pin it to IPFS.
## Step 3: Set a `content` field on your domain
- After pinning your site to IPFS, copy the IPFS CID of your site and go to [names.pooly.me](https://names.pooly.me/).
- Go to your profile, and click `"Edit domain data"` next to the domain that you want to use.
- Click `"Edit data"` and then click `"Add new field"`. Set the key to `"content"` and the value to `"ipfs://"`.
- Your new field should look similar to this:
`content` -> `ipfs://bafybeicc4mbqa6gi5i3jmmvmf4g56x2z6wjp3tqeos67ity2bjraedk3km`
- Click `"Submit"` to update your domain information with the new content field. The site will prompt you to sign a transaction to complete this step.
## Step 4: View your site!
- Go to `.pool.limo` to view your new decentralized `.pool` site!
- You can update your site at any time by pinning your new site files to IPFS and updating the content CID of your domain.
- Note: It may take up to 10 minutes for changes you make to be updated on your pool.limo site.