dockerfile-rails 1.0.17 → 1.0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 05b8a577ac00405dd179ea5b1cde996561ea653975160a946c204191a0fa0a26
-  data.tar.gz: 2ea30cf471f625e997fca7185bcbc89d59731516cd6165d8553a3c8a59ddcfa5
+  metadata.gz: 9cc1cc395215fe473533ab4418d6e9949a5f58d2a366c2e8d49d29ee2f8e65d8
+  data.tar.gz: 9e5a602abb603a024c08ce9e7cd0a4ebb393cfcb92b15fcbc2efd2302ea5d2d4
 SHA512:
-  metadata.gz: 1f6ea1a1dc18afd820a0af903385837688f22cac8b11e625e706b6fa2342b850e03f6a0d05606b7ea1c565560993eead3fd31259b1ca34c611b8c0178acdb38a
-  data.tar.gz: 9b9c27e9c40f6b6edac3aa732d0fae0b2b10a68127b229ade66c980e333ba0601e6f85de78f729efa8acf947f797ef0abf8923990f757c57bcf20c58867074be
+  metadata.gz: 30fceacbbc93b16c8f9f3e6e850dfe372d76675407239f4fec6e26fedc4d956a614a2b6d3c88cacd5cf0085ce06c20709b7c2885954796fe0b7f3e1f63c97cf9
+  data.tar.gz: dbd788b1bbf86b86950d95cfa4f6222e43a1359e3453bbe26c275b0ac451d5a00e1b8a038498d3cc8a554b567c35f27a1c5c143ff5deaed6d197fa7309f0f1ce

data/README.md

@@ -54,6 +54,7 @@ Configuration:
 * `--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
 * `--precompile=defer` - may be needed when your configuration requires access to secrets that are not available at build time.  Results in larger images and slower deployments.
+* `--root` - run application as root
 
 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

@@ -11,20 +11,22 @@ class DockerfileGenerator < Rails::Generators::Base
     'compose' => false,
     'fullstaq' => false,
     'jemalloc' => false,
+    'label' => {},
     'mysql' => false,
+    'nginx' => false,
     'parallel' => false,
     'platform' => nil,
     'postgresql' => false,
     'precompile' => nil,
     'prepare' => true,
     'redis' => false,
+    'root' => false,
     'swap' => nil,
     'yjit' => false,
-    'label' => {},
-    'nginx' => false,
   )
 
   @@labels = {}
+  @@packages = {"base" => [], "build" => [], "deploy" => []}
 
   # load defaults from config file
   if File.exist? 'config/dockerfile.yml'
@@ -35,6 +37,12 @@ class DockerfileGenerator < Rails::Generators::Base
         OPTION_DEFAULTS[option] = options[option] if options.include? option 
       end
 
+      if options[:packages]
+        options[:packages].each do |stage, list|
+          @@packages[stage.to_s] = list
+        end
+      end
+
       @@labels = options[:label].stringify_keys if options.include? :label
     end
   end
@@ -93,6 +101,27 @@ class DockerfileGenerator < Rails::Generators::Base
   class_option :nginx, type: :boolean, default: OPTION_DEFAULTS.nginx,
     desc: 'Serve static files with nginx'
 
+  class_option :root, type: :boolean, default: OPTION_DEFAULTS.root,
+    desc: 'Run application as root user'
+
+  class_option 'add-base', type: :array, default: [],
+    desc: 'additional packages to install for both build and deploy'
+
+  class_option 'add-build', type: :array, default: [],
+    desc: 'additional packages to install for use during build'
+
+  class_option 'add-deploy', aliases: '--add', type: :array, default: [],
+    desc: 'additional packages to install for deployment'
+
+  class_option 'remove-base', type: :array, default: [],
+    desc: 'remove from list of base packages'
+
+  class_option 'remove-build', type: :array, default: [],
+    desc: 'remove from list of build packages'
+
+  class_option 'remove-deploy', aliases: '--remove', type: :array, default: [],
+    desc: 'remove from list of deploy packages'
+
   def generate_app
     source_paths.push File.expand_path('./templates', __dir__)
 
@@ -105,6 +134,16 @@ class DockerfileGenerator < Rails::Generators::Base
       @dockerfile_config[option] = value if @dockerfile_config.include? option
     end
 
+    # apply requested package changes
+    %w(base build deploy).each do |phase|
+      @@packages[phase] += options["add-#{phase}"]
+      @@packages[phase] -= options["remove-#{phase}"]
+      @@packages[phase].uniq!
+      @@packages.delete phase if @@packages[phase].empty?
+    end
+
+    @dockerfile_config['packages'] = @@packages
+
     scan_rails_app
 
     Bundler.with_original_env { install_gems }
@@ -169,6 +208,10 @@ private
     end
   end
 
+  def run_as_root?
+    true # options.root? || options.nginx?
+  end
+
   def using_node?
     return @using_node if @using_node != nil
     @using_node = File.exist? 'package.json'
@@ -215,6 +258,7 @@ private
 
   def base_packages
     packages = []
+    packages += @@packages['base'] if @@packages['base']
 
     if using_execjs?
       packages += %w(curl unzip)
@@ -248,6 +292,7 @@ private
   def build_packages
     # start with the essentials
     packages = %w(build-essential)
+    packages += @@packages['build'] if @@packages['build']
 
     # add databases: sqlite3, postgres, mysql
     packages << 'pkg-config' if options.sqlite3? or @sqlite3
@@ -298,6 +343,7 @@ private
 
   def deploy_packages
     packages = []
+    packages += @@packages['deploy'] if @@packages['deploy']
 
     # start with databases: sqlite3, postgres, mysql
     packages << 'libsqlite3-0' if options.sqlite3? or @sqlite3

data/lib/generators/templates/Dockerfile.erb

@@ -124,6 +124,11 @@ RUN SECRET_KEY_BASE<%= Rails::VERSION::MAJOR<7 || Rails::VERSION::STRING.start_w
 # Final stage for app image
 FROM base
 
+<% end -%>
+<% unless run_as_root? -%>
+# add a non-root user
+RUN useradd rails
+
 <% end -%>
 <% unless deploy_packages.empty? -%>
 # Install packages needed for deployment
@@ -139,11 +144,11 @@ RUN gem install foreman
 <% end -%>
 <% unless options.precompile == "defer" -%>
 # Copy built application from previous stage
-COPY --from=build /rails /rails
+COPY --from=build <% unless run_as_root? %>--chown=rails:rails <% end %>/rails /rails
 <% if api_client_dir -%>
 
 # Copy built client
-COPY --from=client /rails/<%= api_client_dir %>/build /rails/public
+COPY --from=client <% unless run_as_root? %>--chown=rails:rails <% end %>/rails/<%= api_client_dir %>/build /rails/public
 <% end -%>
 
 <% end -%>

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

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/bin/bash -e
 
 <% if options.swap -%>
 # allocate swap space

metadata

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