completed docker configuration for production

Author: jschnapper

.dockerignore

@@ -2,6 +2,8 @@
 .bin
 .env
 .env.production
+.env*
+!.env.example
 .git/
 .gitignore
 .github/
@@ -12,10 +14,19 @@
 log/*
 tmp/*
 node_modules/
-public/packs
+public/packs/
+public/assets/
 yarn-error.log
 coverage/
 test/
 spec/
 config/master.key
-config/initializers/secret_token.rb
+config/initializers/secret_token.rb
+config/credentials/development.key
+config/credentials/production.key
+docker-compose.override.yml
+yarn-debug.log*
+.yarn-integrity
+.yarn/
+docker-compose.yml
+vendor/bundle

.env.example

@@ -0,0 +1,36 @@
+
+export RAILS_ENV=production
+export NODE_ENV=production
+
+# TODO: Generate a secret
+# 1. generate `rails secret`
+# 2. add to the env variables SECRET_KEY_BASE and RAILS_MASTER_KEY
+# 3. run `rails credentials:edit --environment production` and enter the secret under `secret_key_base`
+# export SECRET_KEY_BASE=<SECRET KEY>
+# export RAILS_MASTER_KEY=<SECRET KEY>
+
+# TODO: choose one restart policy
+# export DOCKER_RESTART_POLICY=unless-stopped
+# export DOCKER_RESTART_POLICY=always
+
+# TODO: Assign a no-reply email address
+# This is the email that automated emails, password resets, and confirmations will come from
+# export NO_REPLY_EMAIL=<NO REPLY EMAIL>
+
+# TODO: Assign a contact email
+# A contact email for users if they have questions or encounter issues
+# export CONTACT_EMAIL=<NO REPLY EMAIL>
+
+# TODO: Add smtp email info
+# export SMTP_HOST=<SMTP HOST>
+# export SMTP_PORT=<SMTP PORT>
+# openssl verify mode defaults to "none" if nothing provided
+# export SMTP_OPENSSL_VERIFY_MODE=<SMTP OPENSSL VERIFY MODE> 
+
+# TODO: Complete default url options
+# export PRODUCTION_HOST=<PRODUCTION HOST>
+# export PRODUCTION_PROTOCOL=<PRODUCTION PROTOCOL>
+
+# TODO: Add postgres user and password
+# export POSTGRES_USER=<POSTGRES USER>
+# export POSTGRES_PASSWORD=<POSTGRES PASSWORD>

.gitignore

@@ -45,6 +45,7 @@ config/initializers/secret_token.rb
 /yarn-error.log
 yarn-debug.log*
 .yarn-integrity
+.yarn/
 
 # .env
 .env

Dockerfile

@@ -0,0 +1,45 @@
+FROM ruby:3.0.3-slim
+WORKDIR /app
+RUN apt-get update -qq \
+  && apt-get install -y --no-install-recommends build-essential curl git vim libpq-dev \
+  && curl -sSL https://deb.nodesource.com/setup_14.x | bash - \
+  && curl -sSL https://dl.yarnpkg.com/debian/pubkey.gpg | apt-key add - \
+  && echo 'deb https://dl.yarnpkg.com/debian/ stable main' | tee /etc/apt/sources.list.d/yarn.list \
+  && apt-get update && apt-get install -y --no-install-recommends nodejs yarn postgresql-client \
+  && rm -rf /var/lib/apt/lists/* /usr/share/doc /usr/share/man \
+  && apt-get clean \
+  && useradd --create-home forecasts \
+  && chown forecasts:forecasts -R /app
+
+COPY entrypoint.sh /usr/bin/
+RUN chmod +x /usr/bin/entrypoint.sh
+
+USER forecasts
+ENV BUNDLER_VERSION 2.2.32
+COPY --chown=forecasts:forecasts Gemfile Gemfile.lock ./
+
+RUN bundle config set --local deployment 'true' \
+  && bundle config set --local without 'development test' \
+  && bundle install \
+  && rm -rf vendor/bundle/ruby/3.0.0/cache/*.gem \
+  && find vendor/bundle/ruby/3.0.0/gems/ -name "*.c" -delete \
+  && find vendor/bundle/ruby/3.0.0/gems/ -name "*.o" -delete
+
+COPY --chown=forecasts:forecasts package.json yarn.lock ./
+RUN yarn install --frozen-lockfile --non-interactive --production
+
+COPY --chown=forecasts:forecasts . .
+RUN rm entrypoint.sh
+
+ENV PATH="${PATH}:/app/bin"
+
+ENTRYPOINT ["entrypoint.sh"]
+EXPOSE 3000
+
+# precompile production app
+RUN RAILS_ENV=production SECRET_KEY_BASE=`rails secret` rails assets:precompile --trace \
+  && yarn cache clean \
+  && rm -rf tmp/cache vendor/assets test spec node_modules
+
+# Configure the main process to run when running the image
+CMD ["rails", "server", "-b", "0.0.0.0"]

Dockerfile.production

@@ -1,7 +1,7 @@
 source 'https://rubygems.org'
 git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
-ruby '3.0.2'
+ruby '3.0.3'
 
 # Bundle edge Rails instead: gem 'rails', github: 'rails/rails', branch: 'main'
 gem 'rails', '~> 6.1.4'

Gemfile

@@ -70,7 +70,7 @@ GEM
     bcrypt (3.1.16)
     benchmark (0.1.1)
     bindex (0.8.1)
-    bootsnap (1.7.7)
+    bootsnap (1.9.3)
       msgpack (~> 1.0)
     brakeman (5.1.1)
     builder (3.2.4)
@@ -146,7 +146,9 @@ GEM
     minitest (5.14.4)
     msgpack (1.4.2)
     nio4r (2.5.8)
-    nokogiri (1.12.3-x86_64-darwin)
+    nokogiri (1.12.5-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.12.5-x86_64-linux)
       racc (~> 1.4)
     orm_adapter (0.5.0)
     paper_trail (12.0.0)
@@ -159,7 +161,7 @@ GEM
     public_suffix (4.0.6)
     puma (5.4.0)
       nio4r (~> 2.0)
-    racc (1.5.2)
+    racc (1.6.0)
     rack (2.2.3)
     rack-mini-profiler (2.3.2)
       rack (>= 1.2.0)
@@ -321,6 +323,7 @@ GEM
 
 PLATFORMS
   x86_64-darwin-19
+  x86_64-linux
 
 DEPENDENCIES
   annotate (~> 3.1.1)
@@ -361,7 +364,7 @@ DEPENDENCIES
   yard (~> 0.9.26)
 
 RUBY VERSION
-   ruby 3.0.2p107
+   ruby 3.0.3p157
 
 BUNDLED WITH
-   2.2.22
+   2.2.32

Gemfile.lock

@@ -2,5 +2,9 @@
 
 This application provides an interface for companies and businesses to track hours for specific contracts.
 
+## Running in production
+1. Copy the `.env.example` file and rename it to `.env`
+2. Fill in all the appropriate and applicable environment variables (ensure following all of the "TODO" instructions)
+
 ## Technical Details
 `fields` are shared across teams, but `team_fields` are used to track which fields a team uses at a particular time.

README.md

@@ -62,4 +62,5 @@
   month: @team_monthly_forecast.monthly_forecast.date.strftime("%B"),
   member_id: @member.id
   )%>. Only your most recent submssion will be used.
-</p>
+</p>
+<p>If you have any questions or issues, please contact <%= Rails.application.config.contact_email %></p>

app/views/forecast_mailer/confirmation_email.html.erb

@@ -13,4 +13,5 @@
   )
   %>
 </p>
+<p>If you have any questions or issues, please contact <%= Rails.application.config.contact_email %></p>