1
0
mirror of https://github.com/actix/actix-website synced 2024-11-27 18:12:57 +01:00
actix-website/content/docs/static-files.md

49 lines
1.9 KiB
Markdown
Raw Normal View History

2018-05-22 23:15:08 +02:00
---
title: Static Files
menu: docs_advanced
weight: 230
---
# Individual file
It is possible to serve static files with a custom path pattern and `NamedFile`. To
match a path tail, we can use a `[.*]` regex.
2019-06-17 23:35:47 +02:00
{{< include-example example="static-files" file="main.rs" section="individual-file" >}}
2018-05-22 23:15:08 +02:00
# Directory
2019-06-17 23:35:47 +02:00
To serve files from specific directories and sub-directories, `Files` can be used.
`Files` must be registered with an `App::service()` method, otherwise
2018-05-22 23:15:08 +02:00
it will be unable to serve sub-paths.
2019-06-17 23:35:47 +02:00
{{< include-example example="static-files" file="directory.rs" section="directory" >}}
2018-05-22 23:15:08 +02:00
2019-06-17 23:35:47 +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]
2018-05-22 23:15:08 +02:00
method.
Instead of showing files listing for 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
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
2019-06-26 10:27:25 +02: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
2019-06-17 23:35:47 +02:00
{{< include-example 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
2019-06-17 23:35:47 +02:00
{{< include-example example="static-files" file="configuration_two.rs" section="config-two" >}}
2019-12-28 19:36:24 +01:00
[showfileslisting]: https://docs.rs/actix-files/0.2/actix_files/struct.Files.html
[indexfile]: https://docs.rs/actix-files/0.2/actix_files/struct.Files.html#method.index_file