Skip to content
View packages
← Client Portal

INSTALLATION GUIDE / 0.6.0-alpha.1

Add Client Portal to your Seedly.

Use your own separately licensed Seedly CRM 5.9.6, extension API 1, Node.js 22.13+, npm and your host’s pnpm version. The module includes original source only.

1. Download and verify

Open your private download with your checkout email or active All Access account. Download the archive and integrity manifest. Verify the archive SHA-256, extract it, and read README.md, QUICKSTART.md and docs/AGENT_INSTALL.md.

2. Install into a backed-up test host

Preserve your changes first. Give your coding assistant the extracted module folder and the absolute path to the designated licensed host. Run from the extracted module folder:

node bin/install.mjs --seedly /absolute/path/to/seedly
node bin/install.mjs --seedly /absolute/path/to/seedly --apply
node bin/doctor.mjs --seedly /absolute/path/to/seedly

The first command previews the installation. The installer validates compatibility, records file hashes and contributes marked extension blocks. It does not deploy or send invitations.

3. Install the PDF reader and validate

From the installed host root, install the isolated pinned dependency, then run doctor again from the module folder:

npm ci --ignore-scripts --omit=optional --prefix apps/web/components/seedly-client-delivery/pdf-runtime
npx pnpm exec convex codegen --typecheck enable
npx pnpm --filter @seedly-crm/web typecheck

Confirm your intended development backend before code generation. Follow QUICKSTART.md to run the included backend tests, navigation guard and host production build. Deploy your own backend before its web app using your host’s normal release process.

4. Configure the client experience

  1. Give staff the native Client Delivery permissions and appropriate Contacts, Settings and Conversations permissions.
  2. Create a workspace for an existing client. Share selected requests, deliverables, milestones and native records.
  3. Open Portal settings → Portal modules to choose names, order, visibility, landing page and record sources. Messages is disabled by default.
  4. Use the full-screen builder for section widths, placement, spacing, alignment and backgrounds. Preview the selected client and save the layout.
  5. Set contact, workspace, member and record restrictions. Hiding a layout section alone does not revoke access.
  6. Configure the trusted HTTPS origin, invitation lifetime, copy and delivery mode. Review the exact recipient and invitation before copying or sending. Test the actual client experience.

Useful limits and recovery

File previews support PDF, PNG, JPEG, WebP and text up to 2 MiB. Messaging is text-only through a dedicated native conversation. Client portal links are bearer credentials; revoke native contact portal access to invalidate them.

Read docs/PORTAL_CONTROLS.md, docs/PORTAL_BUILDER.md, docs/PORTAL_MODULES.md and the recovery instructions in QUICKSTART.md. Keep the installer receipt, reconcile modified owned files before upgrades and validate after every host update.

Download Client Portal →