Add Readmes

Author: Lagoja

README.md

@@ -1 +1,18 @@
-# Repository for Devbox Plugins
+# Devbox Plugins
+
+This repository includes plugins for configuring packages using Devbox.
+
+## Available Plugins
+
+* MongoDB
+* RabbitMQ
+
+## How to Use
+
+Each subfolder contains a plugin for a specific package. To use a plugin, add the following reference to the `include` section of your `devbox.json` file.
+
+```json
+"includes": [
+    "github:jetpack-io/devbox-plugins?dir=<plugin-name>"
+],
+```

mongodb/README.md

@@ -0,0 +1,37 @@
+# MongoDB Plugin
+
+Plugin for the [`mongodb`](https://www.nixhub.io/packages/mongodb) package. This plugin configures MonogoDB to use a local config file and data directory for this project, and configures a mongodb service.
+
+## How to Activate
+
+To install MongoDB, run `devbox add mongodb@latest`. We also recommend installing the [`mongosh`](https://nixhub.io/packages/mongosh) client with `devbox add mongosh@latest`.
+
+To activate this plugin, add the following reference to the `include` section of your `devbox.json` file.
+
+```json
+
+"include": [
+    "github:jetpack-io/devbox-plugins?dir=mongodb"
+],
+```
+
+## Services
+
+* mongodb
+
+Use `devbox services up mongodb` to start the mongodb server.
+
+## Files
+
+This plugin creates the following helper files:
+
+* **devbox.d/mongodb/mongod.conf** - MongoDB configuration file
+* **.devbox/virtenv/mongodb/data** - empty directory for holding your mongodb database
+* **.devbox/virtenv/rabbitmq/process-compose.yaml** - Defines the process to start the MongoDB server
+
+## Environment Variables
+
+This plugin sets the following environment variables:
+
+* **MONGODB_CONFIG** = {{.DevboxDir}}/mongod.conf
+* **MONGODB_DATA** = {{.Virtenv}}/data

mongodb/plugin.json

@@ -1,8 +1,7 @@
 {
   "name": "mongodb",
   "version": "0.0.1",
-  "match": "^mongodb-[0-9_]$",
-  "readme": "MongoDB plugin",
+  "readme": "Plugin for the [`mongodb`](https://www.nixhub.io/packages/mongodb) package. This plugin configures MonogoDB to use a local config file and data directory for this project, and configures a mongodb service.",
   "env": {
     "MONGODB_DATA": "{{.Virtenv}}/data",
     "MONGODB_CONFIG": "{{.DevboxDir}}/mongod.conf"

rabbitmq/README.md

@@ -0,0 +1,40 @@
+# RabbitMQ Plugin
+
+Plugin for the [`rabbitmq-server`](https://www.nixhub.io/packages/rabbitmq-server) package. This plugin sets several `RABBITMQ` environment variables to run an instance of RabbitMQ in your local project, adds a `rabbitmq.conf` file to the devbox.d directory, and configures a RabbitMQ service.
+
+## How to Activate
+
+To install RabbitMQ, run `devbox add rabbitmq-server@latest`
+
+To activate this plugin, add the following reference to the `include` section of your `devbox.json` file.
+
+```json
+
+"include": [
+    "github:jetpack-io/devbox-plugins?dir=rabbitmq"
+],
+```
+
+## Services
+
+* rabbitmq
+
+Use `devbox services up rabbitmq` to start the RabbitMQ  server
+
+## Files
+
+This plugin creates the following helper files:
+
+* **devbox.d/rabbitmq/conf.d/rabbitmq.conf** - RabbitMQ configuration file
+* **.devbox/virtenv/rabbitmq/process-compose.yaml** - Defines the process to start the RabbitMQ server
+
+## Environment Variables
+
+This plugin sets the following environment variables:
+
+* **RABBITMQ_CONFIG_FILE** = {{.DevboxDir}}/conf.d
+* **RABBITMQ_MNESIA_BASE** = {{.Virtenv}}/mnesia
+* **RABBITMQ_ENABLED_PLUGINS_FILE** = {{.DevboxDir}}/conf.d/enabled_plugins
+* **RABBITMQ_LOG_BASE** = {{.Virtenv}}/log
+* **RABBITMQ_NODENAME** = rabbit
+* **RABBITMQ_PID_FILE** = {{.Virtenv}}/pid/$RABBITMQ_NODENAME.pid

rabbitmq/config/process-compose.yaml

@@ -10,6 +10,6 @@ processes:
     shutdown:
       command: "rabbitmqctl shutdown"
   rabbitmq-logs:
-    command: "tail -f $RABBITMQ_LOG_BASE/$RABBITMQ_NODENAME@$HOST.log"
+    command: "tail -f $RABBITMQ_LOG_BASE/$RABBITMQ_NODENAME@$(hostname -s).log"
     availability:
       restart: "always"

rabbitmq/plugin.json

@@ -1,10 +1,7 @@
 {
     "name": "rabbitmq",
     "version": "0.0.1",
-    "packages": [
-        "rabbitmq-server@latest"
-    ],
-    "readme": "RabbitMQ plugin",
+    "readme": "Plugin for the RabbitMQ Server. This plugin sets several RABBITMQ environment variables to run an instance of RabbitMQ in your local project, adds a rabbitmq.conf file to the devbox.d directory, and configures a RabbitMQ service.",
     "env": {
         "RABBITMQ_CONFIG_FILES": "{{.DevboxDir}}/conf.d",
         "RABBITMQ_MNESIA_BASE": "{{.Virtenv}}/mnesia",