From 3229de5e235f7022899861102a333b0eb5fd4f35 Mon Sep 17 00:00:00 2001 From: PokePango <34710204+PokePango@users.noreply.github.com> Date: Sun, 1 Dec 2024 12:46:51 +0100 Subject: [PATCH] FireflyIII Importer: Update documentation Links to documentations for data import methods: CLI or webserver. --- docs/sandbox/apps/fireflyiii_importer.md | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/docs/sandbox/apps/fireflyiii_importer.md b/docs/sandbox/apps/fireflyiii_importer.md index 4c1043971..2ab454ee9 100644 --- a/docs/sandbox/apps/fireflyiii_importer.md +++ b/docs/sandbox/apps/fireflyiii_importer.md @@ -34,7 +34,7 @@ The Required variables that should be defined in [inventory](../../saltbox/inven To authenticate the Data Importer to Firefly III you require to use either: - [Access Token](#311-access-token) -- [~~Client ID~~](#312-client-id) ***Not Had Luck Getting This Working*** +- [Client ID](#312-client-id) #### 3.1.1 Access Token @@ -55,11 +55,23 @@ fireflyiii_importer_docker_envs_custom: 1. Your client id from your instance of Firefly III | Options | Profile | OAuth | OAuth Clients | Create New Client. > Note: Your require to leave Confidential unticked -## 4. Additional Settings +## 4. Import data + +For the following methods, your data need to be formatted in CSV. + +### 4.1 Web import + +You can refer to the following documentation to execute import from the server: [web import](https://docs.firefly-iii.org/how-to/data-importer/import/csv/) + +### 4.2 Server import + +You can refer to the following documentation to execute import from the server: [CLI import](https://docs.firefly-iii.org/how-to/data-importer/advanced/cli/) + +## 5. Additional Settings > **Note: For all available settings please refer to the Firefly III Data Importer [example env](https://raw.githubusercontent.com/firefly-iii/docker/main/docker-compose-importer.yml)** -### 4.1 Email Notifications +### 5.1 Email Notifications To enable email notifications, set the following [inventory](../../saltbox/inventory/index.md) entries to your desired values: ``` yaml title="Firefly III Data Importer Email Settings" @@ -80,4 +92,4 @@ MAIN_ENCRYPTION: "" # (7)! 6. Replace `""` with your email password if necessary. 7. Use `SSL` or `TLS` for communication with the SMTP server. Can be `true` or '`false`. -Redeploy the Firefly III Importer Role role to apply the above changes. \ No newline at end of file +Redeploy the Firefly III Importer Role role to apply the above changes.