docs/deployment.md in webpacker-4.0.7 vs docs/deployment.md in webpacker-4.1.0

- old
+ new

@@ -1,9 +1,9 @@ # Deployment -Webpacker hooks up a new `webpacker:compile` task to `assets:precompile`, which gets run whenever you run `assets:precompile`. +Webpacker hooks up a new `webpacker:compile` task to `assets:precompile`, which gets run whenever you run `assets:precompile`. If you are not using Sprockets `webpacker:compile` is automatically aliased to `assets:precompile`. Remember to set NODE_ENV environment variable to production during deployment or when running the rake task. The `javascript_pack_tag` and `stylesheet_pack_tag` helper method will automatically insert the correct HTML tag for compiled pack. Just like the asset pipeline does it. By default the output will look like this in different environments: @@ -18,34 +18,43 @@ ``` ## Heroku -Heroku installs Yarn and node by default if you deploy a Rails app with -Webpacker so all you would need to do: +In order for your Webpacker app to run on Heroku, you'll need to do a bit of configuration before hand. -```bash -heroku create shiny-webpacker-app +``` +heroku create my-webpacker-heroku-app heroku addons:create heroku-postgresql:hobby-dev +heroku buildpacks:add heroku/nodejs +heroku buildpacks:add heroku/ruby git push heroku master ``` +We're essentially doing the following here: +* Creating an app on Heroku +* Creating a Postgres database for the app (this is assuming that you're using Heroku Postgres for your app) +* Adding the Heroku NodeJS and Ruby buildpacks for your app. This allows the `npm` or `yarn` executables to properly function when compiling your app - as well as Ruby. +* Pushing our code to Heroku and kicking off the deployment + + ## Nginx Webpacker doesn't serve anything in production. You’re expected to configure your web server to serve files in public/ directly. -Some servers support sending precompressed versions of files with the `.gz` extension when they're available. For example, nginx offers a `gzip_static` directive. +Some servers support sending precompressed versions of files when they're available. For example, nginx offers a `gzip_static` directive that serves files with the `.gz` extension to supported clients. With an optional module, nginx can also serve Brotli compressed files with the `.br` extension (see below for installation and configuration instructions). Here's a sample nginx site config for a Rails app using Webpacker: ```nginx upstream app { - # ... + # server unix:///path/to/app/tmp/puma.sock; } server { + listen 80; server_name www.example.com; root /path/to/app/public; location @app { proxy_pass http://app; @@ -59,17 +68,38 @@ location / { try_files $uri @app; } - location ^~ /packs/ { + location = /favicon.ico { access_log off; log_not_found off; } + location = /robots.txt { access_log off; log_not_found off; } + + location ~ /\.(?!well-known).* { + deny all; + } + + location ~ ^/(assets|packs)/ { gzip_static on; + brotli_static on; # Optional, see below expires max; + add_header Cache-Control public; } } ``` +### Installing the ngx_brotli module + +If you want to serve Brotli compressed files with nginx, you will need to install the `nginx_brotli` module. Installation instructions from source can be found in the official [google/ngx_brotli](https://github.com/google/ngx_brotli) git repository. Alternatively, depending on your platform, the module might be available via a pre-compiled package. + +Once installed, you need to load the module. As we want to serve the pre-compressed files, we only need the static module. Add the following line to your `nginx.conf` file and reload nginx: + +``` +load_module modules/ngx_http_brotli_static_module.so; +``` + +Now, you can set `brotli_static on;` in your nginx site config, as per the config in the last section above. + ## CDN Webpacker out-of-the-box provides CDN support using your Rails app `config.action_controller.asset_host` setting. If you already have [CDN](http://guides.rubyonrails.org/asset_pipeline.html#cdns) added in your Rails app you don't need to do anything extra for Webpacker, it just works. @@ -96,6 +126,5 @@ end end end end ``` -