mirror of https://github.com/stack-auth/stack.git synced 2026-06-04 21:04:37 +08:00

History

Konsti Wohlwend 3d4c608187 Customizable ports (#962 ) <!-- ONTRIBUTING.md guidelines: https://github.com/stack-auth/stack-auth/blob/dev/CONTRIBUTING.md --> <!-- RECURSEML_SUMMARY:START --> ## High-level PR Summary This PR changes the default development ports for several background services to avoid conflicts. PostgreSQL moves from port `5432` to `8128`, Inbucket SMTP from `2500` to `8129`, Inbucket POP3 from `1100` to `8130`, and the OpenTelemetry collector from `4318` to `8131`. All references across configuration files, Docker Compose setups, environment files, CI/CD workflows, test files, and documentation have been updated to reflect these new port assignments. A knowledge base document has been added to document the new port mappings. ⏱️ Estimated Review Time: 15-30 minutes <details> <summary>💡 Review Order Suggestion</summary> \| Order \| File Path \| \| --- \| --- \| \| 1 \| `claude/CLAUDE-KNOWLEDGE.md` \| \| 2 \| `apps/dev-launchpad/public/index.html` \| \| 3 \| `docker/dependencies/docker.compose.yaml` \| \| 4 \| `docker/emulator/docker.compose.yaml` \| \| 5 \| `apps/backend/.env` \| \| 6 \| `apps/backend/.env.development` \| \| 7 \| `docker/server/.env.example` \| \| 8 \| `package.json` \| \| 9 \| `.devcontainer/devcontainer.json` \| \| 10 \| `apps/e2e/.env.development` \| \| 11 \| `.github/workflows/check-prisma-migrations.yaml` \| \| 12 \| `.github/workflows/docker-server-test.yaml` \| \| 13 \| `.github/workflows/e2e-api-tests.yaml` \| \| 14 \| `.github/workflows/e2e-source-of-truth-api-tests.yaml` \| \| 15 \| `.github/workflows/restart-dev-and-test.yaml` \| \| 16 \| `apps/e2e/tests/backend/endpoints/api/v1/internal/email-drafts.test.ts` \| \| 17 \| `apps/e2e/tests/backend/endpoints/api/v1/internal/email.test.ts` \| \| 18 \| `apps/e2e/tests/backend/endpoints/api/v1/send-email.test.ts` \| \| 19 \| `apps/e2e/tests/backend/endpoints/api/v1/unsubscribe-link.test.ts` \| \| 20 \| `apps/e2e/tests/backend/workflows.test.ts` \| \| 21 \| `docs/templates/others/self-host.mdx` \| </details> [![Need help? Join our Discord](https://img.shields.io/badge/Need%20help%3F%20Join%20our%20Discord-5865F2?style=plastic&logo=discord&logoColor=white)](https://discord.gg/n3SsVDAW6U) [![Analyze latest changes](`21c3d5c362`/?repo_owner=stack-auth&repo_name=stack-auth&pr_number=962) <!-- RECURSEML_SUMMARY:END --> <!-- ELLIPSIS_HIDDEN --> ---- > [!IMPORTANT] > This PR introduces customizable development ports using `NEXT_PUBLIC_STACK_PORT_PREFIX`, updating configurations, documentation, and tests accordingly. > > - Behavior: > - Default development ports for services are now customizable via `NEXT_PUBLIC_STACK_PORT_PREFIX`. > - PostgreSQL port changed from `5432` to `${NEXT_PUBLIC_STACK_PORT_PREFIX:-81}28`. > - Inbucket SMTP port changed from `2500` to `${NEXT_PUBLIC_STACK_PORT_PREFIX:-81}29`. > - Inbucket POP3 port changed from `1100` to `${NEXT_PUBLIC_STACK_PORT_PREFIX:-81}30`. > - OpenTelemetry collector port changed from `4318` to `${NEXT_PUBLIC_STACK_PORT_PREFIX:-81}31`. > - Configuration: > - Updated `docker.compose.yaml` to use new port variables for services like PostgreSQL, Inbucket, and OpenTelemetry. > - Environment files in `apps/backend`, `apps/dashboard`, and `apps/e2e` updated to use `NEXT_PUBLIC_STACK_PORT_PREFIX`. > - `package.json` scripts updated to reflect new port configurations. > - Documentation: > - Added `CLAUDE-KNOWLEDGE.md` to document new port mappings. > - Updated `self-host.mdx` to reflect new port configurations. > - Testing: > - Updated test files in `apps/e2e/tests` to use new port configurations. > - Added `helpers/ports.ts` for port-related utilities in tests. > > <sup>This description was created by </sup>[<img alt="Ellipsis" src="https://img.shields.io/badge/Ellipsis-blue?color=175173">](https://www.ellipsis.dev?ref=stack-auth%2Fstack-auth&utm_source=github&utm_medium=referral)<sup> for `76ef55f58f`. You can [customize](https://app.ellipsis.dev/stack-auth/settings/summaries) this summary. It will automatically update as commits are pushed.</sup> ---- <!-- ELLIPSIS_HIDDEN --> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - New Features - Enable configurable development ports via a NEXT_PUBLIC_STACK_PORT_PREFIX, allowing parallel local environments with custom port prefixes. - Bug Fixes - Updated local service port mappings and CI/workflow settings so tooling and tests use the new prefixed ports consistently. - Documentation - Added docs and contributor guidance for running multiple parallel workspaces with custom port prefixes. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: N2D4 <N2D4@users.noreply.github.com>		2025-10-20 15:24:47 -07:00
..
scripts	Widget playground mobile mode	2025-07-14 20:04:43 -07:00
src	Customizable ports (#962 )	2025-10-20 15:24:47 -07:00
.env	Vanilla JS client library (#408 )	2025-02-08 02:31:03 +01:00
.eslintrc.cjs	tsup for stack-shared (#647 )	2025-04-28 21:26:52 -07:00
.gitignore	Vanilla JS client library (#408 )	2025-02-08 02:31:03 +01:00
CHANGELOG.md	chore: update package versions	2025-10-20 14:35:32 -07:00
components.json	Vanilla JS client library (#408 )	2025-02-08 02:31:03 +01:00
LICENSE	Vanilla JS client library (#408 )	2025-02-08 02:31:03 +01:00
next-env.d.ts	Vanilla JS client library (#408 )	2025-02-08 02:31:03 +01:00
package-template.json	chore: update package versions	2025-10-20 14:35:32 -07:00
package.json	chore: update package versions	2025-10-20 14:35:32 -07:00
postcss.config.js	Vanilla JS client library (#408 )	2025-02-08 02:31:03 +01:00
quetzal.config.json	Vanilla JS client library (#408 )	2025-02-08 02:31:03 +01:00
README.md	Update branding from Stack to Stack Auth in documentation (#504 )	2025-03-04 04:07:54 +01:00
tailwind.config.js	Vanilla JS client library (#408 )	2025-02-08 02:31:03 +01:00
tsconfig.json	In-source unit tests (#429 )	2025-02-14 11:47:52 -08:00
tsup.config.ts	Convex README	2025-10-10 04:27:05 -07:00
vitest.config.ts	In-source unit tests (#429 )	2025-02-14 11:47:52 -08:00

README.md

Stack Auth: Open-source Clerk/Auth0 alternative

📘 Docs | ☁️ Hosted Version | ✨ Demo | 🎮 Discord | GitHub

Stack Auth is a managed user authentication solution. It is developer-friendly and fully open-source (licensed under MIT and AGPL).

Stack Auth gets you started in just five minutes, after which you'll be ready to use all of its features as you grow your project. Our managed service is completely optional and you can export your user data and self-host, for free, at any time.

We support Next.js frontends, along with any backend that can use our REST API. Check out our setup guide to get started.

📦 Installation & Setup

Run Stack Auth's installation wizard with the following command:
```
npx @stackframe/init-stack@latest
```
Then, create an account on the Stack Auth dashboard, create a new project with an API key, and copy its environment variables into the .env.local file of your Next.js project:
```
NEXT_PUBLIC_STACK_PROJECT_ID=<your-project-id>
NEXT_PUBLIC_STACK_PUBLISHABLE_CLIENT_KEY=<your-publishable-client-key>
STACK_SECRET_SERVER_KEY=<your-secret-server-key>
```
That's it! You can run your app with npm run dev and go to http://localhost:3000/handler/signup to see the sign-up page. You can also check out the account settings page at http://localhost:3000/handler/account-settings.

Check out the documentation for a more detailed guide.