sanic/docs/static_files.md

# Static Files

Static files and directories, such as an image file, are served by Sanic when
registered with the `app.static` method. The method takes an endpoint URL and a
filename. The file specified will then be accessible via the given endpoint.

```python
from sanic import Sanic
app = Sanic(__name__)

# Serves files from the static folder to the URL /static
app.static('/static', './static')

# Serves the file /home/ubuntu/test.png when the URL /the_best.png
# is requested
app.static('/the_best.png', '/home/ubuntu/test.png')

app.run(host="0.0.0.0", port=8000)
```

**Previous:** [Deploying](deploying.md)

**Next:** [Middleware](middleware.md)
Made static file serving part of Sanic Added sanic.static, blueprint.static, documentation, and testing 2016-10-24 09:21:06 +01:00			`# Static Files`

Clarify, reformat, and add to documentation guides (#318) * Reorder and clarify the 'Request Data' guide, adding a section on RequestParameters * Clarify routing guide, adding introduction and HTTP types sections * Clarify the use-cases of middleware * Clean up formatting in the exceptions guide and add some common exceptions. * Fix formatting of blueprints and add use-case example. * Clarify the class-based views guide * Clarify and fix formatting of cookies guide * Clarify static files guide * Clarify the custom protocols guide. * Add more information to the deploying guide * Fix broken list in the community extensions list. * Add introduction and improve warning to contributing guide * Expand getting started guide * Reorder guides and add links between them * Standardise heading capitalisation 2017-01-20 03:18:52 +00:00			`Static files and directories, such as an image file, are served by Sanic when`
			registered with the `app.static` method. The method takes an endpoint URL and a
			`filename. The file specified will then be accessible via the given endpoint.`
Made static file serving part of Sanic Added sanic.static, blueprint.static, documentation, and testing 2016-10-24 09:21:06 +01:00
			```python
Clarify, reformat, and add to documentation guides (#318) * Reorder and clarify the 'Request Data' guide, adding a section on RequestParameters * Clarify routing guide, adding introduction and HTTP types sections * Clarify the use-cases of middleware * Clean up formatting in the exceptions guide and add some common exceptions. * Fix formatting of blueprints and add use-case example. * Clarify the class-based views guide * Clarify and fix formatting of cookies guide * Clarify static files guide * Clarify the custom protocols guide. * Add more information to the deploying guide * Fix broken list in the community extensions list. * Add introduction and improve warning to contributing guide * Expand getting started guide * Reorder guides and add links between them * Standardise heading capitalisation 2017-01-20 03:18:52 +00:00			`from sanic import Sanic`
Made static file serving part of Sanic Added sanic.static, blueprint.static, documentation, and testing 2016-10-24 09:21:06 +01:00			`app = Sanic(__name__)`

			`# Serves files from the static folder to the URL /static`
Reverse static arguments 2016-10-25 10:45:28 +01:00			`app.static('/static', './static')`
Made static file serving part of Sanic Added sanic.static, blueprint.static, documentation, and testing 2016-10-24 09:21:06 +01:00
			`# Serves the file /home/ubuntu/test.png when the URL /the_best.png`
			`# is requested`
Reverse static arguments 2016-10-25 10:45:28 +01:00			`app.static('/the_best.png', '/home/ubuntu/test.png')`
Made static file serving part of Sanic Added sanic.static, blueprint.static, documentation, and testing 2016-10-24 09:21:06 +01:00
			`app.run(host="0.0.0.0", port=8000)`
			```
Clarify, reformat, and add to documentation guides (#318) * Reorder and clarify the 'Request Data' guide, adding a section on RequestParameters * Clarify routing guide, adding introduction and HTTP types sections * Clarify the use-cases of middleware * Clean up formatting in the exceptions guide and add some common exceptions. * Fix formatting of blueprints and add use-case example. * Clarify the class-based views guide * Clarify and fix formatting of cookies guide * Clarify static files guide * Clarify the custom protocols guide. * Add more information to the deploying guide * Fix broken list in the community extensions list. * Add introduction and improve warning to contributing guide * Expand getting started guide * Reorder guides and add links between them * Standardise heading capitalisation 2017-01-20 03:18:52 +00:00
Fixes doc link extensions from .html to .md Whoops! Totally missed that all the links pointed to `.html` files instead of `.md` files 2017-01-20 03:24:08 +00:00			`Previous: [Deploying](deploying.md)`
Clarify, reformat, and add to documentation guides (#318) * Reorder and clarify the 'Request Data' guide, adding a section on RequestParameters * Clarify routing guide, adding introduction and HTTP types sections * Clarify the use-cases of middleware * Clean up formatting in the exceptions guide and add some common exceptions. * Fix formatting of blueprints and add use-case example. * Clarify the class-based views guide * Clarify and fix formatting of cookies guide * Clarify static files guide * Clarify the custom protocols guide. * Add more information to the deploying guide * Fix broken list in the community extensions list. * Add introduction and improve warning to contributing guide * Expand getting started guide * Reorder guides and add links between them * Standardise heading capitalisation 2017-01-20 03:18:52 +00:00
Fixes doc link extensions from .html to .md Whoops! Totally missed that all the links pointed to `.html` files instead of `.md` files 2017-01-20 03:24:08 +00:00			`Next: [Middleware](middleware.md)`