Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/storacha/add-to-web3
⁂ Github Action to upload files to web3.storage
https://github.com/storacha/add-to-web3
deploy filecoin ipfs web3
Last synced: 3 months ago
JSON representation
⁂ Github Action to upload files to web3.storage
- Host: GitHub
- URL: https://github.com/storacha/add-to-web3
- Owner: storacha
- License: mit
- Created: 2021-07-16T11:27:09.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-01-18T10:53:01.000Z (about 1 year ago)
- Last Synced: 2024-09-15T15:58:34.701Z (4 months ago)
- Topics: deploy, filecoin, ipfs, web3
- Homepage:
- Size: 750 KB
- Stars: 51
- Watchers: 1
- Forks: 30
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# add-to-web3
Upload files to [web3.storage](https://web3.storage) from a Github Action, and output the IPFS Content ID.
A lightweight wrapper around [w3cli]. As a [composite](https://docs.github.com/en/actions/creating-actions/creating-a-composite-action) github action all it does is configure and call the cli for you. See the steps in [./action.yml](./action.yml).
## Usage
```yaml
uses: web3-storage/add-to-web3@v3
id: w3up
with:
path_to_add: 'dist'
proof: ${{ secrets.W3_PROOF }}
secret_key: ${{ secrets.W3_PRINCIPAL }}
# use the outputs in subsequent steps
# "bafkreicysg23kiwv34eg2d7qweipxwosdo2py4ldv42nbauguluen5v6am"
- run: echo ${{ steps.w3up.outputs.cid }}
# "https://bafkreicysg23kiwv34eg2d7qweipxwosdo2py4ldv42nbauguluen5v6am.ipfs.w3s.link"
- run: echo ${{ steps.w3up.outputs.url }}
```
### Generating a `secret_key` and `proof`
On your dev machine, use [w3cli] to generate a `secret_key` and `proof` to allow this action to upload to a space.
Install it from npm and login as described here https://web3.storage/docs/quickstart/ then create a key like this:
```shell
# Use the `did` in the input to the next command.
# Use `key` as your `secret_key` for add_to_web3.
$ w3 key create --json
{
"did": "did:key:z6Mk...",
"key": "MgCaT7Se2QX9..."
}
```
Keep the `key` safe. Save it as a secret on your repo.
Copy the `did` for use in the next command. The output is a base64 encoded ucan `proof` that delegates capabilities to `store/add` and `upload/add` on your current space to the key generated above.
```shell
# Delegate capabilities to the `did` we created above.
$ w3 delegation create did:key:z6Mk... -c 'store/add' -c 'upload/add' --base64
mAYIEAP8OEaJlcm9vdHOAZ3ZlcnNpb24BwwUBcRIg+oHTbzShh1WzBo9ISkonCW+KAcy/+zW8Zb...
```
The capabilies `store/add` and `upload/add` are the minimum required to upload files to web3.storage. This proof will not allow that key to list uploads in this space for example.
To recap:
- Use the `key` value from the output of `w3 key create --json` as the `secret_key` for this action.
- Use the `did` value from that output as the audience for `w3 delegation create ` shown above.
- Use the output of `w3 delegation create --base64` as the `proof` for this action.
## Inputs
### `path_to_add`
**Required** The path the root directory of your static website or other content that you want to publish to IPFS.
### `secret_key`
**Required** The base64 encoded key to use to sign UCAN invocations to web3.storage.
Create one using `w3 key create`. See: https://github.com/web3-storage/w3cli#w3_principal
### `proof`
**Required** A base64 encoded UCAN delegating capabilities the signing key above.
Create a proof using w3cli, delegating `store/add' and `upload/add`
```shell
$ AUDIENCE_DID=""
$ w3 delegation create $AUDIENCE_DID -c 'store/add' -c 'upload/add' --base64`
```
Show advanced options: hidden, wrap
### `hidden`
_Default_ `false`
Should hidden files prefixed with a `.` be included when found in the `path_to_add`
see: See: https://github.com/web3-storage/w3cli#w3-up-path-path
### `wrap`
_Default_ `true`
If `path_to_add` points to a file it will be wrapped in a directory to preserve the filename. To disable that set wrap: "true".
See: https://github.com/web3-storage/w3cli#w3-up-path-path
## Outputs
### `cid`
The IPFS content ID for the directory on IPFS.
e.g. `bafkreicysg23kiwv34eg2d7qweipxwosdo2py4ldv42nbauguluen5v6am`
### `url`
The IPFS gateway URL for the directory
e.g. `https://dweb.link/ipfs/bafkreicysg23kiwv34eg2d7qweipxwosdo2py4ldv42nbauguluen5v6am`
## Contributing
💌 Considerate contributions welcome!
⁂
[w3cli]: https://github.com/web3-storage/w3cli