add information on disabling plugins (#2232)

## Summary

Add details on disabling plugins

## How was it tested?

Localhost

Author: Lagoja

docs/app/docs/cli_reference/devbox_add.md

@@ -29,6 +29,8 @@ devbox add prometheus --outputs=out,cli
 | --- | --- |
 | `--allow-insecure` | allows Devbox to install a package that is marked insecure by Nix |
 | `-c, --config string` | path to directory containing a devbox.json config file |
+| `--disable-plugin` | disable the build plugin for a package |
+| `--environment string` | Jetify Secrets environment to use, when supported (e.g.secrets support dev, prod, preview.) (default "dev") |
 | `-e, --exclude-platform strings` | exclude packages from a specific platform. |
 | `-h, --help` | help for add |
 | `-o, --outputs strings` | specify the outputs to install for the nix package | 

docs/app/docs/configuration.md

@@ -47,7 +47,9 @@ If you need to provide more options to your packages (such as limiting which pla
             // List of platforms to install the package on. Defaults to all platforms
             "platforms": [string],
             // List of platforms to exclude this package from. Defaults to no excluded platforms
-            "excluded_platforms": [string]
+            "excluded_platforms": [string],
+            // Whether to disable a built-in plugin, if one exists for this package. Defaults to false
+            "disable_plugin": boolean
         }
     }
 }
@@ -144,6 +146,21 @@ The platforms below are also supported, but require you to build packages from s
 * `i686-linux`
 * `armv7l-linux`
 
+#### Disabling Built-in Plugins
+
+Some packages include builtin plugins or services that are automatically started when the package is installed. You can disable these plugins using `devbox add <package> --disable-plugin`, or by setting the `disable_plugin` field to `true` in your package definition:
+
+```json
+{
+    "packages": {
+        "glibcLocales": {
+            "version": "latest",
+            "disable_plugin": true
+        }
+    }
+}
+```
+
 ### Env
 
 This is a a map of key-value pairs that should be set as Environment Variables when activating `devbox shell`, running a script with `devbox run`, or starting a service. These variables will only be set in your Devbox shell, and will have precedence over any environment variables set in your local machine or by [Devbox Plugins](guides/plugins.md).

docs/app/docs/devbox_examples/databases/mariadb.md

@@ -68,3 +68,18 @@ These files are used to setup your database and service, and should not be modif
     "MYSQL_UNIX_PORT": "/<some-other-path>/mysql.sock"
 }
 ```
+
+### Disabling the MariaDB Plugin
+
+You can disable the MariaDB plugin by running `devbox add mariadb --disable-plugin`, or by setting the `disable_plugin` field in your `devbox.json`:
+
+```json
+{
+    "packages": {
+        "mariadb": {
+            "version": "latest",
+            "disable_plugin": true
+        }
+    }
+}
+```

docs/app/docs/devbox_examples/databases/mysql.md

@@ -71,3 +71,18 @@ These files are used to setup your database and service, and should not be modif
     "MYSQL_UNIX_PORT": "/<some-other-path>/mysql.sock"
 }
 ```
+
+### Disabling the MySQL PLugin
+
+You can disable the built-in MySQL plugin using `devbox add mysql80 --disable-plugin`, or by setting the `disable_plugin` field to `true` in your package definition:
+
+```json
+{
+    "packages": {
+        "mysql80": {
+            "version": "latest",
+            "disable_plugin": true
+        }
+    }
+}
+```

docs/app/docs/devbox_examples/databases/postgres.md

@@ -67,3 +67,18 @@ createuser -s -r your_new_user_name
 Replace `your_new_user_name` with the desired username for the new superuser.
 
 Remember: Creating a superuser grants them significant power over the database system, so it should be done cautiously and only when absolutely necessary due to the potential security implications.
+
+### Disabling the Postgres Plugin
+
+You can disable the Postgres plugin by running `devbox add postgresql --disable-plugin`, or by setting the `disable_plugin` field to `true` in your package definition:
+
+```json
+{
+    "packages": {
+        "postgresql": {
+            "version": "latest",
+            "disable_plugin": true
+        }
+    }
+}
+```

