SVI/ProxmoxVE
1
0
Fork 0
mirror of https://github.com/community-scripts/ProxmoxVE.git synced 2026-03-31 06:34:17 -04:00
Code Issues 2.6k Packages Projects Releases 10 Wiki Activity

[PR #4711] [MERGED] BREAKING CHANGE: Fix PocketID for v1.0.0 #5189

New Issue
Open
opened 2025-11-20 07:04:45 -05:00 by saavagebueno · 0 comments
saavagebueno commented 2025-11-20 07:04:45 -05:00
Owner
Copy Link

📋 Pull Request Information

Original PR: https://github.com/community-scripts/ProxmoxVE/pull/4711
Author: @vhsdream
Created: 5/25/2025
Status: ✅ Merged
Merged: 5/26/2025
Merged by: @michelroegl-brunner

Base: main ← Head: pocketid

📝 Commits (3)

  • 8b60977 PocketID: update for v1.0.0
  • 2514f9a PocketID: update pocketid.json
  • 494c5fd PocketID: remove commented-out lines

📊 Changes

3 files changed (+74 additions, -139 deletions)

View changed files

📝 ct/pocketid.sh (+53 -54)
📝 frontend/public/json/pocketid.json (+2 -6)
📝 install/pocketid-install.sh (+19 -79)

📄 Description

✍️ Description

  • remove Caddy from installation (HTTPS is still a requirement). See note about Breaking change below
  • remove NodeJS and Go dependencies
  • consolidate frontend & backend service into one
  • update .env file
  • install compiled binary instead of compiling from release source
  • add migration path for versions pre-1.0.0 to pocketid.sh

⚠️ Breaking change

Previous versions of PocketID used Caddy to serve the frontend. Now that is no longer required. This PR will remove Caddy. The config has been moved to /root/Caddyfile.bak. If you were also using Caddy in the same LXC to generate a TLS cert and serve PocketID behind a subdomain, you will need to reinstall Caddy and fix the Caddyfile to use the updated configuration.

Users who configured Caddy on a separate LXC also need to adjust their configurations.

Example Caddy config

@id host id.xxxx.xyz
  handle @id {
    reverse_proxy http://pocketid.internal.lan:1411
  }

🔗 Related PR / Issue

Link: #4710

✅ Prerequisites (X in brackets)

  • Self-review completed – Code follows project standards.
  • Tested thoroughly – Changes work as expected.
  • No security risks – No hardcoded secrets, unnecessary privilege escalations, or permission issues.

🛠️ Type of Change (X in brackets)

  • 🐞 Bug fix – Resolves an issue without breaking functionality.
  • ✨ New feature – Adds new, non-breaking functionality.
  • 💥 Breaking change – Alters existing functionality in a way that may require updates.
  • 🆕 New script – A fully functional and tested script or script set.
  • 🌍 Website update – Changes to website-related JSON files or metadata.
  • 🔧 Refactoring / Code Cleanup – Improves readability or maintainability without changing functionality.
  • 📝 Documentation update – Changes to README, AppName.md, CONTRIBUTING.md, or other docs.

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/community-scripts/ProxmoxVE/pull/4711 **Author:** [@vhsdream](https://github.com/vhsdream) **Created:** 5/25/2025 **Status:** ✅ Merged **Merged:** 5/26/2025 **Merged by:** [@michelroegl-brunner](https://github.com/michelroegl-brunner) **Base:** `main` ← **Head:** `pocketid` --- ### 📝 Commits (3) - [`8b60977`](https://github.com/community-scripts/ProxmoxVE/commit/8b60977c78ac0d2a7b11efea13adc5fdbcb55561) PocketID: update for v1.0.0 - [`2514f9a`](https://github.com/community-scripts/ProxmoxVE/commit/2514f9ab6722cb326220a8ca4999d2a905f6170f) PocketID: update pocketid.json - [`494c5fd`](https://github.com/community-scripts/ProxmoxVE/commit/494c5fdc0667a2c3714ae43b3421ebc2a0be6e3a) PocketID: remove commented-out lines ### 📊 Changes **3 files changed** (+74 additions, -139 deletions) <details> <summary>View changed files</summary> 📝 `ct/pocketid.sh` (+53 -54) 📝 `frontend/public/json/pocketid.json` (+2 -6) 📝 `install/pocketid-install.sh` (+19 -79) </details> ### 📄 Description ## ✍️ Description - remove Caddy from installation (HTTPS is still a requirement). See note about Breaking change below - remove NodeJS and Go dependencies - consolidate frontend & backend service into one - update .env file - install compiled binary instead of compiling from release source - add migration path for versions pre-1.0.0 to pocketid.sh ## ⚠️ Breaking change Previous versions of PocketID used Caddy to serve the frontend. Now that is no longer required. This PR will **remove** Caddy. The config has been moved to `/root/Caddyfile.bak`. If you were also using Caddy in the same LXC to generate a TLS cert and serve PocketID behind a subdomain, you will need to reinstall Caddy and fix the Caddyfile to use the updated configuration. Users who configured Caddy on a separate LXC also need to adjust their configurations. ### Example Caddy config ```bash @id host id.xxxx.xyz handle @id { reverse_proxy http://pocketid.internal.lan:1411 } ``` ## 🔗 Related PR / Issue Link: #4710 ## ✅ Prerequisites (**X** in brackets) - [x] **Self-review completed** – Code follows project standards. - [x] **Tested thoroughly** – Changes work as expected. - [x] **No security risks** – No hardcoded secrets, unnecessary privilege escalations, or permission issues. --- ## 🛠️ Type of Change (**X** in brackets) - [ ] 🐞 **Bug fix** – Resolves an issue without breaking functionality. - [ ] ✨ **New feature** – Adds new, non-breaking functionality. - [x] 💥 **Breaking change** – Alters existing functionality in a way that may require updates. - [ ] 🆕 **New script** – A fully functional and tested script or script set. - [x] 🌍 **Website update** – Changes to website-related JSON files or metadata. - [ ] 🔧 **Refactoring / Code Cleanup** – Improves readability or maintainability without changing functionality. - [ ] 📝 **Documentation update** – Changes to `README`, `AppName.md`, `CONTRIBUTING.md`, or other docs. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
saavagebueno added the pull-request label 2025-11-20 07:04:45 -05:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
🛑 Failure to comply with the guidelines
breaking change
bug
bug
bugfix
deferred
delete script
dependencies
enhancement
external
feature
github
help wanted
Implemented in VED waiting push to Main
in project pipeline
invalid
investigation
json
maintenance
new script
new script
nice to have
not a script issue
not planned
organization
pull-request
Mirrored from GitHub Pull Request
 question
refactor
rename script
security
update script
website
wontdo
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
saavagebueno
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: SVI/ProxmoxVE#5189
Delete Branch "%!s()"

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?