dockerfile-rails 1.0.9 → 1.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7480e08de802e1158cee8c4328191fd924ccadc99ecb5183dfdd7d2a671cc059
-  data.tar.gz: bd652cd97e31632508f25e9d9aebeddb11e6914353b506a2a8c782a7016e1939
+  metadata.gz: 53cc2b6e03a559610e57f74e509e60917c265b4b2b14838cfdf4649195a1eb74
+  data.tar.gz: c2f19f82cf95229926e2d8a409cc46df398d2a05988c6a691dfa51ea81b3a7cc
 SHA512:
-  metadata.gz: 8e1d60aed5267759f46473d793addbcea1ed2c6a762b704c645b25a03d591be90c9da969946373b608141cd6f5d5f876abd0e659a6fa188d7dc8e805413f23fa
-  data.tar.gz: 8fcf8f92f60d6f7ceb1a48fe0b19ddc9cffa6daf4a4cd7869dd1c0734476777eeb55ae112bd321b70394500ab9889d9e53bb3500bad3fa654603b527ea8825da
+  metadata.gz: 781b58388ee23ceee2b2b0419379659548fb777bc3476b03c1c985e01a1813fddc8bd9aad1876d2d15546e48a36a53a1721bce20ba7a3b85f2dc7c6706bac07d
+  data.tar.gz: 1ded24e677e58592b3e94f5e60afed20021de791949c82288365b9dabd11be57b8fd6e601a77a4368ef6273f027d6330b7d42826d906402c8514c34197a7c96c

data/README.md

