Feat version status sftpgo by thibaut1304 · Pull Request #947 · bastienwirtz/homer

thibaut1304 · 2025-06-21T19:45:37Z

Description

📌 Issue :

There was no native support to display the current version and display active connection for SFTPGo from Homer.

✅ Solution

This PR introduces a new service type SFTPGo:
    Shows the current version in the subtitle
    Shows the number of active SFTP connections
    Maintains Homer’s design philosophy: minimalist, clear, and non-intrusive

Updated customservices.md documentation with configuration instructions

🔥 Motivation

Allows you to see at a glance if there are active connections and the version of our instance

Type of change

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist:

I've read & comply with the contributing guidelines
I have tested my code for new features & regressions on both mobile & desktop devices, using the latest version of major browsers.
I have made corresponding changes to the documentation (README.md).
I've checked my modifications for any breaking changes, especially in the config.yml file

…goApiKey to maintain naming consistency with the rest of the codebase

…ey) to match Homer conventions

thibaut1304 · 2025-06-21T19:59:23Z

Go to the admin portal:
http://localhost:8888/web/admin/login
In the Advanced Settings, enable:
Allow REST API access
Get a bearer token and generate an API key:

export ADMIN_ACCESS_TOKEN=$(curl -s http://localhost:8888/api/v2/token -u "admin:password" | jq -r .access_token)

export ADMIN_API_KEY=$(curl -s -X POST http://localhost:8888/api/v2/apikeys \
  -H "Authorization: Bearer $ADMIN_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name": "admin-key", "scope": 1, "description": "API key for Homer", "admin": "admin", "expires_at": 0}' \
  | jq -r .key)

4.Then test the API:

curl -H "X-SFTPGO-API-KEY: $ADMIN_API_KEY" http://localhost:8888/api/v2/connections

curl -H "X-SFTPGO-API-KEY: $ADMIN_API_KEY" http://localhost:8888/api/v2/version

📘 Full API documentation is available at:

http://<your-sftpgo-host>:<port>/openapi/swagger-ui

thibaut1304 · 2025-06-22T09:25:59Z

⚠️ Just a quick note: I forgot to adapt the mobile version in this PR.
I plan to add a new commit shortly to fix that. Thanks for your patience!

bastienwirtz

Thanks for your contribution @thibaut1304 !
I didn't know about SFTPGo, looks like a cool project.
A few minor thing and we should be good to go 👍

bastienwirtz · 2025-06-29T12:53:17Z

+      }
+      try {
+        const response = await this.fetch("/api/v2/version", { headers });
+        this.versionstring = response.version || "inconnue";


Suggested change

this.versionstring = response.version || "inconnue";

this.versionstring = response.version || "unknown";

Yes, sorry, I will be careful in the future on the new PR to put everything in English.
Fix in this commit 440160f

bastienwirtz · 2025-06-29T12:56:21Z

+        const response = await this.fetch("/api/v2/version", { headers });
+        this.versionstring = response.version || "inconnue";
+
+        const connResponse = await this.fetch("/api/v2/connections", { headers });


could make both requests run in parallel? Using promise for exemple. This way the card would load faster, doing both request at the same time.

Thanks for the suggestion!
Switched to Promise.all so /version and /connections are fetched in parallel; card now renders in one RTT.
fix here : 2d7b8e3

bastienwirtz · 2025-06-29T12:59:50Z

+        this.versionstring = response.version || "inconnue";
+
+        const connResponse = await this.fetch("/api/v2/connections", { headers });
+        this.activeConnections = Array.isArray(connResponse) ? connResponse.length : null;


If the request is successful but connResponse is not an array, does it means there is 0 connections ? If that's the case, I would suggest to change for connResponse.length : 0

The /api/v2/connections route always returns an array even if there are 0 connections! I simplified it in this commit 2d7b8e3

bastienwirtz · 2025-06-29T13:03:40Z

Also, could you add some sample API output here : https://github.com/bastienwirtz/homer/tree/main/dummy-data#dummy-data so I can test it and add it to the demo page ? Thanks !

thibaut1304 · 2025-07-02T13:17:58Z

Also, could you add some sample API output here : https://github.com/bastienwirtz/homer/tree/main/dummy-data#dummy-data so I can test it and add it to the demo page ? Thanks !

I can't get the mock server to work. I figured out from the demo page that I needed to set an endpoint: "/dummy-data/sftpgo," but even then, I can't get it to work.
Yet, I can find the information I want in the network tab!

I added the information anyway, but I couldn't test it. I'd like to know the procedure. Thank you.
278ce56

thibaut1304

This issue ('e' is defined but never used) has been fixed in commit 7db55c6.

bastienwirtz

Thx for your patience 🙏

One last question and we should be good to go !

bastienwirtz · 2025-09-26T19:37:48Z

+          <span v-if="activeConnections !== null && !this.showUpdateAvailable">
+            – Active connections: {{ activeConnections }}


The idea here is to not show the line on small screen right? why showUpdateAvailable is named like that ? It's not related to updates ? or I'm missing something ?
You may be able to reduce the message (for example, just {{ activeConnections }} connections or {{ activeConnections }} clients) to make it fit on most screen and avoid the need to have a matchMedia check.

thibaut1304 added 5 commits June 21, 2025 15:56

add service sftpgo

343d190

update customerservices

47bd7ec

add number of active connections and i renamed sftpgo_api_key to sftp…

fe0e164

…goApiKey to maintain naming consistency with the rest of the codebase

i renamed sftpgo_api_key to sftpgoApiKey

6500ecb

fix: use snake_case (sftpgo_api_key) instead of camelCase (sftpgoApiK…

df9f4cb

…ey) to match Homer conventions

bastienwirtz requested changes Jun 29, 2025

View reviewed changes

thibaut1304 added 3 commits July 2, 2025 13:14

fix english/french (api version) unknown

440160f

fix dual call fetch with one RTT (Promise.all)

2d7b8e3

fix version mobile hidden connection on mobile

000b076

add dummy data service sftpgo

278ce56

thibaut1304 requested a review from bastienwirtz July 2, 2025 13:32

fix catch ('e' is defined but never used)

7db55c6

thibaut1304 commented Jul 2, 2025

View reviewed changes

bastienwirtz reviewed Sep 26, 2025

View reviewed changes

	this.versionstring = response.version \|\| "inconnue";
	this.versionstring = response.version \|\| "unknown";

		<span v-if="activeConnections !== null && !this.showUpdateAvailable">
		– Active connections: {{ activeConnections }}

Uh oh!

Conversation

thibaut1304 commented Jun 21, 2025

Description

Type of change

Checklist:

Uh oh!

thibaut1304 commented Jun 21, 2025

Uh oh!

thibaut1304 commented Jun 22, 2025

Uh oh!

bastienwirtz left a comment

Choose a reason for hiding this comment

Uh oh!

bastienwirtz Jun 29, 2025

Choose a reason for hiding this comment

Uh oh!

thibaut1304 Jul 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bastienwirtz Jun 29, 2025

Choose a reason for hiding this comment

Uh oh!

thibaut1304 Jul 2, 2025

Choose a reason for hiding this comment

Uh oh!

bastienwirtz Jun 29, 2025

Choose a reason for hiding this comment

Uh oh!

thibaut1304 Jul 2, 2025

Choose a reason for hiding this comment

Uh oh!

bastienwirtz commented Jun 29, 2025

Uh oh!

thibaut1304 commented Jul 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

thibaut1304 left a comment

Choose a reason for hiding this comment

Uh oh!

bastienwirtz left a comment

Choose a reason for hiding this comment

Uh oh!

bastienwirtz Sep 26, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

thibaut1304 Jul 2, 2025 •

edited

Loading

thibaut1304 commented Jul 2, 2025 •

edited

Loading