Skip to content

Commit

Permalink
chore: rename to ipfs/go-ipfs-redirects-file
Browse files Browse the repository at this point in the history
  • Loading branch information
lidel committed Sep 15, 2022
1 parent 98d0bad commit 4946b03
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# IPFS Redirects Parser
# IPFS `_redirects` File Parser

**Experimental**
Parser for the IPFS HTTP Gateway's `_redirects` file format.
This is a parser for the IPFS Web Gateway's `_redirects` file format.

Currently this is a subset of Netlify's [redirects format](https://www.netlify.com/docs/redirects/).
The details of the supported functionality are still in flux and will eventually be included in a [spec](https://github.com/ipfs/specs).
## Specification

Follow specification work at https://github.com/ipfs/specs/pull/290

## Format
Currently only supports `from`, `to` and `status`.
Expand All @@ -31,8 +31,8 @@ from to [status]
# Rewrite a path
/pass-through /index.html 200

# Show a custom 404 for this path
/ecommerce /store-closed 404
# Show a custom 404 for everything under this path
/ecommerce/* /store-closed 404

# Single page app rewrite
/* /index.html 200
Expand All @@ -44,4 +44,4 @@ from to [status]
---

## Credit
This project was forked from [tj/go-redirects](https://github.com/tj/go-redirects). Thank you TJ for the initial work. 🙏
This project was forked from [tj/go-redirects](https://github.com/tj/go-redirects). Thank you TJ for the initial work. 🙏
2 changes: 1 addition & 1 deletion go.mod
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
module github.com/ipfs-shipyard/go-ipfs-redirects
module github.com/ipfs/go-ipfs-redirects-file

go 1.18

Expand Down

0 comments on commit 4946b03

Please sign in to comment.