mission_control-jobs 0.5.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5cae6550d727f9f26c6b5c0f1259a03c7a3f802abe8eb025973fab559b8a8f73
-  data.tar.gz: 98a0bea82a4f3b9c3a3d338719f419508eef9ae05dbfc356314f142d053a4d11
+  metadata.gz: 8afd612ead034dc5c0f4b3798f62943bf021a557e4af5d7a5a565e50bfe5d647
+  data.tar.gz: 077c09bbff77e7f73de506600c447a05f7cb08b8ee266a1b107395ac393338e9
 SHA512:
-  metadata.gz: 223fb6d226ef1511e88cac89f0b1176e5db6bd01899b49279012d1ed94e607c28491f4ec770c96848291d84748e6f2b3956812ee0a4f25a3b7a814557f3de259
-  data.tar.gz: 52e763ce4e3b3bb7d59881d284f1a136474b46b3cffba722db96f333e63538e7647f638fe5b67c427e5fb6bbdf96452f0dc7b216e04300ffd690d8197302161b
+  metadata.gz: 99c16735667988a38b3b9f356406f8aec967044cf17f0f81cc05f8b6bb5fb2a85965ad34c30cf537ad95c43935cd0cc6e5f3ec7185ec661f06ec3579a8e73ab2
+  data.tar.gz: af8726be9391650a8f27c0ba855ecd633dd5bb23d9d0be78a8d5d5f4fdb9949d8d65f95ee638aebcede5fa863fa20c76ea054b8e7a3d7021bd0408ec0877c26e

data/README.md

@@ -30,10 +30,55 @@ And that's it. With this alone, you should be able to access Mission Control Job
 
 ![Failed jobs tab in a simple app](docs/images/failed-jobs-simple.png)
 
+### API-only apps or apps using `vite_rails` and other asset pipelines outside Rails
 
-### Authentication and base controller class
+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:
 
-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:
+```ruby
+gem "propshaft"
+```
+
+Then execute
+```bash
+$ bundle install
+```
+
+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
+```
+
+If no credentials are configured, Mission Control won't be accessible. To set these up, you can run the generator provided like this:
+
+```
+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
@@ -44,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