YTMD/youtube-music
1
0
Fork 0
Code Issues 445 Pull requests 34 Projects Releases 87 Packages Wiki Activity Actions

feat(api-server): Add HTTPS support and custom certificate configuration #3874

Open
mohanad-80 wants to merge 7 commits from mohanad-80/https-api-server into master
pull from: mohanad-80/https-api-server
merge into: YTMD:master
Conversation 0 Commits 7 Files changed 5 +103 -11
mohanad-80 commented 2025-09-11 15:59:09 +00:00 (Migrated from github.com)
Copy link

Description:
This PR adds HTTPS support to the API server plugin, allowing users to enable HTTPS and provide custom certificate and private key files for secure API access.

Key changes:

  • Added useHttps, certPath, and keyPath fields to the API server config.
  • Updated the plugin menu to include a submenu for HTTPS settings, allowing users to:
    • Enable/disable HTTPS.
    • Select certificate and private key files via file dialogs.
  • Updated backend logic to start an HTTPS server when enabled, using the provided certificate and key.
  • Ensured the server restarts automatically when any relevant config changes (hostname, port, useHttps, certPath, keyPath).
  • Added i18n strings for the new menu items and dialogs.

Why:
This enables secure remote control and API access over HTTPS, addressing feature request #3647.

Testing:

  • Tested HTTP and HTTPS modes on Windows.
  • Verified that changing certificate/key paths and toggling HTTPS restarts the server as expected.
  • Confirmed that WebSocket routes work with HTTPS.

closes #3647

**Description:** This PR adds HTTPS support to the API server plugin, allowing users to enable HTTPS and provide custom certificate and private key files for secure API access. **Key changes:** - Added `useHttps`, `certPath`, and `keyPath` fields to the API server config. - Updated the plugin menu to include a submenu for HTTPS settings, allowing users to: - Enable/disable HTTPS. - Select certificate and private key files via file dialogs. - Updated backend logic to start an HTTPS server when enabled, using the provided certificate and key. - Ensured the server restarts automatically when any relevant config changes (hostname, port, useHttps, certPath, keyPath). - Added i18n strings for the new menu items and dialogs. **Why:** This enables secure remote control and API access over HTTPS, addressing feature request [#3647](https://github.com/th-ch/youtube-music/issues/3647). **Testing:** - Tested HTTP and HTTPS modes on Windows. - Verified that changing certificate/key paths and toggling HTTPS restarts the server as expected. - Confirmed that WebSocket routes work with HTTPS. --- closes #3647
This pull request can be merged automatically.
You are not authorized to merge this pull request.
View command line instructions

Checkout

From your project repository, check out a new branch and test the changes.
git fetch -u origin mohanad-80/https-api-server:mohanad-80/https-api-server
git switch mohanad-80/https-api-server

Merge

Merge the changes and update on Forgejo.

Warning: The "Autodetect manual merge" setting is not enabled for this repository, you will have to mark this pull request as manually merged afterwards.

git switch master
git merge --no-ff mohanad-80/https-api-server
git switch mohanad-80/https-api-server
git rebase master
git switch master
git merge --ff-only mohanad-80/https-api-server
git switch mohanad-80/https-api-server
git rebase master
git switch master
git merge --no-ff mohanad-80/https-api-server
git switch master
git merge --squash mohanad-80/https-api-server
git switch master
git merge --ff-only mohanad-80/https-api-server
git switch master
git merge mohanad-80/https-api-server
git push origin master
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels   
awaiting-reply

Awaiting reply

  
breaking changes

   
bug

Something isn't working

  
cannot-reproduce

Bug cannot be reproduced

  
dependencies

Pull requests that update a dependency file

  
documentation

   
duplicate

This issue or pull request already exists

  
electron-issue

It's an Electron or Electron related dependencies issue (not YTM-Desktop issue)

  
enhancement

New feature or request

  
fix-available

A fix to the issue is available in a new version

  
good first issue

Good for newcomers

  
help wanted

Extra attention is needed

  
invalid

This doesn't seem right

  
javascript

Pull requests that update javascript code

  
need more information

Need more information about the issue

  
need rebase

This plugin need rebase

  
official-youtube-music-issue

It's an YouTube's issue (not YTM-Desktop issue)

  
plugin request

An issue/discussion requesting for a new plugin or new functionality to an existing plugin.

  
question

Further information is requested

  
release

Release

  
security

   
stale

   
Status: blocked

There are something to do before this

  
typo

   
wontfix

This will not be worked on

  
ytmd-issue

An issue/discussion about ytm desktop, unrelated to th-ch/youtube-music

No labels
awaiting-reply
breaking changes
bug
cannot-reproduce
dependencies
documentation
duplicate
electron-issue
enhancement
fix-available
good first issue
help wanted
invalid
javascript
need more information
need rebase
official-youtube-music-issue
plugin request
question
release
security
stale
Status: blocked
typo
wontfix
ytmd-issue
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: YTMD/youtube-music#3874
No description provided.
Delete branch "mohanad-80/https-api-server"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?