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

Open
opened 2025-11-20 07:04:45 -05:00 by saavagebueno · 0 comments
Owner

Original Pull Request: https://github.com/community-scripts/ProxmoxVE/pull/4711

State: closed
Merged: Yes


✍️ 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
  }

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.
**Original Pull Request:** https://github.com/community-scripts/ProxmoxVE/pull/4711 **State:** closed **Merged:** Yes --- ## ✍️ 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.
saavagebueno added the pull-request label 2025-11-20 07:04:45 -05:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: SVI/ProxmoxVE#5190