1
0
mirror of https://github.com/actix/actix-website synced 2024-12-04 20:51:54 +01:00
actix-website/docs/static-files.md

44 lines
2.3 KiB
Markdown
Raw Normal View History

2018-05-22 23:15:08 +02:00
---
title: Static Files
---
import CodeBlock from "@site/src/components/code_block.js";
2018-05-22 23:15:08 +02:00
# Individual file
2022-02-26 05:41:49 +01:00
It is possible to serve static files with a custom path pattern and `NamedFile`. To match a path tail, we can use a `[.*]` regex.
2018-05-22 23:15:08 +02:00
<CodeBlock example="static-files" file="main.rs" section="individual-file" />
2018-05-22 23:15:08 +02:00
2023-11-01 16:28:34 +01:00
:::warning Matching a path tail with the `[.*]` regex and using it to return a `NamedFile` has serious security implications. It offers the possibility for an attacker to insert `../` into the URL and access every file on the host that the user running the server has access to. :::
## Directory
2018-05-22 23:15:08 +02:00
To serve files from specific directories and sub-directories, [`Files`][files] can be used. `Files` must be registered with an `App::service()` method, otherwise it will be unable to serve sub-paths.
2018-05-22 23:15:08 +02:00
<CodeBlock example="static-files" file="directory.rs" section="directory" />
2018-05-22 23:15:08 +02:00
By default files listing for sub-directories is disabled. Attempt to load directory listing will return _404 Not Found_ response. To enable files listing, use [`Files::show_files_listing()`][showfileslisting] method.
2018-05-22 23:15:08 +02:00
Instead of showing files listing for a directory, it is possible to redirect to a specific index file. Use the [`Files::index_file()`][indexfile] method to configure this redirect.
2018-07-21 15:33:25 +02:00
## Configuration
2018-07-21 15:33:25 +02:00
2019-06-26 10:27:25 +02:00
`NamedFiles` can specify various options for serving files:
2018-07-21 15:33:25 +02:00
2020-02-11 02:40:40 +01:00
- `set_content_disposition` - function to be used for mapping file's mime to corresponding `Content-Disposition` type
2019-06-26 10:27:25 +02:00
- `use_etag` - specifies whether `ETag` shall be calculated and included in headers.
2020-01-27 11:16:29 +01:00
- `use_last_modified` - specifies whether file modified timestamp should be used and added to `Last-Modified` header.
2018-07-21 15:33:25 +02:00
2022-02-26 05:41:49 +01:00
All of the above methods are optional and provided with the best defaults, But it is possible to customize any of them.
2018-07-21 15:33:25 +02:00
<CodeBlock example="static-files" file="configuration.rs" section="config-one" />
2018-07-21 15:33:25 +02:00
2019-06-26 10:27:25 +02:00
The Configuration can also be applied to directory service:
2018-07-21 15:33:25 +02:00
<CodeBlock example="static-files" file="configuration_two.rs" section="config-two" />
[files]: https://docs.rs/actix-files/0.6/actix_files/struct.Files.html#
[showfileslisting]: https://docs.rs/actix-files/0.6/actix_files/struct.Files.html#method.show_files_listing
[indexfile]: https://docs.rs/actix-files/0.6/actix_files/struct.Files.html#method.index_file