@@ -14,17 +14,27 @@ bundle add dockerfile-rails --optimistic --group development
 bin/rails generate dockerfile
 ```
 
-General options:
+General option:
 
 * `--force` - overwrite existing files
+
+Runtime Optimizations:
+
+* `--fullstaq` - use [fullstaq](https://fullstaqruby.org/) [images](https://github.com/evilmartians/fullstaq-ruby-docker) on [quay.io](https://quay.io/repository/evl.ms/fullstaq-ruby?tab=tags&tag=latest)
+* `--jemalloc` - use [jemalloc](https://jemalloc.net/) memory allocator
+* `--yjit` - enable [YJIT](https://github.com/ruby/ruby/blob/master/doc/yjit/yjit.md) optimizing compiler
+* `--swap=n` - allocate swap space.  See [falloc options](https://man7.org/linux/man-pages/man1/fallocate.1.html#OPTIONS) for suffixes
+
+Features:
+
 * `--ci` - include test gems in deployed image
-* `--bin-cd` - adjust binstubs to set current working directory
-* `--no-prepare` - omit `db:prepare`.  Useful for cloud platforms with [release](https://devcenter.heroku.com/articles/release-phase) phases
-* `--platform=s` - specify target platform.  See [FROM](https://docs.docker.com/engine/reference/builder/#from) for details
+* `--compose` - generate a `docker-compose.yml` file
+* `--nginx` - serve static files via [nginx](https://www.nginx.com/)
+
+Build:
+
 * `--cache` - use build caching to speed up builds
 * `--parallel` - use multi-stage builds to install gems and node modules in parallel
-* `--compose` - generate a `docker-compose.yml` file
-* `--label=name:value` - specify docker label.  Can be used multiple times.  See [LABEL](https://docs.docker.com/engine/reference/builder/#label) for details
 
 Dependencies:
 
@@ -37,12 +47,12 @@ additional support may be needed:
 * `--redis` - add redis libraries
 * `--sqlite3` - add sqlite3 libraries
 
-Runtime Optimizations:
+Configuration:
 
-* `--fullstaq` - use [fullstaq](https://fullstaqruby.org/) [images](https://github.com/evilmartians/fullstaq-ruby-docker) on [quay.io](https://quay.io/repository/evl.ms/fullstaq-ruby?tab=tags&tag=latest)
-* `--jemalloc` - use [jemalloc](https://jemalloc.net/) memory allocator
-* `--yjit` - enable [YJIT](https://github.com/ruby/ruby/blob/master/doc/yjit/yjit.md) optimizing compiler
-* `--swap=n` - allocate swap space.  See [falloc options](https://man7.org/linux/man-pages/man1/fallocate.1.html#OPTIONS) for suffixes
+* `--bin-cd` - adjust binstubs to set current working directory
+* `--no-prepare` - omit `db:prepare`.  Useful for cloud platforms with [release](https://devcenter.heroku.com/articles/release-phase) phases
+* `--platform=s` - specify target platform.  See [FROM](https://docs.docker.com/engine/reference/builder/#from) for details
+* `--label=name:value` - specify docker label.  Can be used multiple times.  See [LABEL](https://docs.docker.com/engine/reference/builder/#label) for detail
 
 Options are saved between runs into `config/dockerfile.yml`.  To invert a boolean options, add or remove a `no-` prefix from the option name.
 

data/lib/generators/dockerfile_generator.rb

@@ -20,6 +20,7 @@ class DockerfileGenerator < Rails::Generators::Base
     'swap' => nil,
     'yjit' => false,
     'label' => {},
+    'nginx' => false,
   )
 
   @@labels = {}
@@ -85,6 +86,9 @@ class DockerfileGenerator < Rails::Generators::Base
   class_option :label, type: :hash, default: {},
     desc: 'Add Docker label(s)'
 
+  class_option :nginx, type: :boolean, default: OPTION_DEFAULTS.nginx,
+    desc: 'Serve static files with nginx'
+
   def generate_app
     source_paths.push File.expand_path('./templates', __dir__)
 
@@ -297,6 +301,9 @@ private
     # Puppeteer
     packages << 'google-chrome-stable' if using_puppeteer?
 
+    # nginx
+    packages << 'nginx' if options.nginx?
+
     packages.sort
   end
 
@@ -321,16 +328,18 @@ private
   def deploy_env
     env = []
 
+    env << 'PORT="3001"' if options.nginx?
+
     if Rails::VERSION::MAJOR<7 || Rails::VERSION::STRING.start_with?('7.0')
       env << 'RAILS_LOG_TO_STDOUT="1"'
-      env << 'RAILS_SERVE_STATIC_FILES="true"'
+      env << 'RAILS_SERVE_STATIC_FILES="true"' unless options.nginx?
     end
 
-    if options.yjit
+    if options.yjit?
       env << 'RUBY_YJIT_ENABLE="1"'
     end
 
-    if options.jemalloc and not options.fullstaq
+    if options.jemalloc? and not options.fullstaq?
       if (options.platform || Gem::Platform::local.cpu).include? 'arm'
         env << 'LD_PRELOAD="/usr/lib/aarch64-linux-gnu/libjemalloc.so.2"'
       else
@@ -473,4 +482,17 @@ private
       'db:migrate'
     end
   end
+
+  def procfile
+    if options.nginx?
+      {
+        nginx: 'nginx -g "daemon off;"',
+        rails: './bin/rails server -p 3001'
+      }
+    else
+      {
+        rails: './bin/rails server'
+      }
+    end
+  end
 end

data/lib/generators/templates/Dockerfile.erb

@@ -123,6 +123,13 @@ FROM base
 <%= render partial: 'apt_install', locals: {packages: deploy_packages, clean: true, repos: deploy_repos} %>
 <% end -%>
 
+<% if options.nginx? -%>
+<%= render partial: 'nginx' %>
+
+<% elsif procfile.size > 1 -%>
+RUN gem install foreman
+
+<% end -%>
 # Copy built application from previous stage
 <% if options.ci? -%>
 COPY --from=build /usr/local/bundle /usr/local/bundle
@@ -146,6 +153,19 @@ ENV <%= deploy_env.join(" \\\n    ") %>
 <% end -%>
 ENTRYPOINT ["/rails/bin/docker-entrypoint"]
 
+<% if procfile.size > 1 -%>
+# Build a Procfile for production use
+COPY <<-"EOF" /rails/Procfile.prod
+<% procfile.each do |name, command| -%>
+<%= name %>: <%= command %>
+<% end -%>
+EOF
+
+# Start the server by default, this can be overwritten at runtime
+EXPOSE 3000
+CMD ["foreman", "start", "--procfile=Procfile.prod"]
+<% else -%>
 # Start the server by default, this can be overwritten at runtime
 EXPOSE 3000
 CMD ["./bin/rails", "server"]
+<% end -%>

data/lib/generators/templates/_nginx.erb

@@ -1,7 +1,7 @@
 # configure nginx
-RUN sed -i 's/access_log\s.*;/access_log \/dev\/stdout main;/' /etc/nginx/nginx.conf && \
-    sed -i 's/error_log\s.*;/error_log \/dev\/stderr info;/' /etc/nginx/nginx.conf && \
-    sed -i "/access_log/i\ \n\tlog_format main '\$http_fly_client_ip - \$remote_user [\$time_local] "\$request" '\n\t'\$status \$body_bytes_sent \"\$http_referer\" \"\$http_user_agent\"';" /etc/nginx/nginx.conf
+RUN gem install foreman && \
+    sed -i 's/access_log\s.*;/access_log \/dev\/stdout;/' /etc/nginx/nginx.conf && \
+    sed -i 's/error_log\s.*;/error_log \/dev\/stderr info;/' /etc/nginx/nginx.conf
 
 COPY <<-"EOF" /etc/nginx/sites-available/default
 server {

data/lib/generators/templates/docker-entrypoint.erb

@@ -11,8 +11,13 @@ echo 1 > /proc/sys/vm/overcommit_memory
 
 <% end -%>
 <% if options.prepare -%>
+<% if procfile.size > 1 -%>
+# If running the production procfile then create or migrate existing database
+if [ "${*}" == "foreman start --procfile=Procfile.prod" ]; then
+<% else -%>
 # If running the rails server then create or migrate existing database
 if [ "${*}" == "./bin/rails server" ]; then
+<% end -%>
   ./bin/rails <%= dbprep_command %>
 fi
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dockerfile-rails
 version: !ruby/object:Gem::Version
-  version: 1.0.9
+  version: 1.0.10
 platform: ruby
 authors:
 - Sam Ruby
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-06 00:00:00.000000000 Z
+date: 2023-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails