Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

FireflyIII Importer: Update documentation #321

Merged
merged 1 commit into from
Dec 1, 2024
Merged

FireflyIII Importer: Update documentation #321

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 16 additions & 4 deletions docs/sandbox/apps/fireflyiii_importer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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"
Expand All @@ -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.
Redeploy the Firefly III Importer Role role to apply the above changes.