MSP dashboard: Update readme to document all required config values (#…

…24773)

Changes:
- Updated the MSP dashboard's readme to include a section about required
config values for software features.
- Added config values required for software features to the MSP
dashboard's docker-compose file.
- Added an uploads configuration file that lists the configuration
values required for software features.

ee/bulk-operations-dashboard/README.md

@@ -16,9 +16,17 @@ A dashboard to easily manage profiles and scripts across multiple teams on a Fle
 This app has two required custom configuration values:
 
 - `sails.config.custom.fleetBaseUrl`: The full URL of your Fleet instance. (e.g., https://fleet.example.com)
-
 - `sails.config.custom.fleetApiToken`: An API token for an API-only user on your Fleet instance.
 
+### Required configuration for software features
+
+If you are using this app to manage software across multiple teams on a Fleet instance, five additional configuration values are required:
+
+- `sails.config.uploads.bucket` The name of an AWS s3 bucket where unassigned software installers will be stored.
+- `sails.config.uploads.secret` The secret for the S3 bucket where unassigned software installers will be stored.
+- `sails.config.uploads.region` The region the AWS S3 bucket is located.
+- `sails.config.uploads.bucketWithPostfix`:  The name of the s3 bucket with the directory that the software installers are stored in on appended to it. If the files will be stored in the root directory of the bucket, this value should be identical to the `sails.config.uploads.bucket` value
+- `sails.config.uploads.prefixForFileDeletion`: The directory path in the S3 bucket where the software installers will be stored. If the installers will be stored in the root directory, then this value can be set to ' '.
 
 
 ## Running the bulk operations dashboard with Docker.

ee/bulk-operations-dashboard/config/uploads.js

@@ -0,0 +1,35 @@
+/**
+ * File Upload Settings
+ * (sails.config.uploads)
+ *
+ * These options tell Sails where (and how) to store uploaded files.
+ *
+ *  > This file is mainly useful for configuring how file uploads in your
+ *  > work during development; for example, when lifting on your laptop.
+ *  > For recommended production settings, see `config/env/production.js`
+ *
+ * For all available options, see:
+ * https://sailsjs.com/config/uploads
+ */
+
+module.exports.uploads = {
+
+  /***************************************************************************
+  *                                                                          *
+  * Sails apps upload and download to the local disk filesystem by default,  *
+  * using a built-in filesystem adapter called `skipper-disk`. This feature  *
+  * is mainly intended for convenience during development since, in          *
+  * production, many apps will opt to use a different approach for storing   *
+  * uploaded files, such as Amazon S3, Azure, or GridFS.                     *
+  *                                                                          *
+  * Most of the time, the following options should not be changed.           *
+  * (Instead, you might want to have a look at `config/env/production.js`.)  *
+  *                                                                          *
+  ***************************************************************************/
+  // bucket: '',// The name of the S3 bucket where software installers will be stored.
+  // region: '', // The region where the S3 bucket is located.
+  // secret: '', // The secret for the S3 bucket where unassigned software installers will be stored.
+  // bucketWithPostfix: '', // This value should be set to the same value as the bucket unless the files are stored in a folder in the S3 bucket. In that case, this value needs to be set to `{bucket name}{folder name}` e.g., unassigned-software-installers/staging
+  // prefixForFileDeletion: '', // Only required if the software installers are stored in a folder in the S3 bucket. The name of the folder where the software installers are stored in the S3 bucket with a trailing slash. e.g., staging/
+
+};

ee/bulk-operations-dashboard/docker-compose.yaml

@@ -14,6 +14,11 @@ services:
       sails_models__migrate: safe
       sails_custom__fleetBaseUrl: '' #Add the base url of your Fleet instance: ex: https://fleet.example.com
       sails_custom__fleetApiToken: '' # Add the API token of an API-only user [?] Here's how you get one: https://fleetdm.com/docs/using-fleet/fleetctl-cli#get-the-api-token-of-an-api-only-user
+      sails_uploads__secret: '' # (Required to enable software features) The secret for the S3 bucket where unassigned software installers will be stored.
+      sails_uploads__bucket: '' # (Required to enable software features) The name of the S3 bucket where software installers will be stored.
+      sails_uploads__region: '' # (Required to enable software features) The region where the S3 bucket is located.
+      sails_uploads__bucketWithPostfix: '' # (Required to enable software features) This value should be set to the same value as the bucket unless the files are stored in a folder in the S3 bucket. In that case, this value needs to be set to `{bucket name}{folder name}` e.g., unassigned-software-installers/staging
+      sails_uploads__prefixForFileDeletion: '' # (Required to enable software features) Only required if the software installers are stored in a folder in the S3 bucket. The name of the folder where the software installers are stored in the S3 bucket with a trailing slash. e.g., staging/
 
   postgres:
     image: "postgres:alpine"