https://github.com/eggjs/egg-static

static server plugin for egg
https://github.com/eggjs/egg-static

egg egg-plugin egg-static

Last synced: 3 months ago
JSON representation

static server plugin for egg

• Host: GitHub
• URL: https://github.com/eggjs/egg-static
• Owner: eggjs
• License: mit
• Created: 2016-07-15T07:15:28.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2023-02-13T03:40:36.000Z (almost 2 years ago)
• Last Synced: 2024-10-29T21:05:54.991Z (3 months ago)
• Topics: egg, egg-plugin, egg-static
• Language: JavaScript
• Size: 45.9 KB
• Stars: 90
• Watchers: 10
• Forks: 16
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-egg - egg-static - 静态服务器插件。   (仓库 / [内置插件](https://eggjs.org/zh-cn/basics/plugin.html#%E6%8F%92%E4%BB%B6%E5%88%97%E8%A1%A8))

README

        
# egg-static

[![NPM version][npm-image]][npm-url]

[![Test coverage][codecov-image]][codecov-url]

[![npm download][download-image]][download-url]

[npm-image]: https://img.shields.io/npm/v/egg-static.svg?style=flat-square

[npm-url]: https://npmjs.org/package/egg-static

[codecov-image]: https://codecov.io/github/eggjs/egg-static/coverage.svg?branch=master

[codecov-url]: https://codecov.io/github/eggjs/egg-static?branch=master

[download-image]: https://img.shields.io/npm/dm/egg-static.svg?style=flat-square

[download-url]: https://npmjs.org/package/egg-static

Static server plugin for egg, base on [koa-static-cache](https://github.com/koajs/static-cache).

## Install

`egg-static` is a plugin that has been built-in for egg. It is enabled by default.

## Configuration

egg-static support all configurations in [koa-static-cache](https://github.com/koajs/static-cache). and with default configurations below:

- prefix: `'/public/'`

- dir: `path.join(appInfo.baseDir, 'app/public')`

- dynamic: `true`

- preload: `false`

- maxAge: `31536000` in prod env, `0` in other envs

- buffer: `true` in prod env, `false` in other envs

`egg-static` provides one more option:

- maxFiles: the maximum value of cache items, only effective when dynamic is true, default is `1000`.

**All static files in `$baseDir/app/public` can be visited with prefix `/public`, and all the files are lazy loaded.**

- In non-production environment, assets won't be cached, your modification can take effect immediately.

- In production environment, `egg-static` will cache the assets after visited, you need to restart the process to update the assets.

- Dir default is `$baseDir/app/public` but you can also define **multiple directory** by use `dir: [dir1, dir2, ...]` or `dir: [dir1, { prefix: '/static2', dir: dir2 }]`, static server will use all these directories.

```js

// {app_root}/config/config.default.js

exports.static = {

  // maxAge: 31536000,

};

```

## Questions & Suggestions

Please open an issue [here](https://github.com/eggjs/egg/issues).

## License

[MIT](https://github.com/eggjs/egg-static/blob/master/LICENSE)

## Contributors

|[
dead-horse](https://github.com/dead-horse)
|[
fengmk2](https://github.com/fengmk2)
|[
atian25](https://github.com/atian25)
|[
popomore](https://github.com/popomore)
|[
okoala](https://github.com/okoala)
|[
airyland](https://github.com/airyland)
|

| :---: | :---: | :---: | :---: | :---: | :---: |

[
helloyou2012](https://github.com/helloyou2012)
|[
maxming2333](https://github.com/maxming2333)


This project follows the git-contributor [spec](https://github.com/xudafeng/git-contributor), auto updated at `Sun Feb 12 2023 17:38:47 GMT+0800`.