Docs for 0.2.1 (#465)

Lagoja · web-flow · commit fde296a6e23e · 2023-01-12T15:33:57.000-08:00
## Summary Add Docs for 0.2.1 Release - Envrc Changes - New Plugins ## How was it tested? Localhost and https://devbox-web-john-lago-jetpack-io.cloud.jetpack.dev/devbox
diff --git a/docs/app/docs/cli_reference/devbox.md b/docs/app/docs/cli_reference/devbox.md
@@ -10,14 +10,18 @@ devbox [flags]
 
 ```text
   -h, --help   help for devbox
+  -q, --quiet   Quiet mode: Suppresses logs.
 ```
 
 ## SEE ALSO
 
 * [devbox add](./devbox_add.md)	 - Add a new package to your devbox
+* [devbox generate](devbox_generate.md)  - Generate supporting files for your project
+* [devbox info](devbox_info.md)  - Display package and plugin info
 * [devbox init](./devbox_init.md)	 - Initialize a directory as a devbox project
-* [devbox plan](./devbox_plan.md)	 - Preview the plan used to build your environment
 * [devbox rm](./devbox_rm.md)	 - Remove a package from your devbox
+* [devbox run](devbox_run.md)	 - Starts a new devbox shell and runs the target script
+* [devbox services](devbox_services.md)  - Interact with Devbox Services
 * [devbox shell](./devbox_shell.md)	 - Start a new shell or run a command with access to your packages
 * [devbox version](./devbox_version.md)	 - Print version information
 
diff --git a/docs/app/docs/cli_reference/devbox_add.md b/docs/app/docs/cli_reference/devbox_add.md
@@ -10,6 +10,7 @@ devbox add <pkg>... [flags]
 
 ```text
   -h, --help   help for add
+  -q, --quiet   Quiet mode: Suppresses logs.
 ```
 
 ## SEE ALSO
diff --git a/docs/app/docs/cli_reference/devbox_generate.md b/docs/app/docs/cli_reference/devbox_generate.md
@@ -11,11 +11,13 @@ devbox generate <devcontainer|dockerfile> [flags]
 ```bash
   -c, --config string   path to directory containing a devbox.json config file
   -h, --help            help for generate
+  -q, --quiet   Quiet mode: Suppresses logs.
 ```
 
 ## SEE ALSO
 
 * [devbox](devbox.md)	 - Instant, easy, predictable development environments
 * [devbox generate devcontainer](devbox_generate_devcontainer.md)	 - Generate Dockerfile and devcontainer.json files under .devcontainer/ directory
 * [devbox generate dockerfile](devbox_generate_dockerfile.md)	 - Generate a Dockerfile that replicates devbox shell
+* [devbox generate direnv](devbox_generate_direnv.md)  - Generate a .envrc file to use with direnv
 
diff --git a/docs/app/docs/cli_reference/devbox_generate_devcontainer.md b/docs/app/docs/cli_reference/devbox_generate_devcontainer.md
@@ -15,6 +15,7 @@ devbox generate devcontainer [flags]
 ```bash
   -f, --force   force overwrite on existing files
   -h, --help    help for devcontainer
+  -q, --quiet   Quiet mode: Suppresses logs.
 ```
 
 ### SEE ALSO
diff --git a/docs/app/docs/cli_reference/devbox_generate_direnv.md b/docs/app/docs/cli_reference/devbox_generate_direnv.md
@@ -0,0 +1,19 @@
+# devbox generate direnv
+
+Top level command for generating the .envrc file for your Devbox Project. This can be used with [direnv](../ide_configuration/direnv.md) to automatically start your shell when you cd into your devbox directory
+
+```bash
+devbox generate direnv [flags]
+```
+
+## Options
+
+```bash
+  -c, --config string   path to directory containing a devbox.json config file
+  -h, --help            help for generate
+  -q, --quiet   Quiet mode: Suppresses logs.
+```
+
+## SEE ALSO
+
+* [devbox](devbox.md)	 - Instant, easy, predictable development environments
diff --git a/docs/app/docs/cli_reference/devbox_generate_dockerfile.md b/docs/app/docs/cli_reference/devbox_generate_dockerfile.md
@@ -16,6 +16,7 @@ devbox generate dockerfile [flags]
   -c, --config string   path to directory containing a devbox.json config file
   -f, --force           force overwrite existing files
   -h, --help            help for dockerfile
+  -q, --quiet   Quiet mode: Suppresses logs.
 ```
 
 ## SEE ALSO
diff --git a/docs/app/docs/cli_reference/devbox_info.md b/docs/app/docs/cli_reference/devbox_info.md
@@ -15,7 +15,8 @@ devbox info <pkg> [flags]
 ```bash
   -c, --config string   path to directory containing a devbox.json config file
   -h, --help            help for info
-      --markdown        Output in markdown format
+  --markdown        Output in markdown format
+  -q, --quiet   Quiet mode: Suppresses logs.
 ```
 
 ### SEE ALSO
diff --git a/docs/app/docs/cli_reference/devbox_init.md b/docs/app/docs/cli_reference/devbox_init.md
@@ -13,7 +13,8 @@ devbox init [<dir>] [flags]
 ## Options
 
 ```text
-  -h, --help   help for init
+  -h, --help   help for init   
+  -q, --quiet   Quiet mode: Suppresses logs.
 ```
 
 ## SEE ALSO
diff --git a/docs/app/docs/cli_reference/devbox_plan.md b/docs/app/docs/cli_reference/devbox_plan.md
@@ -10,6 +10,7 @@ devbox plan [<dir>] [flags]
 
 ```text
   -h, --help   help for plan
+  -q, --quiet   Quiet mode: Suppresses logs.
 ```
 
 ## SEE ALSO
diff --git a/docs/app/docs/cli_reference/devbox_rm.md b/docs/app/docs/cli_reference/devbox_rm.md
@@ -10,6 +10,7 @@ devbox rm <pkg>... [flags]
 
 ```text
   -h, --help   help for rm
+  -q, --quiet   Quiet mode: Suppresses logs.
 ```
 
 ## SEE ALSO
diff --git a/docs/app/docs/cli_reference/devbox_run.md b/docs/app/docs/cli_reference/devbox_run.md
@@ -13,6 +13,7 @@ For more details, read our [scripts guide](../guides/scripts.md)
 ```text
   -c, --config string   path to directory containing a devbox.json config file
   -h, --help            help for run
+  -q, --quiet   Quiet mode: Suppresses logs.
 ```
 
 ## SEE ALSO
diff --git a/docs/app/docs/cli_reference/devbox_services.md b/docs/app/docs/cli_reference/devbox_services.md
@@ -11,6 +11,7 @@ devbox services <ls|restart|start|stop> [flags]
 ```bash
   -c, --config string   path to directory containing a devbox.json config file
   -h, --help            help for services
+  -q, --quiet   Quiet mode: Suppresses logs.
 ```
 
 ## SEE ALSO
diff --git a/docs/app/docs/cli_reference/devbox_services_ls.md b/docs/app/docs/cli_reference/devbox_services_ls.md
@@ -10,6 +10,7 @@ devbox services ls [flags]
 
 ```bash
   -h, --help   help for ls
+  -q, --quiet   Quiet mode: Suppresses logs.
 ```
 
 ### SEE ALSO
diff --git a/docs/app/docs/cli_reference/devbox_services_restart.md b/docs/app/docs/cli_reference/devbox_services_restart.md
@@ -10,6 +10,7 @@ devbox services restart [service]... [flags]
 
 ```bash
   -h, --help   help for restart
+  -q, --quiet   Quiet mode: Suppresses logs.
 ```
 
 ## SEE ALSO
diff --git a/docs/app/docs/cli_reference/devbox_services_start.md b/docs/app/docs/cli_reference/devbox_services_start.md
@@ -10,6 +10,7 @@ devbox services start [service]... [flags]
 
 ```bash
   -h, --help   help for start
+  -q, --quiet   Quiet mode: Suppresses logs.
 ```
 
 ## SEE ALSO
diff --git a/docs/app/docs/cli_reference/devbox_services_stop.md b/docs/app/docs/cli_reference/devbox_services_stop.md
@@ -10,6 +10,7 @@ devbox services stop [service]... [flags]
 
 ```bash
   -h, --help   help for stop
+  -q, --quiet   Quiet mode: Suppresses logs.
 ```
 
 ## SEE ALSO
diff --git a/docs/app/docs/cli_reference/devbox_shell.md b/docs/app/docs/cli_reference/devbox_shell.md
@@ -17,6 +17,7 @@ devbox shell [<dir>] -- [<cmd>] [flags]
 ```text
   --print-env  Print a script to setup a devbox shell environment
   -h, --help   help for shell
+  -q, --quiet   Quiet mode: Suppresses logs.
 ```
 
 ## SEE ALSO
diff --git a/docs/app/docs/cli_reference/devbox_version.md b/docs/app/docs/cli_reference/devbox_version.md
@@ -11,6 +11,7 @@ devbox version [flags]
 ```text
   -h, --help      help for version
   -v, --verbose   Verbose: displays additional version information
+  -q, --quiet   Quiet mode: Suppresses logs.
 ```
 
 ## SEE ALSO
diff --git a/docs/app/docs/devbox_examples/databases/postgres.md b/docs/app/docs/devbox_examples/databases/postgres.md
@@ -1,7 +1,7 @@
 ---
 title: PostgreSQL
 ---
-PostgreSQL can be automatically configured by Devbox via the built-in Postgres PLugin. This plugin will activate automatically when you install Postgres using `devbox add postgresql`
+PostgreSQL can be automatically configured by Devbox via the built-in Postgres Plugin. This plugin will activate automatically when you install Postgres using `devbox add postgresql`
 
 [**Example Repo**](https://github.com/jetpack-io/devbox-examples/tree/main/databases/postgres)
 
@@ -27,6 +27,7 @@ You can use `devbox services start|stop postgresql` to start or stop the Postgre
 
 ### Environment Variables
 
+`PGHOST=./.devbox/virtenv/postgresql`
 `PGDATA=./.devbox/virtenv/postgresql/data`
 
 This variable tells PostgreSQL which directory to use for creating and storing databases. 
diff --git a/docs/app/docs/devbox_examples/databases/redis.md b/docs/app/docs/devbox_examples/databases/redis.md
@@ -2,7 +2,7 @@
 title: Redis
 ---
 
-The easiest way to configure Redis with Devbox is by adding a custom `redis.conf` to your project, and then starting `redis-server` by pointing it to the conf file. 
+Redis can be configured automatically using Devbox's built in Redis plugin. This plugin will activate automatically when you install Redis using `devbox add redis`
 
 [**Example Repo**](https://github.com/jetpack-io/devbox-examples/tree/main/databases/redis)
 
@@ -16,28 +16,34 @@ The easiest way to configure Redis with Devbox is by adding a custom `redis.conf
     ],
 ```
 
-## Example redis.conf
+## Redis Plugin Details
 
-```conf
-##### NETWORK #####
-bind 127.0.0.1 -::1
-protected-mode yes
-port 6379
+The Redis plugin will automatically create the following configuration when you install Redis with `devbox add`
 
