Cập nhật gần nhất: 12/02/2024

Chào mừng các bạn đã quay trở lại với series học Docker và CICD của mình. 👋👋

Ở bài trước chúng ta đã cùng nhau deploy ứng dụng NodeJS với Docker, setup domain name, HTTPS cùng với đó là hoài niệm so sánh với cách deploy truyền thống ngày xưa để thấy được sự đơn giản và nhanh gọn hơn rất nhiều.

Bài này chúng ta sẽ tiếp tục cùng nhau thử deploy project Laravel Realtime Chat App bằng Docker xem thế nào nhé

Bắt đầu thôi nào

Tổng quan

Ở bài này ta sẽ deploy 1 app chat y hệt như của mình:https://realtime-chat.jamesisme.com. Dùng chính source code mà mình đang deploy.

Mình khuyến khích các bạn xem lại bài mình viết về deploy app chat này nhưng là phiên bản không có Docker (làm theo kiểu truyền thống). Từ đó ta có cái nhìn rõ nét nhất về sự tuyệt vời mà Docker mang lại

App chat này có khá đầy đủ các component như bất kì 1 app Laravel nào mà thường đi làm các bạn sẽ gặp:

• Laravel, PHP (đương nhiên )
• Horizon + Worker
• Redis queue
• Laravel Echo, SocketIO
• Task Scheduling
• MySQL + Adminer (trình quản trị CSDL trên web)
• Nginx + HTTPS

Và tất cả các container trong bài này sẽ đều được chạy bằng non-root user nhé

Điều kiện tiên quyết

Vì bài này ta demo deploy trên server nên đương nhiên các bạn sẽ cần có server của riêng mình (VPS), nhớ là VPS chứ không phải Hosting thông thường nhé. (nên mua của các nhà cung cấp lớn như Google, AWS, Azure, Digital Ocean)

Cùng với đó ta sẽ setup HTTPS nên ta sẽ cần 1 tên miền (domain name), các bạn lên Godaddy mua 1 tên miền cùi cùi về để học tập nhé (~ 100K VND là cùng )

Setup

Clone source

Đầu tiên các bạn clone source code của mình ở đây.

Sau đó các bạn checkout ra nhánh master nhé

Tổng quan

Và như thường lệ trước khi deploy lên server ta cần test trước để đảm bảo là code của chúng ta hoạt động ổn nhé

Cùng điểm qua file docker-compose.non-root.yml xem ứng dụng của ta có những thành phần nào nhé:

• service app: ở đây ta sẽ cài PHP, chạy PHP-FPM, chạy Laravel Horizon, Task Scheduling, WorkerWorker
• service webserver: ở đây ta có 1 container Nginx, nhận request từ bên ngoài và chuyển vào service App, cùng với đó là phần kết nối realtime thì sẽ chuyển vào service Laravel echo server (bên dưới). Cấu hình của service này nằm ở .docker/non-root/nginx. Cách mình chạy Nginx với non-root user đã được mô tả chi tiết ở đây
• service db: chạy MySQL
• service adminer: trình quản trị CSDL trên web
• service redis: để dùng làm queue cho Laravel
• service laravel_echo_server: để broadcast realtime

Các service được join vào từng network cụ thể, để đảm bảo chúng chỉ giao tiếp với các thành phần thật sự cần thiết. Trừ service app, các service còn lại đều được setup HEALTHCHECK để định kì kiểm tra sức khoẻ nhé (service app khi mình tìm ra cách thích hợp mình sẽ update)

Xem qua Dockerfile chút nhé, ở bài này ta dùng file Dockerfile.non-root nha

Như các bạn thấy ở đây mình có những setup rất đơn giản và dễ hiểu thôi , cài supervisor, sau đó copy các file config superviser cho các service mà ta có, tiếp đó là tạo file /etc/crontabs/myuser để chạy Task Scheduling cho Laravel.

À với nếu các bạn để ý thì sẽ thấy rằng so với khi chạy bằng root, ta để luôn cấu hình start cronjob ở file supervisor config (các bạn mở folder .docker/root/supervisor.d/cron.conf), nhưng ở bài này khi chạy với non-root ta lại không làm vậy được.

Lý do là vì master process của crontab phải được start bằng root user, tí nữa ta sẽ phải tự start nó bằng tay. Nhưng children job của chúng ta vẫn được chạy bằng non root nhé vì nó được đặt ở folder /etc/crontabs/myuser trong container.

Đoạn crontab này hơi tù chút khi chạy với non-root, hi vọng mình tìm được giải pháp để đồng bộ nó cho giống với như lúc chạy với root

Test ở local

Tiếp theo ta sẽ tiến hành build image và test ở local xem nhé

Ở bài này ta sẽ chạy tất cả các container với non-root user. Ta mặc định với nhau là dùng user 1000:1000 nhé. Code mình đã setup sẵn tất cả mọi thứ cho user 1000:1000 rồi các bạn không cần làm gì thêm cả

Các bạn không biết chọn ID nào thì lấy 1000:1000 nhé không có lại loạn

Bước này chỉ dành cho Linux, bạn nào đang dùng Docker trên Windows + Mac thì có thể bỏ qua

