API to send POSTs from Homepage? Or way to run local scripts?

[Kribensisis]

Description

Edit: See the bot response down below. I'm now looking for recommendations on an API service to use with Homepage to turn its GET requests into POST to Rclone. OR, any ways in Homepage to click a link and run a local script on my NAS.

Hi, could really use some help with this. I've asked in several places, including the Discord. I use Rclone to copy a remote server to my NAS, where homepage is installed. I want to be able to run the copy from homepage.

I looked at using OliveTin to just run scripts right on my NAS, but that means adding another dashboard and it's more than I need.

Use case: On homepage, click a link to run a custom API call: a POST to rclone's sync endpoint with a few custom params and basic authentication (required for the call). This works in Postman and returns a jobid, after which the copy runs.

I don't expect anyone to read the Rclone docs to help me, but here's the working cURL.

curl --location 'http://100.100.1.100:123/sync/copy' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Basic base64base64' \
--data-urlencode 'srcFs=myremoteserver:/path/to/files' \
--data-urlencode 'dstFs=/volume1/files' \
--data-urlencode '_async=true'

And here's my services.yaml which I'm definitely messing up:

- Tools:
    - Copy Server:
        href: http://100.100.1.100:111
        icon: https://path/to/icon.png
        widget:
          type: customapi
          url: http://100.100.1.100:111/sync/copy
          username: user
          password: password
          method: POST
          requestBody:
            srcFs: server:/path/to/files
            dstFs: /volume1/files
            _async: true  

That gets me this in the console:

GET http://my-nas:3000/api/services/proxy?type=customapi&group=Tools&service=Copy+Server&endpoint=null&query=%7B%22refreshInterval%22%3A10000%7D 400 (Bad Request)

That's obviously never going to work since it's running a GET and endpoint=null, but I don't know how to fix it.

Thanks for any help!

homepage version

v0.8.13

Installation method

Docker

Configuration

No response

Container Logs

No response

Browser Logs

No response

Troubleshooting

N/A

[glime-ai[bot]]

Thanks for posting a discussion about homepage here on GitHub. Homepage now uses a fancy new AI tool thanks to our friends at Glime, so the answer below is the AI bot's attempt to answer your question. If you feel it's sufficient you can mark the answer and close this post, otherwise feel free to leave it open of course!

Thanks for using Homepage! ❤️

---

It seems like you're trying to configure a custom API call within the Homepage dashboard to trigger an Rclone sync operation. Based on the information you've provided, there are a few things to consider:

1. Custom API Widget: Homepage does not natively support a 'customapi' widget type that can be configured directly through services.yaml. This means you cannot set up a POST request with a body directly from the Homepage configuration file.

2. Method of Triggering the API Call: Since Homepage doesn't support the custom API call directly, you would need to implement a workaround. One option could be to create a small web service that can accept a GET request from Homepage and then trigger the POST request to Rclone with the necessary parameters and authentication.

3. Implementation: You could implement the web service in a language of your choice (e.g., Node.js, Python, etc.) and run it as a separate container or process on your NAS. This service would expose an endpoint that Homepage can hit with a GET request, and upon receiving that request, it would then perform the POST request to Rclone.

4. Homepage Configuration: Once you have the web service running, you would configure a service in services.yaml that points to the new service's endpoint. For example:

- Tools:
    - Copy Server:
        href: http://my-nas:3000/triggerRcloneSync
        icon: https://path.to/icon.png

5. Security Considerations: Ensure that the web service you create is secure, especially since it involves authentication credentials. You might want to restrict access to it and ensure that it's not exposed to the public internet.

6. Documentation and Support: Since this is a custom implementation, you would need to rely on your own documentation and support. You might find it helpful to discuss your approach on the Homepage GitHub discussions or Discord to get feedback from the community.

Unfortunately, without direct support for custom API POST requests within Homepage, you'll need to implement an intermediary service to achieve your goal. If you're not comfortable setting up such a service, you might need to consider other dashboard solutions that support custom scripts or API calls directly.

This comment was generated by Glime.

[Kribensisis]

Okay, did not expect that detailed bot response about my exact question 😂

This thread now becomes a question about whether there are any out-of-the box APIs that can be the middleman between Homepage and Rclone. Updating the title.

[github-actions[bot]]

This discussion has been automatically closed due to inactivity. See our contributing guidelines for more details.

[github-actions[bot]]

This discussion has been automatically locked since there has not been any recent activity after it was closed. Please open a new discussion for related concerns. See our contributing guidelines for more details.