My Blog

Учебный проект для курса http://devstudy.net/course/jee-blog

Инструкция по запуску проекта в docker контейнерах

Для сборки и запуска данного проекта в docker контейнерах на компьютер необходимо установить ТОЛЬКО docker и docker-compose. Все необходимые для сборки и запуска программные компоненты доступны в виде docker образов на docker hub и поэтому docker подтянет их из интернета. (https://hub.docker.com/u/devstudy)

Т.е. на компьютер НЕ НУЖНО устанавливать: git, java, maven, tomcat и postgres.

Настройка системы разработчика:

Установка docker зависит от операционной системы, поэтому на официальном сайте необходимо выбрать Вашу операционную систему и следуя инструкциям установить docker и docker-compose:

• Инструкция по установке docker
• Инструкция по установке docker-compose

FYI: Для операционных систем на базе Ubuntu можно использовать упрощенные команды:

• Установка docker одной командой:

sudo apt update && sudo apt install -y docker.io && sudo systemctl start docker

• Установка docker-compose одной командой:

sudo apt install -y curl && sudo curl -L "https://github.com/docker/compose/releases/download/1.24.1/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose && sudo chmod +x /usr/local/bin/docker-compose

Сборка и запуск проекта:

! Для Linux систем: Если Вы залогинены в Вашу систему не администратором, то необходимо:

Добавить текущего пользователя в группу docker:

sudo usermod -aG docker $USER
logout
login

1. Клонировать github репозиторий в текущую папку, используя docker образ devstudy/git:

• Windows:

docker run -it --rm -v "%cd%":/opt/src/ -w /opt/src devstudy/git git clone "https://github.com/devstudy-net/blog"

• macOS:

docker run -it --rm -v "$PWD":/opt/src/ -w /opt/src devstudy/git git clone "https://github.com/devstudy-net/blog"

• Linux:

docker run -u 1000 -it --rm -v "$PWD":/opt/src/ -w /opt/src devstudy/git git clone "https://github.com/devstudy-net/blog"

FYI: (Параметр -u 1000 означает запуск docker от имени Вашего пользователя в системе. 1000 - это uid Вашего пользователя. Если данный параметр пропустить, то тогда все файлы создадуться от имени root пользователя)

2. Изменить текущую папку на корневую папку проекта:

cd blog/

3. Собрать проект с помощью maven используя docker образ devstudy/maven:

• Windows:

docker run -v %userprofile%/:/home/mvn/ -it --rm -e MAVEN_CONFIG=/home/mvn/.m2 -v "%cd%":/opt/src/ -w /opt/src devstudy/maven mvn -Duser.home=/home/mvn clean package

• macOS:

docker run -v ~/:/home/mvn/ -it --rm -e MAVEN_CONFIG=/home/mvn/.m2 -v "$PWD":/opt/src/ -w /opt/src devstudy/maven mvn -Duser.home=/home/mvn clean package

• Linux:

docker run -u 1000 -v ~/:/home/mvn/ -it --rm -e MAVEN_CONFIG=/home/mvn/.m2 -v "$PWD":/opt/src/ -w /opt/src devstudy/maven mvn -Duser.home=/home/mvn clean package

FYI: (Параметр -u 1000 означает запуск docker от имени Вашего пользователя в системе. 1000 - это uid Вашего пользователя. Если данный параметр пропустить, то тогда все файлы создадуться от имени root пользователя)

4. Создать файл '.env' в папке 'blog' и указать переменные окружения:

(Если данный файл не создавать, то в проекте не будет работать модуль email):

DEVSTUDY_BLOG_GOOGLE_PLUS_ID=TODO

DEVSTUDY_BLOG_SMTP_USERNAME=TODO
DEVSTUDY_BLOG_SMTP_PASSWORD=TODO

5. Собрать и запустить docker контейнеры:

docker-compose up

P.S. Если сборка и запуск docker контейнеров прошли успешно в консоли последней строчкой Вы должны увидеть строку, что blog-web-server server успешно запустился:

blog-web-server | 04-Aug-2019 07:37:03.012 INFO [main] org.apache.catalina.startup.Catalina.start Server startup in 2502 ms

6. Открыть браузер и зайти на сайт:

• Если docker устанавливался на текущую машину, то адрес сайта: http://localhost
• Если docker устанавливался на удаленную машину, то адрес сайта: http://${REMOTE_IP_ADDRESS}

7. Если нужно отлаживать проект, то по-умолчанию docker-compose открывает следующие порты:

• 5432 - для доступа к postgres базе данных, с помощью SQL клиента;
• 8765 - для tomcat remote debugging.

8. Чтобы остановить docker контейнеры:

Ctrl+C

9. Чтобы удалить docker контейнеры:

docker-compose down

Удаление исходников проекта:

Если на сервере нужны только docker контейнеры с готовыми образами приложения, то исходники которые уже не будут использоваться при запуске проекта могут быть удалены:

1. Удалить docker образ с установленным git:

docker rmi -f devstudy/git

2. Удалить docker образ с установленным maven:

docker rmi -f devstudy/maven

3. Удалить все файлы проекта кроме ./docker и ./docker-compose.yml:

• Windows:

rmdir /s /q src target external .git
del /f /q pom.xml README.md .gitignore

• macOS и Linux:

rm -rf ./src ./target ./pom.xml ./external ./README.md ./.git ./.gitignore

4. Удалить локальный maven репозиторий:

• Windows:

rmdir /s /q %userprofile%\.m2

• macOS и Linux:

rm -rf ~/.m2

Запуск проекта в случае наличия готовых образов в локальном docker хранилище

После удаления исходных кодов проект запускается и останавливается следующими командами:

1. Запустить docker контейнеры:

docker-compose up

2. Остановить docker контейнеры:

Ctrl+C

3. Удалить docker контейнеры:

docker-compose down