Skip to content

Commit

Permalink
docs: Update CLI docs & clarify Folderr docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Aervyon committed Nov 9, 2023
1 parent 1bcd7fd commit a2ae7c5
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 6 deletions.
1 change: 1 addition & 0 deletions Guides/CLI/beta/commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ Usage:
folderr-cli install [flags]
Flags:
-a, --authorization Authorization token for private repositories. Init will fail if the repository is private and this is not used.
-h, --help help for install
Global Flags:
Expand Down
12 changes: 6 additions & 6 deletions Guides/Folderr/2.0.0/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,11 +85,11 @@ url: mongodb://localhost/folderr

Configuration for emails. Goes in `configs/email.yaml`. 100% optional.

Variable | Description | Type | Example or Default? | Optional
-------------------------------- | ---------------------------------- | ------- | ---------------------- | ---
sendingEmail | Email the emailer displays | String | `no-reply@example.com` | Yes
[mailerOptions](#mailer-options) | Options for emailer | Object | | Yes
selfTest | Whether or not to test the emailer | Boolean | `true`, default | Yes
Variable | Description | Type | Example or Default? | Optional
-------------------------------- | ---------------------------------------------------------------------------- | ------- | ---------------------- | ---
sendingEmail | Email the emailer displays | String | `no-reply@example.com` | Yes
[mailerOptions](#mailer-options) | Options for emailer | Object | | Yes
selfTest | Whether or not to test the emailer by sending an email to the `sendingEmail` | Boolean | `true`, default | Yes

### Mailer Options

Expand Down Expand Up @@ -131,5 +131,5 @@ mailerOptions:
host: example.com
tls:
rejectUnauthorized: false # In case you have a bad certificate.
sendingEmail: No-Reply <no-reply@example.com>,
sendingEmail: "No-Reply <no-reply@example.com>"
```

0 comments on commit a2ae7c5

Please # to comment.