https://github.com/gera2ld/ipfs-editor-vscode
IPFS editor as a VSCode extension
https://github.com/gera2ld/ipfs-editor-vscode
Last synced: 9 months ago
JSON representation
IPFS editor as a VSCode extension
- Host: GitHub
- URL: https://github.com/gera2ld/ipfs-editor-vscode
- Owner: gera2ld
- License: mit
- Created: 2022-07-09T12:27:55.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-10-18T14:09:14.000Z (almost 4 years ago)
- Last Synced: 2025-01-15T05:52:53.315Z (over 1 year ago)
- Language: TypeScript
- Size: 379 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# IPFS Editor for VSCode
The is a VSCode extension to load and edit files on IPFS.
## Features
- [x] Import file/directory by CID
- [x] Import file/directory by IPNS
- [x] Edit/save file
- [x] Upload new CAR to web3.storage
- [x] Publish with DNSLink
## Settings
Open Settings and filter by `IPFS`, you'll see the settings below.
### Endpoint
The API address to your IPFS node, `http://127.0.0.1:5001` by default.
Note that you need to start your local IPFS daemon before you can connect to its endpoint.
### Publish Config
The configuration for publishing nodes.
```json
{
"web3StorageToken": "...",
"dnsConfig": {
"cloudflare": {
"token": "..."
}
},
"domainProvider": {
"mydomain.com": "cloudflare"
}
}
```
- Get your own [web3.storage](https://web3.storage) token.
- Only `cloudflare` is supported at the moment, set your token here to support DNSLink.
- `domainProvider` is a mapping between your top-level domain and its provider. Only `cloudflare` is supported at the moment.
## Usage
- Open command palette and search `IPFS`
- Edit files like in local file system
- Upload and publish new changes with a click
### How to add a domain?
- Link a directory to a domain:
- Create a file named `CNAME` with the desired domain as its content.
- Put it in the directory which is supposed to be linked to this domain.
Example:
```
.
└── blog/
├── CNAME # content: awesome.com
├── index.html
└── another-file
```
When publishing `blog`, its CID will be linked to `awesome.com` if its provider is properly configured.
- Link a file to a domain:
- Create a file with a name of the target file suffixed with `.CNAME`, and fill its content with the desired domain.
- Put the file in the same directory as the target file.
Example:
```
.
└── anywhere/
├── target.html
└── target.html.CNAME # content: awesome.com
```