mirror of
https://github.com/stack-auth/stack.git
synced 2026-06-04 21:04:37 +08:00
<!-- 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> [](https://discord.gg/n3SsVDAW6U) [ <!-- 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> for76ef55f58f. 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>
111 lines
4.1 KiB
Bash
111 lines
4.1 KiB
Bash
#!/bin/bash
|
||
|
||
set -e
|
||
|
||
# ============= FORWARD MOCK OAUTH SERVER =============
|
||
|
||
# Start socat to forward port 32202 for mock-oauth-server if enabled
|
||
if [ "$STACK_FORWARD_MOCK_OAUTH_SERVER" = "true" ]; then
|
||
socat TCP-LISTEN:32202,fork,reuseaddr TCP:host.docker.internal:32202 &
|
||
fi
|
||
|
||
# ============= ENV VARS =============
|
||
|
||
export STACK_SEED_INTERNAL_PROJECT_PUBLISHABLE_CLIENT_KEY=$(openssl rand -base64 32)
|
||
export STACK_SEED_INTERNAL_PROJECT_SECRET_SERVER_KEY=$(openssl rand -base64 32)
|
||
export STACK_SEED_INTERNAL_PROJECT_SUPER_SECRET_ADMIN_KEY=$(openssl rand -base64 32)
|
||
|
||
export NEXT_PUBLIC_STACK_PROJECT_ID=internal
|
||
export NEXT_PUBLIC_STACK_PUBLISHABLE_CLIENT_KEY=${STACK_SEED_INTERNAL_PROJECT_PUBLISHABLE_CLIENT_KEY}
|
||
export STACK_SECRET_SERVER_KEY=${STACK_SEED_INTERNAL_PROJECT_SECRET_SERVER_KEY}
|
||
export STACK_SUPER_SECRET_ADMIN_KEY=${STACK_SEED_INTERNAL_PROJECT_SUPER_SECRET_ADMIN_KEY}
|
||
|
||
export NEXT_PUBLIC_BROWSER_STACK_DASHBOARD_URL=${NEXT_PUBLIC_STACK_DASHBOARD_URL}
|
||
export NEXT_PUBLIC_STACK_PORT_PREFIX=${NEXT_PUBLIC_STACK_PORT_PREFIX:-81}
|
||
PORT_PREFIX=${NEXT_PUBLIC_STACK_PORT_PREFIX}
|
||
export NEXT_PUBLIC_SERVER_STACK_DASHBOARD_URL="http://localhost:${PORT_PREFIX}01"
|
||
export NEXT_PUBLIC_BROWSER_STACK_API_URL=${NEXT_PUBLIC_STACK_API_URL}
|
||
export NEXT_PUBLIC_SERVER_STACK_API_URL="http://localhost:${PORT_PREFIX}02"
|
||
export BACKEND_PORT=${BACKEND_PORT:-${PORT_PREFIX}02}
|
||
export DASHBOARD_PORT=${DASHBOARD_PORT:-${PORT_PREFIX}01}
|
||
|
||
export USE_INLINE_ENV_VARS=true
|
||
|
||
if [ -z "${NEXT_PUBLIC_STACK_SVIX_SERVER_URL}" ]; then
|
||
export NEXT_PUBLIC_STACK_SVIX_SERVER_URL=${STACK_SVIX_SERVER_URL}
|
||
fi
|
||
|
||
# ============= MIGRATIONS =============
|
||
|
||
if [ "$STACK_SKIP_MIGRATIONS" = "true" ]; then
|
||
echo "Skipping migrations."
|
||
else
|
||
echo "Running migrations..."
|
||
cd apps/backend
|
||
node dist/db-migrations.js migrate
|
||
cd ../..
|
||
fi
|
||
|
||
if [ "$STACK_SKIP_SEED_SCRIPT" = "true" ]; then
|
||
echo "Skipping seed script."
|
||
else
|
||
echo "Running seed script..."
|
||
cd apps/backend
|
||
node dist/db-migrations.js seed
|
||
cd ../..
|
||
fi
|
||
|
||
# ============= ENV VARS =============
|
||
|
||
# Create a working directory for our processed files
|
||
# This is necessary because we need to replace the env vars in all files and we might want to run the seed script multiple times with different env vars.
|
||
WORK_DIR="/tmp/processed"
|
||
mkdir -p "$WORK_DIR"
|
||
|
||
echo "Copying files to working directory..."
|
||
cp -r /app/. "$WORK_DIR"/.
|
||
|
||
# Find all files in the working directory that contain a STACK_ENV_VAR_SENTINEL and extract the unique sentinel strings.
|
||
unhandled_sentinels=$(find "$WORK_DIR/apps" -type f -exec grep -l "STACK_ENV_VAR_SENTINEL" {} + | \
|
||
xargs grep -h "STACK_ENV_VAR_SENTINEL" | \
|
||
grep -o "STACK_ENV_VAR_SENTINEL[A-Z_]*" | \
|
||
sort -u | grep -v "^STACK_ENV_VAR_SENTINEL$")
|
||
|
||
# Choose an uncommon delimiter – here, we use the ASCII Unit Separator (0x1F)
|
||
delimiter=$(printf '\037')
|
||
|
||
for sentinel in $unhandled_sentinels; do
|
||
# The sentinel is like "STACK_ENV_VAR_SENTINEL_MY_VAR", so extract the env var name.
|
||
env_var=${sentinel#STACK_ENV_VAR_SENTINEL_}
|
||
|
||
# Get the corresponding environment variable value.
|
||
value="${!env_var}"
|
||
|
||
# If the env var is not set, skip replacement.
|
||
if [ -z "$value" ]; then
|
||
continue
|
||
fi
|
||
|
||
# Although the sentinel only contains [A-Z_] we still escape it for any regex meta-characters.
|
||
escaped_sentinel=$(printf '%s\n' "$sentinel" | sed -e 's/\\/\\\\/g' -e 's/[][\/.^$*]/\\&/g')
|
||
|
||
# For the replacement value, first escape backslashes, then escape any occurrence of
|
||
# the chosen delimiter and the '&' (which has special meaning in sed replacements).
|
||
escaped_value=$(printf '%s\n' "$value" | sed -e 's/\\/\\\\/g' -e "s/[${delimiter}&]/\\\\&/g")
|
||
|
||
# Now replace the sentinel with the (properly escaped) value in all files in the working directory.
|
||
find $WORK_DIR/apps -type f -exec sed -i "s${delimiter}${escaped_sentinel}${delimiter}${escaped_value}${delimiter}g" {} +
|
||
done
|
||
|
||
# ============= START BACKEND AND DASHBOARD =============
|
||
|
||
echo "Starting backend on port $BACKEND_PORT..."
|
||
cd "$WORK_DIR"
|
||
PORT=$BACKEND_PORT HOSTNAME=0.0.0.0 node apps/backend/server.js &
|
||
|
||
echo "Starting dashboard on port $DASHBOARD_PORT..."
|
||
PORT=$DASHBOARD_PORT HOSTNAME=0.0.0.0 node apps/dashboard/server.js &
|
||
|
||
# Wait for both to finish
|
||
wait -n
|