Skip to content

docs: Add guide for managing user profile photos (#3280) - #643

Merged
developerjamiu merged 3 commits into
serverpod:mainfrom
abdulawalarif:docs/3280-profile-photo-guide
Jun 29, 2026
Merged

docs: Add guide for managing user profile photos (#3280)#643
developerjamiu merged 3 commits into
serverpod:mainfrom
abdulawalarif:docs/3280-profile-photo-guide

Conversation

@abdulawalarif

Copy link
Copy Markdown
Contributor

Summary

Addresses serverpod/serverpod#3280.

Adds a procedural guide for uploading, updating, and displaying user profile photos with the v3 auth module. The existing Working with users page covered the edit endpoint API but not the full client flow requested in the issue.

New page: docs/06-concepts/11-authentication/profile-photos.md

  • Before you start — auth setup prerequisites and Flutter dependencies
  • Expose the profile edit endpointUserProfileEndpoint, generated client methods, optional access control
  • Upload a profile photo from Flutter — picker helper, setUserImage, error handling
  • Display the profile photoUserProfileModel.imageUrl, CircleAvatar
  • Remove or replace a photo — v3 vs legacy behavior
  • Configure image size and formatUserProfileConfig and server-side processing
  • Configure storage for production — dev URLs, link to file uploads
  • Use server-side APIs for custom logicAuthServices.instance.userProfiles
  • Verify and Troubleshooting sections

Updated: docs/06-concepts/11-authentication/03-working-with-users.md

  • Adds a link to the new guide under Extending the user profile edit endpoint

Test plan

  • Run npm start and open http://localhost:3000/concepts/authentication/profile-photos
  • Verify all sections render correctly
  • Confirm the link from Working with users to profile-photos resolves
  • Confirm links to setup, file uploads, and legacy working-with-users resolve

@developerjamiu

developerjamiu commented Jun 24, 2026

Copy link
Copy Markdown
Contributor

Thanks for this, it's a thorough and accurate guide. A couple of small wording and consistency notes inline.

Comment thread docs/06-concepts/11-authentication/profile-photos.md Outdated
Comment thread docs/06-concepts/11-authentication/profile-photos.md Outdated
Comment thread docs/06-concepts/11-authentication/07-profile-photos.md
Comment thread docs/06-concepts/11-authentication/profile-photos.md Outdated
abdulawalarif and others added 2 commits June 24, 2026 21:35
Rename to 07-profile-photos.md, remove em dashes, reword sentences
that start with code, and use serverpod_auth_idp/serverpod_auth naming.

Co-authored-by: Cursor <cursoragent@cursor.com>
@abdulawalarif

Copy link
Copy Markdown
Contributor Author

@developerjamiu Thanks for the review! I've addressed all the feedback:

  • Renamed the page to 07-profile-photos.md
  • Replaced all em dashes with periods, commas, or colons
  • Reworded sentences that started with code-formatted words
  • Swapped "v3/v2 auth" for serverpod_auth_idp / legacy serverpod_auth naming

Also merged latest main into the branch. Let me know if anything else should change.

@developerjamiu developerjamiu left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

@developerjamiu
developerjamiu merged commit 19adda1 into serverpod:main Jun 29, 2026
4 checks passed
@developerjamiu developerjamiu added the documentation Improvements or additions to documentation label Jun 29, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants