centersl/dify-docs
1
0
Fork 0
mirror of https://github.com/langgenius/dify-docs.git synced 2026-03-26 13:18:34 +07:00
Code Issues Packages Projects Releases Wiki Activity

update the note for when the frontend and backend run on different subdomains (#588)

Browse Source 
* update the note for when the frontend and backend run on different subdomains

* Update en/self-host/quick-start/docker-compose.mdx

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

---------

Co-authored-by: Riskey <riskey47@dify.ai>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This commit is contained in:
Riskey
2025-12-06 00:36:39 +08:00
committed by GitHub
parent 4a628baea1
commit a189a5db67
3 changed files with 66 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files

43
en/self-host/advanced-deployments/local-source-code.mdx
View File

@@ -44,7 +44,7 @@ The backend services include
2. Worker Service: serving the aync tasks for datasets processing, workspaces, cleaning-ups etc. 2. Worker Service: serving the aync tasks for datasets processing, workspaces, cleaning-ups etc.
### Start API service ### Start API Service
1. Navigate to the `api` directory: 1. Navigate to the `api` directory:
@@ -52,19 +52,25 @@ The backend services include
cd api cd api
``` ```
2. Prepare the environment variable config file 2. Prepare the environment variable config file:
``` ```
cp .env.example .env cp .env.example .env
``` ```
3. Generate a random secret key and replace the value of SECRET_KEY in the .env file <Note>
When the frontend and backend run on different subdomains, set `COOKIE_DOMAIN` to the site's top-level domain (e.g., `example.com`) in the `.env` file.
The frontend and backend must be under the same top-level domain to share authentication cookies.
</Note>
3. Generate a random secret key and replace the value of SECRET_KEY in the `.env` file:
``` ```
awk -v key="$(openssl rand -base64 42)" '/^SECRET_KEY=/ {sub(/=.*/, "=" key)} 1' .env > temp_env && mv temp_env .env awk -v key="$(openssl rand -base64 42)" '/^SECRET_KEY=/ {sub(/=.*/, "=" key)} 1' .env > temp_env && mv temp_env .env
``` ```
4. Dependencies installation 4. Install dependencies:
[uv](https://docs.astral.sh/uv/getting-started/installation/) is used to manage dependencies. [uv](https://docs.astral.sh/uv/getting-started/installation/) is used to manage dependencies.
Install the required dependencies with `uv` by running: Install the required dependencies with `uv` by running:
@@ -73,7 +79,7 @@ The backend services include
``` ```
> For macOS: install libmagic with `brew install libmagic`. > For macOS: install libmagic with `brew install libmagic`.
5. Perform the database migration 5. Perform the database migration:
Perform database migrations to the latest version: Perform database migrations to the latest version:
@@ -81,7 +87,7 @@ The backend services include
uv run flask db upgrade uv run flask db upgrade
``` ```
6. Start the API service 6. Start the API service:
``` ```
uv run flask run --host 0.0.0.0 --port=5001 --debug uv run flask run --host 0.0.0.0 --port=5001 --debug
@@ -99,7 +105,7 @@ The backend services include
INFO:werkzeug: * Debugger PIN: 695-801-919 INFO:werkzeug: * Debugger PIN: 695-801-919
``` ```
### Start the Worker service ### Start the Worker Service
To consume asynchronous tasks from the queue, such as dataset file import and dataset document updates, follow these steps to start the Worker service To consume asynchronous tasks from the queue, such as dataset file import and dataset document updates, follow these steps to start the Worker service
@@ -206,49 +212,52 @@ To start the web frontend service, [Node.js v22 (LTS)](http://nodejs.org/) and [
### Start Web Service ### Start Web Service
1. Enter the web directory 1. Enter the web directory:
``` ```
cd web cd web
``` ```
2. Dependencies installation 2. Install dependencies:
``` ```
pnpm install --frozen-lockfile pnpm install --frozen-lockfile
``` ```
3. Prepare the environment variable config file 3. Prepare the environment variable configuration file\
Create a file named `.env.local` in the current directory and copy the contents from `.env.example`. Modify the values of these environment variables according to your requirements: Create a file named `.env.local` in the current directory and copy the contents from `.env.example`. Modify the values of these environment variables according to your requirements:
``` ```
# For production release, change this to PRODUCTION # For production release, change this to PRODUCTION
NEXT_PUBLIC_DEPLOY_ENV=DEVELOPMENT NEXT_PUBLIC_DEPLOY_ENV=DEVELOPMENT
# The deployment edition, SELF_HOSTED or CLOUD # The deployment edition, SELF_HOSTED or CLOUD
NEXT_PUBLIC_EDITION=SELF_HOSTED NEXT_PUBLIC_EDITION=SELF_HOSTED
# The base URL of console application, refers to the Console base URL of WEB service if console domain is
# different from api or web app domain. # The base URL of console application, refers to the Console base URL of WEB service if console domain is different from api or web app domain.
# example: http://cloud.dify.ai/console/api # example: http://cloud.dify.ai/console/api
NEXT_PUBLIC_API_PREFIX=http://localhost:5001/console/api NEXT_PUBLIC_API_PREFIX=http://localhost:5001/console/api
# The URL for Web APP, refers to the Web App base URL of WEB service if web app domain is different from
# console or api domain. # The URL for Web APP, refers to the Web App base URL of WEB service if web app domain is different from console or api domain.
# example: http://udify.app/api # example: http://udify.app/api
NEXT_PUBLIC_PUBLIC_API_PREFIX=http://localhost:5001/api NEXT_PUBLIC_PUBLIC_API_PREFIX=http://localhost:5001/api
# When the frontend and backend run on different subdomains, set NEXT_PUBLIC_COOKIE_DOMAIN=1.
NEXT_PUBLIC_COOKIE_DOMAIN=
# SENTRY # SENTRY
NEXT_PUBLIC_SENTRY_DSN= NEXT_PUBLIC_SENTRY_DSN=
NEXT_PUBLIC_SENTRY_ORG= NEXT_PUBLIC_SENTRY_ORG=
NEXT_PUBLIC_SENTRY_PROJECT= NEXT_PUBLIC_SENTRY_PROJECT=
``` ```
4. Build the web service 4. Build the web service:
``` ```
pnpm build pnpm build
``` ```
5. Start the web service 5. Start the web service:
``` ```
pnpm start pnpm start

15
en/self-host/configuration/environments.mdx
View File

@@ -184,8 +184,19 @@ This Redis configuration is used for caching and for pub/sub during conversation
Used to set the front-end cross-domain access policy. Used to set the front-end cross-domain access policy.
- CONSOLE_CORS_ALLOW_ORIGINS: Console CORS cross-domain policy, default is `*`, that is, all domains can access. - CONSOLE_CORS_ALLOW_ORIGINS\
- WEB_API_CORS_ALLOW_ORIGINS: WebAPP CORS cross-domain policy, default is `*`, that is, all domains can access. Console CORS cross-domain policy, default is `*`, that is, all domains can access.
- WEB_API_CORS_ALLOW_ORIGINS\
WebAPP CORS cross-domain policy, default is `*`, that is, all domains can access.
- COOKIE_DOMAIN\
When the frontend and backend run on different subdomains, set `COOKIE_DOMAIN` to the site's top-level domain (e.g., `example.com`).\
The frontend and backend must be under the same top-level domain to share authentication cookies.
- NEXT_PUBLIC_COOKIE_DOMAIN\
When the frontend and backend run on different subdomains, set `NEXT_PUBLIC_COOKIE_DOMAIN` to `1`.\
The frontend and backend must be under the same top-level domain to share authentication cookies.
### File Storage Configuration ### File Storage Configuration

49
en/self-host/quick-start/docker-compose.mdx
View File

@@ -39,22 +39,23 @@ Make sure your machine meets the following minimum system requirements.
1. Navigate to the `docker` directory in the Dify source code: 1. Navigate to the `docker` directory in the Dify source code:
```bash ```bash
cd dify/docker cd dify/docker
``` ```
2. Copy the example environment configuration file: 2. Copy the example environment configuration file:
```bash ```bash
cp .env.example .env cp .env.example .env
``` ```
<Note>
When the frontend and backend run on different subdomains, set `COOKIE_DOMAIN` to the site's top-level domain (e.g., `example.com`) and set `NEXT_PUBLIC_COOKIE_DOMAIN` to `1` in the `.env` file.
The frontend and backend must be under the same top-level domain to share authentication cookies.
</Note>
3. Start the containers using the command that matches your Docker Compose version: 3. Start the containers using the command that matches your Docker Compose version:
<Tip>
Run `docker compose version` to check your Docker Compose version.
</Tip>
<CodeGroup> <CodeGroup>
```bash Docker Compose V2 ```bash Docker Compose V2
docker compose up -d docker compose up -d
@@ -64,6 +65,10 @@ Make sure your machine meets the following minimum system requirements.
``` ```
</CodeGroup> </CodeGroup>
<Tip>
Run `docker compose version` to check your Docker Compose version.
</Tip>
The following containers will be started: The following containers will be started:
- 5 core services: `api`, `worker`, `worker_beat`, `web`, `plugin_daemon` - 5 core services: `api`, `worker`, `worker_beat`, `web`, `plugin_daemon`
@@ -117,23 +122,23 @@ Make sure your machine meets the following minimum system requirements.
1. Open the administrator initialization page to set up the admin account: 1. Open the administrator initialization page to set up the admin account:
```bash ```bash
# Local environment # Local environment
http://localhost/install http://localhost/install
# Server environment # Server environment
http://your_server_ip/install http://your_server_ip/install
``` ```
2. After completing the admin account setup, log in to Dify at: 2. After completing the admin account setup, log in to Dify at:
```bash ```bash
# Local environment # Local environment
http://localhost http://localhost
# Server environment # Server environment
http://your_server_ip http://your_server_ip
``` ```
## Customize Dify ## Customize Dify