How to install Garmin Grafana on Synology NAS?

[arpanghosh8453]

Garmin-Grafana Installation Guide on Synology NAS

This guide walks you through installing the Garmin Grafana dashboard on your Synology NAS

---

Prerequisites

• Synology NAS with Docker support
• Git Server installed from Package Center
• SSH access enabled (Control Panel > Terminal & SNMP > Enable SSH)
• Admin access to Synology File Station
• A Garmin Connect account

---

Step-by-Step Installation

1. Install Git Server

• Open Package Center on your NAS.
• Search for and install Git Server.

2. Enable SSH and Connect

• Enable SSH from Control Panel.

• Use an SSH client like PuTTY to connect to your NAS:

  ssh your_nas_username@your_nas_ip

---

3. Create a Project Directory

sudo mkdir -p /volume1/docker/garmingrafana
cd /volume1/docker/garmingrafana

4. Clone the Garmin Grafana Repo

sudo git clone https://github.com/arpanghosh8453/garmin-grafana.git
cd garmin-grafana

5. Setup Token Storage

sudo mkdir garminconnect-tokens
sudo chown -R 1000:1000 garminconnect-tokens

---

6. Rename Docker Compose File

Rename compose file using SSH command mv compose-example.yml docker-compose.yml

OR

• Download compose-example.yml from GitHub.
• Drag and drop it into the garmin-grafana folder.
• Rename it to docker-compose.yml.

---

7. Interactive Garmin Login (for 2FA users)

sudo docker pull thisisarpanghosh/garmin-fetch-data:latest
sudo docker-compose run --rm garmin-fetch-data

• Enter your Garmin email, password, and 2FA code when prompted.

---

8. Fix Dashboard Data Source Reference

sudo sed -i 's/\${DS_GARMIN_STATS}/garmin_influxdb/g' Grafana_Dashboard/Garmin-Grafana-Dashboard.json

---

9. Start the Services

sudo docker-compose up -d
sudo docker-compose logs --follow

---

10. Optional: Pull Historical Garmin Data

To sync data for a custom date range (e.g., last year):

cd /volume1/docker/garmingrafana/garmin-grafana
sudo docker-compose run --rm \
  -e MANUAL_START_DATE=2024-01-01 \
  -e MANUAL_END_DATE=2024-12-31 \
  garmin-fetch-data

---

Accessing the Dashboard

1. Open your browser and go to:

   http://<your_nas_ip>:3000
   

2. Login to Grafana

   • Username: admin
   • Password: admin (change after login)

3. Check out the dashboards section on the left panel - your dashboard should be ready there.

---

Notes & Tips

• First-time data fetch may take several minutes
• Make sure InfluxDB and Grafana ports are not blocked on your NAS

[arpanghosh8453]

The question is the Answer :)

[blannoy]

Thank you for the great guide. There's a small error in 10. : should be "docker-compose" instead of "docker compose"

[arpanghosh8453]

Thank you so much @blannoy for pointing that out, you were absolutely right, it was a slip word. Fixed it just now.

[holoholo808]

On the step: sudo docker-compose run --rm garmin-fetch-data

I get following error:

 File "/app/garmin_grafana/garmin_fetch.py", line 135, in garmin_login
    garmin.login(TOKEN_DIR)
    ~~~~~~~~~~~~^^^^^^^^^^^
  File "/app/.venv/lib/python3.13/site-packages/garminconnect/__init__.py", line 231, in login
    self.garth.load(tokenstore)
    ~~~~~~~~~~~~~~~^^^^^^^^^^^^
  File "/app/.venv/lib/python3.13/site-packages/garth/http.py", line 225, in load
    with open(os.path.join(dir_path, "oauth1_token.json")) as f:
         ~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
FileNotFoundError: [Errno 2] No such file or directory: '/home/appuser/.garminconnect/oauth1_token.json'

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "/app/garmin_grafana/garmin_fetch.py", line 1306, in <module>
    garmin_obj = garmin_login()
  File "/app/garmin_grafana/garmin_fetch.py", line 151, in garmin_login
    garmin.garth.dump(TOKEN_DIR)
    ~~~~~~~~~~~~~~~~~^^^^^^^^^^^
  File "/app/.venv/lib/python3.13/site-packages/garth/http.py", line 209, in dump
    with open(os.path.join(dir_path, "oauth1_token.json"), "w") as f:
         ~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
PermissionError: [Errno 13] Permission denied: '/home/appuser/.garminconnect/oauth1_token.json'

Any idea, what is wrong?

[arpanghosh8453]

@holoholo808 Sure! Here the issue is it can't save the access tokens to the tokens directory. You can grant the RW access by running sudo chmod 777 ~/garmin-grafana/garminconnect-tokens and then try the command again.

Let me know if that helps.

[holoholo808]

@arpanghosh8453 That was quick! Thank you. sudo chmod 777 garminconnect-tokens worked fine.