Nếu các bạn muốn chạy với user khác thì sửa lại Dockerfile của laravel-echo-server đi nhé.

Ơ, vậy còn 2 service adminer và Webserver thì sao?

Với service adminer ta nhận thấy rằng không có map volume gì cả, tức không bị ảnh hưởng bởi user ở môi trường ngoài, do vậy ta dùng luôn user được cung cấp sẵn bởi image, tên là adminer

Với service webserver ta để ý rằng dù có map volume, nhưng ở đây mình đã chỉ định volume chỉ là readonly vì có :ro ở cuối, do vậy container này sẽ không ghi file ở những nơi được map volume, do vậy không ảnh hưởng tới môi trường ngoài vì thế ta cũng không cần thiết phải chạy với UID:GID bằng với môi trường ngoài mà ta sẽ sử dụng luôn user nginx được cung cấp sẵn bởi image

Tiếp theo ta tạo file .env (ta đơn giản là copy từ file .env.example, mình setup hết tên Host các service, password các thứ, bạn muốn đổi thì thoải mái update nhé):

cp .env.docker.example .env

Tiếp đó thì ta đổi lại permission của toàn bộ folder về 1000:1000 nhé:

# chỉ dành cho Linux, Windows + Mac có thể bỏ qua
sudo chown -R 1000:1000 .

Đầu tiên ta sẽ install dependencies sau đó build cho PHP/Laravel và cả phần frontend VueJS nhé:

# MacOS + Linux
docker run --rm -u 1000:1000 -v $(pwd):/app -w /app prooph/composer:8.2 install

docker run --rm -u 1000:1000 -v $(pwd):/app -w /app prooph/composer:8.2 dump-autoload

docker run --rm -u 1000:1000 -v $(pwd):/app -w /app node:20-alpine npm install

docker run --rm -u 1000:1000 -v $(pwd):/app -w /app node:20-alpine npm run build


# If Windows see below:

# Git bash
docker run --rm -u 1000:1000 -v "/$(pwd)":/app -w //app prooph/composer:8.2 install

docker run --rm -u 1000:1000 -v "/$(pwd)":/app -w //app prooph/composer:8.2 dump-autoload

docker run --rm -u 1000:1000 -v "/$(pwd)":/app -w //app node:20-alpine npm install

docker run --rm -u 1000:1000 -v "/$(pwd)":/app -w //app node:20-alpine npm run build

# PowerShell
docker run --rm -u 1000:1000 -v "$(pwd):/app" -w /app prooph/composer:8.2 install

docker run --rm -u 1000:1000 -v "$(pwd):/app" -w /app prooph/composer:8.2 dump-autoload

docker run --rm -u 1000:1000 -v "$(pwd):/app" -w /app node:20-alpine npm install

docker run --rm -u 1000:1000 -v "$(pwd):/app" -w /app node:20-alpine npm run build

# Command Prompt
docker run --rm -u 1000:1000 -v "%cd%:/app" -w /app prooph/composer:8.2 install

docker run --rm -u 1000:1000 -v "%cd%:/app" -w /app prooph/composer:8.2 dump-autoload

docker run --rm -u 1000:1000 -v "%cd%:/app" -w /app node:20-alpine npm install

docker run --rm -u 1000:1000 -v "%cd%:/app" -w /app node:20-alpine npm run build

Ổn rồi đó, ta tiến hành khởi động build và khởi động project luôn nhé:

docker compose -f docker-compose.non-root.yml up -d --build

chú ý rằng ở bài này tất cả các command docker compose ta phải thêm vào -f docker-compose.non-root.yml, bởi vì ở bài này ta có 2 file docker-compose đó, 1 file dành cho chạy với root user và 1 file chạy với non-root

Sau đó ta tạo app key

docker compose -f docker-compose.non-root.yml exec app php artisan key:generate

Tiếp đó là ta tạo các bảng database và tạo ít data sẵn nhé:

docker compose -f docker-compose.non-root.yml exec app php artisan migrate --seed

Cuối cùng ta mở trình duyệt, truy cập ở địa chỉ localhost:8000 tạo 2 account và thử chat xem nhé. Phần này mình để các bạn tự sướng

Khi chạy lên nếu các bạn gặp lỗi Access Denied for user... thì 96.69% là volume của db có lỗi, các bạn docker compose -f docker-compose.non-root.yml down, sau đó xoá folder .docker/non-root/data/db và tạo lại folder đó, cuối cùng là docker compose -f docker-compose.non-root.yml up -d là được nhé

Note với Task Scheduling

Nếu các bạn để ý có thể thấy rằng hiện tại CronJob (Task Scheduling) chưa chạy, không thấy thông báo của Bot trong Chatroom.

Như mình đã giải thích ở trên lí do là vì container của ta chạy bằng non-root user, nhưng master process của crond (thứ để chạy cronjob) thì cần được chạy bằng root user.

Do vậy ta phải tự tay khởi động crond bằng command:

docker compose -f docker-compose.non-root.yml exec -u root app sh
crond -b

