mirror of
https://codeberg.org/Codeberg/pages-server.git
synced 2024-11-26 05:55:27 +00:00
7f0a4e5ca9
Reviewed-on: https://codeberg.org/Codeberg/pages-server/pulls/259 Co-authored-by: crapStone <crapstone01@gmail.com> Co-committed-by: crapStone <crapstone01@gmail.com>
52 lines
1.2 KiB
Markdown
52 lines
1.2 KiB
Markdown
# Features
|
|
|
|
## Custom domains
|
|
|
|
Custom domains can be used by creating a `.domains` file with the domain name, e.g.:
|
|
|
|
```text
|
|
codeberg.page
|
|
```
|
|
|
|
You also have to set some DNS records, see the [Codeberg Documentation](https://docs.codeberg.org/codeberg-pages/using-custom-domain/).
|
|
|
|
## Redirects
|
|
|
|
Redirects can be created with a `_redirects` file with the following format:
|
|
|
|
```text
|
|
# 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.
|
|
|
|
```text
|
|
/* /index.html 200
|
|
```
|
|
|
|
#### Splats
|
|
|
|
Redirects every path under `/articles` to `/posts` while keeping the path.
|
|
|
|
```text
|
|
/articles/* /posts/:splat 302
|
|
```
|
|
|
|
Example: `/articles/2022/10/12/post-1/` -> `/posts/2022/10/12/post-1/`
|