Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

IPIP-280: App Conventions for HTTP Gateway Detection #280

Open
wants to merge 20 commits into
base: main
Choose a base branch
from
Open

IPIP-280: App Conventions for HTTP Gateway Detection #280

Changes from 1 commit
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
d5673ca
Add INTEGRATION document
markg85 May 12, 2022
9630240
Update INTEGRATION.md
markg85 Nov 21, 2022
b23caf5
Merge branch 'ipfs:main' into master
markg85 Nov 21, 2022
f956141
rewrote integration document
markg85 Nov 26, 2022
8a65c2c
Remove drawio files, we're using mermaid now
markg85 Nov 26, 2022
0e8fa0d
follow the template
markg85 Nov 26, 2022
81adfd0
linter fixes
markg85 Nov 26, 2022
ed0fe22
a few more linter fixes
markg85 Nov 26, 2022
0d6b8d6
wip image instead
markg85 Nov 28, 2022
0dd13f2
review feedback and updated to new concepts
markg85 Nov 29, 2022
d362c62
Refer to the new file as gateways (plural).
markg85 Nov 29, 2022
7ce0432
Move integrations document to:
markg85 Dec 8, 2022
9e5cd95
template fixes
markg85 Dec 8, 2022
4d80040
280. Not 180.
markg85 Dec 8, 2022
50b70cf
Add global configuration details
markg85 Dec 11, 2022
c6699f7
Little less bold
markg85 Dec 11, 2022
32b1cfd
Reword the compatibility section and fix some review feedback.
markg85 Sep 25, 2023
3990b3d
Merge branch 'main' into master
markg85 Sep 25, 2023
72cdde2
Merge origin/main into markg85-master
lidel Oct 3, 2023
6ee4e19
ipip-280: update and split into specs and ipip
lidel Oct 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
a few more linter fixes
  • Loading branch information
@markg85
markg85 committed Nov 26, 2022
commit ed0fe2279bef683ae4f9595ffe14a156c9a51296
5 changes: 3 additions & 2 deletions INTEGRATION.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Gateway Integration

![](https://img.shields.io/badge/status-reliable-green.svg?style=flat-square)
![Specification status is reliable](https://img.shields.io/badge/status-reliable-green.svg?style=flat-square)

**Author(s)**:
- [Mark Gaiser](https://github.com/markg85/)
Expand Down Expand Up @@ -77,13 +77,14 @@ The decision tree is influences by a couple environement variables.

### Gateway from command argument

**This feature is optional and only for applications integrating IPFS support.**
**This feature is optional and only for applications integrating IPFS support.**

An application can opt to support a command line option to provide a gateway. If a user does provide this option then it should overrule any other gateway detection and be used as the gateway of choice. If implemented, it's recommended to go for either a `--gateway` or `--ipfs-gateway` argument. It depends very much on the application itself as to which option is most sensible.

An example implementation that is doing this is ffmpeg with the ffplay utility. It allows the `-gateway` argument which by default is empty but can be set like: `-gateway http://127.0.0.1:8080` and would then be used to handle `ipfs://<cid>` or `ipns://<cid>`.

### Gateway from IPFS_GATEWAY environment variable

When there is no command line argument, the `IPFS_GATEWAY` environment is next. If it contains a value, it will be used as gateway.

### Gateway file
Expand Down