Skip to content

BREAKING CHANGE: Fix PocketID for v1.0.0 #4711

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 26, 2025

Conversation

vhsdream
Copy link
Member

@vhsdream vhsdream commented May 25, 2025

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

@vhsdream vhsdream requested review from a team as code owners May 25, 2025 19:42
@github-actions github-actions bot added json update script A change that updates a script website A change to the website labels May 25, 2025
tremor021
tremor021 previously approved these changes May 25, 2025
Copy link
Member

@tremor021 tremor021 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@techieanant
Copy link

I get this error when running the install script

  ✔️  Installed Node.js
 ⠦curl: (23) Failure writing output to destination
  ✔️  Installed Golang
      What public URL do you want to use (e.g. pocketid.mydomain.com)? pocketid.example.com
 ⠧cp: cannot stat '.env.example': No such file or directory
 ⠇
[ERROR] in line 54: exit code 0: while executing command cp .env.example .env
/dev/fd/63: line 74: SPINNER_PID: unbound variable

@MickLesk
Copy link
Member

I get this error when running the install script

  ✔️  Installed Node.js
 ⠦curl: (23) Failure writing output to destination
  ✔️  Installed Golang
      What public URL do you want to use (e.g. pocketid.mydomain.com)? pocketid.example.com
 ⠧cp: cannot stat '.env.example': No such file or directory
 ⠇
[ERROR] in line 54: exit code 0: while executing command cp .env.example .env
/dev/fd/63: line 74: SPINNER_PID: unbound variable

Whats the point in this PR? Its not an issue Section here

@techieanant
Copy link

techieanant commented May 25, 2025

I get this error when running the install script

  ✔️  Installed Node.js
 ⠦curl: (23) Failure writing output to destination
  ✔️  Installed Golang
      What public URL do you want to use (e.g. pocketid.mydomain.com)? pocketid.example.com
 ⠧cp: cannot stat '.env.example': No such file or directory
 ⠇
[ERROR] in line 54: exit code 0: while executing command cp .env.example .env
/dev/fd/63: line 74: SPINNER_PID: unbound variable

Whats the point in this PR? Its not an issue Section here

I ran the install script from this PR hoping it'd work for a fresh pocketid 1.0.0 lxc. Apologies if this is not the right place.

@vhsdream vhsdream marked this pull request as draft May 25, 2025 21:54
@vhsdream vhsdream changed the title Fix PocketID for v1.0.0 BREAKING CHANGE: Fix PocketID for v1.0.0 May 25, 2025
vhsdream added 3 commits May 25, 2025 18:17
- remove Caddy from installation (HTTPS is still a requirement)
- 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
@vhsdream vhsdream marked this pull request as ready for review May 25, 2025 22:18
@MickLesk MickLesk added breaking change A change that is not backward compatible bugfix and removed website A change to the website json labels May 26, 2025
@michelroegl-brunner michelroegl-brunner merged commit ff5b793 into community-scripts:main May 26, 2025
5 checks passed
@vhsdream vhsdream deleted the pocketid branch May 26, 2025 11:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking change A change that is not backward compatible bugfix update script A change that updates a script
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants