Skip to content

Commit

Permalink
fix typo in database docs, document debug subcommand
Browse files Browse the repository at this point in the history
refers to #467
  • Loading branch information
m90 committed Sep 2, 2020
1 parent 0d3cc67 commit a889464
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/docs/running-offen/configuring-the-application.md
Expand Up @@ -138,13 +138,13 @@ The connection string or location of the database. For `sqlite3` this will be th
When using `mysql` make sure you append a `?parseTime=true` parameter to your connection string:

```
OFFEN_DATABSE_CONNECTIONSTRING=user:pass@tcp(localhost:3306)/offen?parseTime=true
OFFEN_DATABASE_CONNECTIONSTRING=user:pass@tcp(localhost:3306)/offen?parseTime=true
```

When using `postgres` and you are using a local database (or a Docker network) you might need to append a `?sslmode=disable` parameter to your connection string:

```
OFFEN_DATABSE_CONNECTIONSTRING=postgres://user:pass@localhost:5432/offen?sslmode=disable
OFFEN_DATABASE_CONNECTIONSTRING=postgres://user:pass@localhost:5432/offen?sslmode=disable
```

---
Expand Down
4 changes: 4 additions & 0 deletions docs/docs/running-offen/using-the-command.md
Expand Up @@ -108,6 +108,10 @@ Running `offen version` prints information about the git revision the binary has

`offen demo` starts a one-off demo instance that requires zero configuration. This is meant for anyone that wants to have a look at what Offen is offering but doesn't want to set up any configuration yet. Data is persisted in an temporary database that will be deleted once the process is shut down.

### `offen debug`

`offen debug` prints the currently applicable runtime configuration. Use this in case Offen does end up with a configuration you do not expect. Passing a value to the `-envfile` flag will override the default lookup (just like with for example `serve` or `setup`).

---

## When run as a horizontally scaling service
Expand Down

0 comments on commit a889464

Please sign in to comment.