-##### TLS/SSL  #####   
+### Services
 
-# Use default settings
+* redis
 
-##### GENERAL ##### 
+Use `devbox services start|stop [service]` to interact with services
 
-daemonize yes
-pidfile conf/redis/redis.pid
-logfile redis.log
+### Helper Files
 
-##### SNAPSHOTTING #####
+The following helper files will be created in your project directory:
 
-dir conf/redis/data/
+* {PROJECT_DIR}/devbox.d/redis/redis.conf
+
+
+### Environment Variables
+
+```bash
+REDIS_PORT=6379
+REDIS_CONF=./devbox.d/redis/redis.conf
 ```
 
-If this config is stored under your project folder at `conf/redis`, then you can start redis with the correct settings by running:
-`redis-server conf/redis` from within your devbox shell
+### Notes
+
+Running `devbox services start redis` will start redis as a daemon in the background.
+
+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`
diff --git a/docs/app/docs/devbox_examples/servers/caddy.md b/docs/app/docs/devbox_examples/servers/caddy.md
@@ -0,0 +1,45 @@
+---
+title: Caddy
+---
+
+Caddy can be configured automatically using Devbox's built in Caddy plugin. This plugin will activate automatically when you install Caddy using `devbox add caddy`
+
+[**Example Repo**](https://github.com/jetpack-io/devbox-examples/tree/main/servers/caddy)
+
+### Adding Caddy to your Shell
+
+Run `devbox add caddy`, or add the following to your `devbox.json`
+
+```json
+  "packages": [
+    "caddy"
+  ]
+```
+
+## Caddy Plugin Details
+
+The Caddy plugin will automatically create the following configuration when you install Caddy with `devbox add`
+
+### Services
+* caddy
+
+Use `devbox services start|stop caddy` to start and stop httpd in the background
+
+### Helper Files
+The following helper files will be created in your project directory:
+
+* {PROJECT_DIR}/devbox.d/caddy/Caddyfile
+* {PROJECT_DIR}/devbox.d/web/index.html
+
+Note that by default, Caddy is configured with `./devbox.d/web` as the root. To change this, you should modify the default `./devbox.d/caddy/Caddyfile` or change the `CADDY_ROOT_DIR` environment variable
+
+### Environment Variables
+```bash
+* CADDY_CONFIG={PROJECT_DIR}/devbox.d/caddy/Caddyfile
+* CADDY_LOG_DIR={PROJECT_DIR}/.devbox/virtenv/caddy/log
+* CADDY_ROOT_DIR={PROJECT_DIR}/devbox.d/web
+```
+
+### Notes
+
+You can customize the config used by the caddy service by modifying the Caddyfile in devbox.d/caddy, or by changing the CADDY_CONFIG environment variable to point to a custom config. The custom config must be either JSON or Caddyfile format.
diff --git a/docs/app/docs/ide_configuration/direnv.md b/docs/app/docs/ide_configuration/direnv.md
@@ -12,20 +12,32 @@ ___
 
 ### Setting up Devbox Shell and direnv
 
-Note: If you already have a devbox project you may skip to step 3.
-
-1. `devbox init` if you don't have a devbox.json in the root directory of your project.
-2. `devbox shell -- 'ls'` to activate devbox shell temporarily and make sure dependencies mentioned in your devbox.json are installed.
-3. Create a new file, name it `.envrc` and put the following snippet inside it:
-    ```bash
-    use_devbox() {
-        watch_file devbox.json
-        eval $(devbox shell --print-env)
-    }
-    use devbox
-    ```
-4. Run `direnv allow` to give permission to `direnv` to setup your environment variables.
-5. At this point, your project directory is setup so that every time you `cd` into it, the binaries from your devbox shell will be used. To test this, you can compare running `which python3` from your project directory and outside.
+#### New Project
+
+If you have direnv installed, Devbox will generate an .envrc file when you run `devbox init` and prompt you to enable it:
+
+```bash
+➜  devbox init
+? Do you want to enable direnv integration for this devbox project?[y/n] y
+direnv: loading ~/src/devbox/docs/.envrc
+direnv: using devbox
+```
+
+This will generate a `.envrc` file in your root directory along with your `devbox.json`, and run `direnv allow` so that your shell will activate whenever you navigate to the directory.
+
+If you choose not to enable the integration, you can enable it at anytime by running `direnv allow`, or following the global settings below
+
+#### Existing Project
+
+For an existing project, you can add a `.envrc` file by running `devbox generate envrc`:
+
+```bash
+➜  devbox generate direnv
+? Do you want to enable direnv integration for this devbox project?[y/n] y
+direnv: loading ~/src/devbox/docs/.envrc
+direnv: using devbox
+```
+
 
 ### Global settings for direnv
 
diff --git a/docs/app/sidebars.js b/docs/app/sidebars.js
@@ -68,6 +68,10 @@ const sidebars = {
             type: 'doc',
             id: 'cli_reference/devbox_generate_devcontainer',
             label: 'devbox generate devcontainer'
+        }, {
+            type: 'doc',
+            id: 'cli_reference/devbox_generate_direnv',
+            label: 'devbox generate direnv  '
         }, {
             type: 'doc',
             id: 'cli_reference/devbox_generate_dockerfile',
@@ -80,10 +84,6 @@ const sidebars = {
             type: 'doc',
             id: 'cli_reference/devbox_init',
             label: 'devbox init'
-        }, {
-            type: 'doc',
-            id: 'cli_reference/devbox_plan',
-            label: 'devbox plan'
         }, {
             type: 'doc',
             id: 'cli_reference/devbox_rm',
@@ -206,6 +206,7 @@ const sidebars = {
             collapsed: true,
             items: [
                 { type: 'doc', id: 'devbox_examples/servers/apache' },
+                { type: 'doc', id: 'devbox_examples/servers/caddy' },
                 { type: 'doc', id: 'devbox_examples/servers/nginx' }
             ]
         }]
