mission_control-jobs 0.6.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90d1d2bb94c81934c6d0f2c366b76ba9d9ee778c90a4ca0385515ea7b84d658f
-  data.tar.gz: 51f7c76c6de7a39cc18e5b813a7d84ae18c94e9cd25487c0f16cb94e650d2319
+  metadata.gz: df0dc5c7b14924b9cb9063225ea71332d38e6550dded42c22e4d6698e9ed6b28
+  data.tar.gz: 11fd491a0028f31c0c9975c560113580c06d79d3eb188e7968caccc1a84bf39d
 SHA512:
-  metadata.gz: 69e67bae39f22105acac0e10b9c52452fb453acc6e52e868746875f9daa75cd5556eadfca06db76eecb70e6c634dfdc1ecc217cc001d726da9b93bd9606b7ebe
-  data.tar.gz: ab9c390dfd70c8b196ee3e6c1e5c07821299c2b23fd733a62c39d7b01cab3350f53c17ae9c9bdf5aaad9becf8b50b55dfd34b555b30500585373f901296e7717
+  metadata.gz: ca6d18a6d0ad2676ed21218df330d8fcea6a9daa106c780d36a0a148d951c939988120393bbc9a782fa5f0cd9179b0b6f14ecab09c1c7b7ca37e6fb17e1f3add
+  data.tar.gz: 41c69feb7ce874eb91ca7c063463c98627832f95cdd20a6033846837c489c04f00031ddc1eaac44f6271a4ca939e47f6a3b00d921d20d040a09c615cb70b7817

data/README.md

@@ -32,7 +32,7 @@ And that's it. With this alone, you should be able to access Mission Control Job
 
 ### API-only apps or apps using `vite_rails` and other asset pipelines outside Rails
 
-If you want to use this gem with an [API-only Rails app](https://guides.rubyonrails.org/api_app.html) or an app that's using `vite_ruby`/`vite_rails`, or some other custom asset pipeline different from Sprockets and Propshaft, you need just one more thing: configure an asset pipeline so you can serve the JavaScript and CSS included in this gem. We recommend to use [`Propshaft`](https://github.com/rails/propshaft). You simply need to add this line to your application's Gemfile:
+If you want to use this gem with an [API-only Rails app](https://guides.rubyonrails.org/api_app.html) or an app that's using `vite_ruby`/`vite_rails`, or some other custom asset pipeline different from Sprockets and Propshaft, you need one more thing: configure an asset pipeline so you can serve the JavaScript and CSS included in this gem. We recommend to use [`Propshaft`](https://github.com/rails/propshaft). You simply need to add this line to your application's Gemfile:
 
 ```ruby
 gem "propshaft"
@@ -43,11 +43,42 @@ Then execute
 $ bundle install
 ```
 
-And you should be ready to go.
+Then, make sure you add a step to your deployment pipeline to precompile assets:
+```
+RAILS_ENV=production rails assets:precompile
+```
+
+For example, if you're using the Dockerfile generated by Rails with an API-only app or having skipped the assets pipeline, re-add:
+```
+# Precompiling assets for production without requiring secret RAILS_MASTER_KEY
+RUN SECRET_KEY_BASE_DUMMY=1 ./bin/rails assets:precompile
+```
+
+*Note: Legacy CSS bundlers `sass-rails` and `sassc-rails` may fail to compile some of the CSS vendored into this library from [Bulma](https://github.com/jgthms/bulma), which was created in [Dart SASS](https://sass-lang.com/dart-sass/). You will therefore need to upgrade to `dartsass-rails` or some library that relies on it, like `cssbundling-rails`.*
+
+### Authentication
+
+Mission Control comes with **HTTP basic authentication enabled and closed** by default. Credentials are stored in [Rails's credentials](https://edgeguides.rubyonrails.org/security.html#custom-credentials) like this:
+```yml
+mission_control:
+  http_basic_auth_user: dev
+  http_basic_auth_password: secret
+```
 
-### Authentication and base controller class
+If no credentials are configured, Mission Control won't be accessible. To set these up, you can run the generator provided like this:
 
-By default, Mission Control's controllers will extend the host app's `ApplicationController`. If no authentication is enforced, `/jobs` will be available to everyone. You might want to implement some kind of authentication for this in your app. To make this easier, you can specify a different controller as the base class for Mission Control's controllers:
+```
+bin/rails mission_control:jobs:authentication:configure
+```
+
+To set them up for different environments you can use the `RAILS_ENV` environment variable, like this:
+```
+RAILS_ENV=production bin/rails mission_control:jobs:authentication:configure
+```
+
+#### Custom authentication
+
+You can provide your own authentication mechanism, for example, if you have a certain type of admin user in your app that can access Mission Control. To make this easier, you can specify a different controller as the base class for Mission Control's controllers. By default, Mission Control's controllers will extend the host app's `ApplicationController`, but you can change this easily:
 
 ```ruby
 Rails.application.configure do
@@ -58,7 +89,11 @@ end
 Or, in your environment config or `application.rb`:
 ```ruby
 config.mission_control.jobs.base_controller_class = "AdminController"
+```
 
+If you do this, you can disable the default HTTP Basic Authentication using the following option:
+```ruby
+config.mission_control.jobs.http_basic_auth_enabled = false
 ```
 
 ### Other configuration settings