Deploy Dify Smoothly - Improvements to the official deployment plan - No more ERROR!!!

[neon9809]

Self Checks

• I have searched for existing issues search for existing issues, including closed ones.
• I confirm that I am using English to submit this report (我已阅读并同意 Language Policy).
• [FOR CHINESE USERS] 请务必使用英文提交 Issue，否则会被关闭。谢谢！:）
• Please do not modify this template :) and fill in all the required fields.

Content

Here are tested steps to smoothly deploy in China. Reasons of why this differ from official doc are listed in each steps.

Server must have more than 4GB of memory!!!

1 gitclone

git clone https://githubfast.com/langgenius/dify.git

//directly clone from GitHub server may fail. Other GitHub mirrors are also ok.

2 docker login

docker login ghcr.io -u [your username] -p [your GitHub access token]

//This command will login Docker Hub with your GitHub account. Docker Hub limits unlogged users' connection, and if directly pull from official source, it will definitely fail.

3 pull image

docker pull nginx:latest
docker pull langgenius/dify-api:0.15.2
docker pull postgres:15-alpine
docker pull redis:6-alpine
docker pull langgenius/dify-web:0.15.2
docker pull langgenius/dify-sandbox:0.2.10
docker pull ubuntu/squid:latest
docker pull semitechnologies/weaviate:1.19.0

//images listed above are required by default. Pull those manually because it may fail when pull those all together by 'docker-compose.yaml' - one fails, all compose fails

4 Environment

cp .env.example .env

// @/dify/docker

5 Configure Email

edit .env RESEND EMAIL
Search 'Resend', and put your [RESEND API] and [admin email address] in this file.
// @/dify/docker/.env

6 HTTPS SSL Certificate configuration (OPTIONAL)

Copy [PrivateKey] and [PublicKey] to /root/dify/docker/nginx/ssl
yourkey.pem
yourkey.key

7 edit docker-compose-templete.yaml SSL (OPTIONAL)

Find these and customize

NGINX_SERVER_NAME: ${NGINX_SERVER_NAME:-[your-domain-name] [your-host-ip]}
NGINX_HTTPS_ENABLED: ${NGINX_HTTPS_ENABLED:-true}
NGINX_SSL_CERT_FILENAME: ${NGINX_SSL_CERT_FILENAME:-[your-PublicKey-filename]}
NGINX_SSL_CERT_KEY_FILENAME: ${NGINX_SSL_CERT_KEY_FILENAME:-[your-PrivateKey-filename]}

@/dify/docker/docker-compose-templete.yaml

8 Ready!

docker compose up -d

access http://[your-domain]
And Enjoy!

---

By these steps, it won't fail to start up after the first start up.
//My three deploying attempts earlier all failed after I restarted the docker compose. [crying]

---

One more thing:

For deploy on macOS, the Docker Desktop Mac Version, it may fail to start up with error of mount denied or file sharing issue.
Reason is that, macOS is not case sensitive by default, but the docker engine on macOS is.
Simple way to fix this on macOS is add another file-sharing directory in lower cases. (Default directory is '/Users', upper letter)
GO: Docker Desktop - settings - resources - filesharing - directories, add '/users' (lower letter)