SagerNet / SagerNet/sing-box

[Feauture Request] Adding the ability to manage Auto Update option through a specific URL Scheme

Open
#2,140 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Go
Stars
38.1k
Forks
4.6k
Avg merge
19d 15h
Merged PRs (30d)
1

Description

Operating system

Android

System version

anyVersion & anyTypeOfDevices

Installation type

Others

If you are using a graphical client, please provide the version of the client.

No response

Version

No response

Description

Dear @nekohasekai,

I would like to propose an enhancement to the application’s functionality that will allow users to manage auto-update parameters when importing profiles via remote links in the format sing-box://import-remote-profile?url=urlEncodedURL#urlEncodedName.

Currently, the ability to modify auto-update parameters (enable/disable and interval) is only available through the user interface. This limits user flexibility as they cannot predefine these parameters in the link.

Proposed Changes:
Support for parameters in the URL:

Implement the ability to pass auto-update parameters through the URL. For example:
Auto Update Enabled
sing-box://import-remote-profile?url=urlEncodedURL&autoUpdate=true&autoUpdateInterval=60#urlEncodedName
or it may be leave as it is: sing-box://import-remote-profile?url=urlEncodedURL#urlEncodedName.
Auto UpdateDisabled
sing-box://import-remote-profile?url=urlEncodedURL&autoUpdate=false&autoUpdateInterval=0#urlEncodedName

Modifying profile handling logic:

In the method that handles profile imports, add logic to extract the autoUpdate and interval parameters from the URL.
Set the corresponding values in the TypedProfile object.

This will add flexibility and simplify the use of the application for users who prefer to set up their profiles in advance.

Reproduction

There is no error. It is a Feauture Request.

Logs

No response

Supporter
Integrity requirements
  • I confirm that I have read the documentation, understand the meaning of all the configuration items I wrote, and did not pile up seemingly useful options or default values.
  • I confirm that I have provided the server and client configuration files and process that can be reproduced locally, instead of a complicated client configuration file that has been stripped of sensitive data.
  • I confirm that I have provided the simplest configuration that can be used to reproduce the error I reported, instead of depending on remote servers, TUN, graphical interface clients, or other closed-source software.
  • I confirm that I have provided the complete configuration files and logs, rather than just providing parts I think are useful out of confidence in my own intelligence.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate the profile-import handling method and the TypedProfile object mentioned in the issue, then inspect how the sing-box:// URL parameters are parsed. Done means import URLs can set autoUpdate and autoUpdateInterval while preserving the existing behavior when those parameters are absent.

Written by the indexing model from the issue text.

Assessment

Tech stack
android
Domain
mobile
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.