Skip to content

Commit

Permalink
Docs for v2.7.0 followup
Browse files Browse the repository at this point in the history
- Mark some things as experimental
- Complete my sentence for `caddy storage` command
  • Loading branch information
francislavoie committed Jul 18, 2023
1 parent 194beeb commit ee39c96
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 1 deletion.
2 changes: 2 additions & 0 deletions src/docs/markdown/caddyfile/concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -337,6 +337,8 @@ b.example.com {

## Named Routes

<i>⚠️ Experimental</i>

Named routes use syntax similar to [snippets](#snippets); they're a special block defined outside of site blocks, prefixed with `&(` and ending in `)` with the name in between.

```caddy
Expand Down
2 changes: 2 additions & 0 deletions src/docs/markdown/caddyfile/directives/invoke.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: invoke (Caddyfile directive)

# invoke

<i>⚠️ Experimental</i>

Invokes a [named route](/docs/caddyfile/concepts#named-routes).

This is useful when paired with HTTP handler directives that have their own in-memory state, or if they are expensive to provision on load. If you have hundreds of sites or more, invoking a named route can help reduce memory usage.
Expand Down
10 changes: 9 additions & 1 deletion src/docs/markdown/command-line.md
Original file line number Diff line number Diff line change
Expand Up @@ -512,11 +512,13 @@ If you want to stop the current configuration but do not want to exit the proces

### `caddy storage`

<i>⚠️ Experimental</i>

Allows export and import of the contents of Caddy's configured data storage.

This is useful when needing to transition from one [storage module](/docs/json/storage/) to another, by exporting from your old one, updating your config, then importing into the new one.

The following command can be used to do this all in one shot, using and old and new config with different configured storage modules, piping the export output into the
The following command can be used to copy the storage between different modules in one shot, using old and new configs, piping the export command's output into the import command.

```
$ caddy storage export -c Caddyfile.old -o- |
Expand Down Expand Up @@ -596,6 +598,8 @@ If the admin API is used, then the CA ID defaults to "local". You may specify th

### `caddy upgrade`

<i>⚠️ Experimental</i>

<pre><code class="cmd bash">caddy upgrade
[-k, --keep-backup]</code></pre>

Expand All @@ -611,6 +615,8 @@ This command may require elevated privileges if your user does not have permissi

### `caddy add-package`

<i>⚠️ Experimental</i>

<pre><code class="cmd bash">caddy add-package &lt;packages...&gt;
[-k, --keep-backup]</code></pre>

Expand All @@ -624,6 +630,8 @@ For example:

### `caddy remove-package`

<i>⚠️ Experimental</i>

<pre><code class="cmd bash">caddy remove-package &lt;packages...&gt;
[-k, --keep-backup]</code></pre>

Expand Down

0 comments on commit ee39c96

Please sign in to comment.