Installation
Docker
Learn how to install Firefly Pico using Docker or manually.
Installation
Docker (Recommended)
If you already have Firefly III installed the fastest way to get started with Firefly-Pico is via docker-compose.
version: '3.3'
services:
firefly-pico:
image: cioraneanu/firefly-pico:dev
ports:
- "6977:80"
environment:
- FIREFLY_URL=https://firefly.domain.com
volumes:
- /path/firefly-pico-data:/var/www/html/database/data
Make sure the environment variable FIREFLY_URL points to your Firefly III instance. This can be either IP + Port (ex.
http://192.168.1.99:8080) or subdomain (ex. https://firefly.domain.com) if you use a reverse proxy like Nginx Proxy Manager.
- Set the volume to a persistent folder for the SQLite database.
- Make sure the environment variable FIREFLY_URL points to your Firefly III instance. This can be either IP + Port (ex.
http://192.168.1.99:8080) or subdomain (ex.https://firefly.domain.com) if you use a reverse proxy like Nginx Proxy Manager. - Set the volume to a persistent folder for the SQLite database.
Other variants:
If you don't yet have Firefly III installed and want both inside a single Docker-compose file:
- Pico + Firefly
- Pico + Firefly + Importer
- Update
FIREFLY_URL/APP_URL/FIREFLY_III_URLaccordingly. - Change
DB_PASSWORDandPOSTGRES_PASSWORDto something secure. Make sure they match!
- Update
Further information on how to setup and configure Firefly III can be found on their officials docs: HERE
Environment Variables
| Name | Description |
|---|---|
NUXT_PUBLIC_QUERY_TIMEOUT | Milliseconds Pico should wait before a request times out. (Default: 4000) |
TZ | Pico backend Timezone (ex. Europe/London) |
Optional Environment Variables
These power the AI features of Ramble. Leave them unset and Pico works exactly as before.
| Name | Description |
|---|---|
ASSISTANT_LLM_ENDPOINT | OpenAI-compatible chat completions endpoint used by Ramble. (Default: https://api.openai.com/v1/chat/completions) |
ASSISTANT_LLM_MODEL | LLM model name. (Default: gpt-4o-mini) |
ASSISTANT_LLM_API_KEY | API key for the LLM endpoint. |
ASSISTANT_LLM_CONTEXT | Extra instructions appended to every Ramble interpretation. |
ASSISTANT_TRANSCRIPTION_ENDPOINT | OpenAI-compatible audio transcription endpoint for voice rambles. (Default: https://api.openai.com/v1/audio/transcriptions) |
ASSISTANT_TRANSCRIPTION_MODEL | Transcription model name. (Default: gpt-4o-mini-transcribe) |
ASSISTANT_TRANSCRIPTION_API_KEY | API key for the transcription endpoint. |
Docker image flavors
:latest- Stable, less frequent updates:dev- Latest features, more updates, still stable.
Post-install Configuration
- Generate Firefly III Auth Token: Open up Firefly III and finish the onboarding process if this is your first usage. **** Go to
Options->Profile->OAuth->Create New Personal Access Token. - Connect Pico: Open Firefly-Pico, **** go to
Settings->Setupand paste the token.
In most scenarios you don't need to change the Pico Backend URL field!!! This is helpful only if deploy the Firefly-Pico backend somewhere separate from the frontend.