Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
PBrunot authored Dec 1, 2024
1 parent 08ec03c commit 9255b1f
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,8 @@ wget https://raw.githubusercontent.com/espressif/arduino-esp32/master/tools/espo
pip install FabOMatic
```

* Change defaults in conf/settings.toml (see below)
* In the package installation directory, copy src/FabOMatic/conf/settings.example.toml into settings.toml and edit settings.
On first run, if the settings.toml file is missing, the settings.example.toml file will be copied and used instead.

* Test it with

Expand Down Expand Up @@ -105,9 +106,11 @@ pip install FabOMatic --upgrade

* Database upgrades are applied by Alembic at start of the backend and shall not need user interaction.

## Configuration file defaults
## Configuration file

* See file conf\settings.toml to setup MQTT server, database connections, SMTP for "forgot password" email. Example below
* For configuration, the file src/FabOMatic/conf/settings.toml in package installation directory is used.
* It contains configuration info for MQTT server (mandatory), database connection string (mandatory), SMTP for "forgot password" email (not mandatory)
* Example below

```text
[database]
Expand Down

0 comments on commit 9255b1f

Please sign in to comment.