mirror of
https://codeberg.org/Codeberg/pages-server.git
synced 2024-11-18 10:29:43 +00:00
974229681f
Adds basic support for `_redirects` files. It supports a subset of what IPFS supports: https://docs.ipfs.tech/how-to/websites-on-ipfs/redirects-and-custom-404s/ Example: ``` /redirect https://example.com/ 301 /another-redirect /page 301 /302 https://example.com/ 302 /app/* /index.html 200 /articles/* /posts/:splat 301 ``` 301 redirect: https://video-prize-ranch.localhost.mock.directory:4430/redirect SPA rewrite: https://video-prize-ranch.localhost.mock.directory:4430/app/path/path Catch-all with splat: https://video-prize-ranch.localhost.mock.directory:4430/articles/path/path Closes #46 Co-authored-by: video-prize-ranch <cb.8a3w5@simplelogin.co> Co-authored-by: 6543 <6543@obermui.de> Reviewed-on: https://codeberg.org/Codeberg/pages-server/pulls/148 Reviewed-by: 6543 <6543@obermui.de> Co-authored-by: video-prize-ranch <video-prize-ranch@noreply.codeberg.org> Co-committed-by: video-prize-ranch <video-prize-ranch@noreply.codeberg.org>
45 lines
964 B
Markdown
45 lines
964 B
Markdown
# Features
|
|
|
|
## Custom domains
|
|
|
|
...
|
|
|
|
## Redirects
|
|
|
|
Redirects can be created with a `_redirects` file with the following format:
|
|
|
|
```
|
|
# Comment
|
|
from to [status]
|
|
```
|
|
|
|
* Lines starting with `#` are ignored
|
|
* `from` - the path to redirect from (Note: repository and branch names are removed from request URLs)
|
|
* `to` - the path or URL to redirect to
|
|
* `status` - status code to use when redirecting (default 301)
|
|
|
|
### Status codes
|
|
|
|
* `200` - returns content from specified path (no external URLs) without changing the URL (rewrite)
|
|
* `301` - Moved Permanently (Permanent redirect)
|
|
* `302` - Found (Temporary redirect)
|
|
|
|
### Examples
|
|
|
|
#### SPA (single-page application) rewrite
|
|
|
|
Redirects all paths to `/index.html` for single-page apps.
|
|
|
|
```
|
|
/* /index.html 200
|
|
```
|
|
|
|
#### Splats
|
|
|
|
Redirects every path under `/articles` to `/posts` while keeping the path.
|
|
|
|
```
|
|
/articles/* /posts/:splat 302
|
|
```
|
|
|
|
Example: `/articles/2022/10/12/post-1/` -> `/posts/2022/10/12/post-1/`
|