Skip to content

Document DEV_APP_PORT env var #815

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.

Sign up for GitHub

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

Open
AlexGaillard wants to merge 1 commit into
base: main
Choose a base branch
from
+12 −0
Open

Document DEV_APP_PORT env var #815

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions content/configuration/1.general.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,18 @@ When `LICENSE_KEY` or `LICENSE_TOKEN` is set in the environment, any license key

All `SERVER_*` environment variables are merged with `server` instance properties created from [http.Server](https://github.com/nodejs/node/blob/master/doc/api/http.md#class-httpserver). This allows to configure server behind a proxy, a load balancer, etc. Be careful to not override methods of this instance otherwise you may incur into unexpected behaviors.

### Development

These variables only apply when running Directus from source in development mode (`NODE_ENV=development`), such as when contributing to the project. They have no effect on a production build or a deployed instance.

| Variable | Description | Default Value |
| -------------- | -------------------------------------------------------------- | ------------- |
| `DEV_APP_PORT` | Port for the Data Studio development server started by Vite. | `8080` |

::callout{icon="i-lucide-info"}
`DEV_APP_PORT` is separate from the API's `PORT`. When it is set, the development server fails to start if the port is already in use. When it is left unset, the server starts on `8080` and automatically increments to the next free port if `8080` is taken. Invalid values (non-integer, below `1`, or above `65535`) are ignored and fall back to `8080` with a warning.
::

## First Admin User

The following commands set details for the first admin user created when the project is bootstrapped.
Expand Down
Loading