docs/app/docs/devbox_examples/databases/redis.md

@@ -51,3 +51,18 @@ Running `devbox services start redis` will start redis as a daemon in the backgr
 You can manually start Redis in the foreground by running `redis-server $REDIS_CONF --port $REDIS_PORT`.
 
 Logs, pidfile, and data dumps are stored in `.devbox/virtenv/redis`. You can change this by modifying the `dir` directive in `devbox.d/redis/redis.conf`
+
+### Disabling the Redis Plugin
+
+You can disable the Redis plugin by running `devbox add redis --disable-plugin`, or by setting the `disable_plugin` field in your `devbox.json`:
+
+```json
+{
+    "packages": {
+        "redis": {
+            "version": "latest",
+            "disable_plugin": true
+        }
+    }
+}
+```

docs/app/docs/devbox_examples/databases/valkey.md

@@ -51,3 +51,18 @@ Running `devbox services start valkey` will start valkey as a daemon in the back
 You can manually start Valkey in the foreground by running `valkey-server $VALKEY_CONF --port $VALKEY_PORT`.
 
 Logs, pidfile, and data dumps are stored in `.devbox/virtenv/valkey`. You can change this by modifying the `dir` directive in `devbox.d/valkey/valkey.conf`
+
+### Disabling the Valkey Plugin
+
+You can disable the Valkey plugin by running `devbox add valkey --disable-plugin`, or by setting the `disable_plugin` field in your `devbox.json`:
+
+```json
+{
+    "packages": {
+        "valkey": {
+            "version" : "latest",
+            "disable_plugin": true
+        }
+    }
+}
+```

docs/app/docs/devbox_examples/languages/php.md

@@ -65,3 +65,18 @@ PHPRC={PROJECT_DIR}/devbox.d/php/php.ini
 * \{PROJECT_DIR\}/devbox.d/php81/php.ini
 
 You can modify these files to configure PHP or your PHP-FPM server
+
+### Disabling the PHP Plugin
+
+You can disable the PHP plugin by running `devbox add php --disable-plugin`, or by setting the `disable_plugin` field in your `devbox.json`:
+
+```json
+{
+    "packages": {
+        "php": {
+            "version": "latest",
+            "disable_plugin": true
+        }
+    }
+}
+```

docs/app/docs/devbox_examples/languages/python.md

@@ -124,3 +124,17 @@ You can install Poetry by adding it to the packages in your `devbox.json`. You c
 }
 ```
 This init_hook will automatically start Poetry's virtualenv when you run `devbox shell`, and provide you with access to all your packages.
+
+## Disabling the Python Plugin
+
+If you would prefer to disable the Python Plugin, you can add python using `devbox add python --disable_plugin` or in your `devbox.json`:
+
+```json
+{
+    "packages": {
+        "python": {
+            "version": "3.10",
+            "disable_plugin": true
+        }
+    }
+}

docs/app/docs/devbox_examples/languages/ruby.md

@@ -36,6 +36,24 @@ GEM_HOME={PROJECT_DIR}/.devbox/virtenv/ruby
 PATH={PROJECT_DIR}/.devbox/virtenv/ruby/bin:$PATH
 ```
 
+### Disabling the Ruby Plugin
+
+You can disable the Ruby plugin by running `devbox add ruby --disable-plugin`, or by setting the `disable_plugin` field in your `devbox.json`:
+
+```json
+{
+    "packages": {
+        "ruby": {
+            "version": "3.1",
+            "disable_plugin": true
+        },
+        "bundler": {
+            "version": "latest",
+        }
+    },
+}
+```
+
 ## Bundler
 
 In case you are using bundler to install gems, bundler config file can still be used to pass configs and flags to install gems.
@@ -44,4 +62,4 @@ In case you are using bundler to install gems, bundler config file can still be
 
 ```dotenv
 BUNDLE_BUILD__SASSC: "--disable-lto"
-```
+```