Ngay sau đó ta sẽ thấy Task Scheduling hoạt động bình thường. Các bạn yên tâm là Master process của Crond chạy bằng root nhưng Cronjob của chúng ta thì vẫn đảm bảo được chạy bằng non-root user nhé

Deploy

Sau khi ta đã đảm bảo là source code của mình chạy ổn định, thì ta tiến hành deploy trên server nhé.

Đầu tiên các bạn cần SSH vào server của các bạn trước.

Sau đó ta sẽ chuyển tới một folder nào đó để làm việc nhé, ở đây mình chọn var/www/html:

cd /var/www/html

Sau đó ta tiến hành clone code về và checkout ra nhánh docker-non-root:

git clone https://github.com/maitrungduc1410/realtime-chatapp-laravelecho-socketio

cd realtime-chatapp-laravelecho-socketio

Sau khi clone về thì ta tiến hành setup, các bước setup thì y hệt như lúc test ở local, các bạn làm theo các bước đó nha

Và nếu bây giờ các bạn quay lại trình duyệt truy cập ở địa chỉ server_ip:8000 thì với một số cloud provider như Azure sẽ chưa được đâu vì như các bài deploy trước mình đã nói là VPS của ta mặc định ban đầu không cho phép traffic từ bên ngoài vào bất kì port nào mà ta phải mở bằng tay, chỉ định cụ thể port nào muốn mở. Có 2 cách để mở: 1 là làm trên trang quản trị nhà cung cấp nơi các bạn mua VPS (nên dùng cách này), 2 là mở bằng UFW (Firewall). Với cloud ví dụ như Digital Ocean thì không bị kiểu này

Ví dụ như mình dùng Azure thì nom sẽ như sau:

Còn nếu các bạn dùng UFW thì chạy command sau nhé:

sudo ufw allow 8000

Ngay sau đó ta quay lại trình duyệt, truy cập ở địa chỉ server_ip:8000 sẽ thấy kết quả ngay nhé:

Các bạn thử tạo 2 account và có thể thấy rằng đến đây ta đã có thể chat realtime ngon nghẻ rồi nhé:

Và ta vẫn chú ý rằng hiện tại Task Scheduling chưa được chạy, khi nãy mình đã nói lí do vì sao khi ta chạy ở local, giờ ta cần chạy nó lên nhé:

docker compose -f docker-compose.non-root.yml exec -u root app sh

crond -b

Sau đó quay trở lại trình duyệt, đợi 1 lát là ta sẽ thấy thông báo từ Bot được gửi đều đặn 1 phút 1 lần rồi nhé

HTTPS

Phần này thì làm y hệt như phần lấy HTTPS ở bài deploy NodeJS, các bạn mở lại bài đó xem và làm theo là được nhé. Ý tưởng vẫn là chạy riêng 1 con Nginx ở môi trường ngoài đóng vai trò như 1 Security layer, HTTPS sẽ được lấy ở đây, cho tất cả các project phía sau (giả sử sau này chúng ta có nhiều project Docker chẳng hạn). Các bạn đừng nhầm con Nginx ở môi trường ngoài này với Nginx trong ở service webserver nhé.

Note: Sau khi các bạn lấy HTTPS thành công ta làm thêm 2 bước như sau:

• Sửa APP_FORCE_HTTPS ở .env thành true, nếu không là bị lỗi CSS không load được và web trông xấu òm nhé
• Sửa tiếp VITE_LARAVEL_ECHO_SERVER_PORT ở .env thành 443, đây là port để trình duyệt gọi tới Laravel echo server nhé. Sau đó thì các bạn cần build lại phần code VueJS:

docker run --rm -v $(pwd):/app -w /app node:20-alpine npm run build

So sánh với cách deploy truyền thống

Đến đây ta đã hoàn thành việc deploy ứng dụng Laravel chat realtime.

Và nếu nhìn lại bài Deploy app chat realtime trên Ubuntu, ở bài đó ta cũng deploy app y hệt như thế này, chỉ là làm theo kiểu truyền thống, không có Docker. Ta sẽ thấy rằng ở cách cũ ta phải cài mệt nghỉ, setup vỡ mặt thớt 😂😂

Còn với Docker, ta chỉ cần Dockerize 1 lần, local chạy ngon thì ra server làm nhoắng 1 cái là lên luôn. Không cần phải setup đi setup lại nữa

Kết bài

Qua bài này ta đã deploy thành công một project Laravel với đầy đủ các thành phần gần giống như khi đi làm thường gặp.

Ta thấy được rằng deploy với Docker đã giúp ta rút ngắt được rất rất nhiều thời gian , cùng với đó an toàn hơn nhiều so với cách truyền thống, vì với project Laravel này nếu làm theo cách truyền thống ta phải cài 1 lố vào trong môi trường gốc, và đây chính là cội nguồn của vô vàn vấn đề

Cũng có nhiều người có hỏi mình là "nghe bảo Laravel + Docker" chạy chậm ở production. Nếu ai nói như vậy thì các bạn có thể show kết quả các bạn làm trong bài này cho họ, hoặc demo của mình cho họ thấy nhé

Cám ơn các bạn đã theo dõi, hẹn gặp lại các bạn vào những bài sau^^