Перейти к содержанию

Запуск из docker compose

По умолчанию в образ системы включены:

  • приложение LMPS. Доступно на порту 80
  • база данных PostgreSQL. Доступна на порту 5432
  • панель администрирования БД (Adminer). Доступен на порту 8080
  • веб-сервер Nginx

Docker образ LPMS размещен в GitHub Container registry

Перед установкой

Создайте папку приложения

mkdir /opt/lpms
cd /opt/lpms

Скачайте инструкции для Docker compose

curl -o docker-compose.yml -L https://github.com/mmmylnikov/lpms/blob/dev/docker-compose-ghcr.yml

Настройте окружение

.env

nano .env
.env
# основные:
DEBUG=  # (1)
DJANGO_SECRET_KEY=  # (2)
DJANGO_ALLOWED_HOSTS=  # (3)
# база данных
DATABASE_ENGINE=postgresql
DATABASE_NAME=lmpsdb
DATABASE_USERNAME=lpmsuser
DATABASE_PASSWORD=lpmspassword
DATABASE_HOST=db  # (4)
DATABASE_PORT=5432  # (5)
DATABASE_OPTIONS={}  # (6)
# авторизация OAuth:
GITHUB_OAUTH_CLIENT_ID=  # (7)
GITHUB_OAUTH_SECRET=  # (8)
GITHUB_OAUTH_REDIRECT_URL=http://localhost:8000/oauth/accounts/github/login/callback/  # (9)
# уведомления
TELEGRAM_BOT_TOKEN=  # (10)
# автокомплит (опционально)
GITHUB_API_TOKEN=  # (11)
  1. Укажите True - для режима отладки, иначе оставьте пустым
  2. Секретный ключ для вашей конкретной установки приложения.
  3. Хосты/доменные имена через запятую, которые являются допустимыми для данного сайта. Например: 127.0.0.1,localhost
  4. При необходимости измените хост, если будете использовать бд не из образа
  5. При необходимости измените порт, если будете использовать бд не из образа
  6. При необходимости добавьте опции базы данных в формате json
  7. Client ID для вашего приложения на GitHub OAuth Apps
  8. Client secrets для вашего приложения на GitHub OAuth Apps |
  9. Authorization callback URL для вашего приложения на GitHub OAuth Apps
  10. Token вашего Телеграм бота. Позволяет отправлять уведомления студентам и кураторам о изменении статусов Тасков и Ревью.
  11. ОПЦИОНАЛЬНО: Personal access tokens (classic) вашего аккаунта GitHub. Позволяет увеличить часовой лимит запросов от приложения к GitHub c 60 до 5000. Используется в задачах автокомплита пулл-реквестов и последующей сверки статуса ревью.

docker-compose.yml

Примечание

При необходимости отредактируйте команды Docker copmose, например, если собираетесь использовать собственную базу данных

nano docker-compose.yml
docker-compose.yml
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
version: '3.9'
services:
  db:
    image: postgres
    ports:
      - 5432:5432
    restart: always
    shm_size: 128mb
    volumes:
      - lpms_db:/var/lib/postgresql/data
    env_file:
      - path: ./.env
        required: true
    environment:
      POSTGRES_USER: ${DATABASE_USERNAME}
      POSTGRES_PASSWORD: ${DATABASE_PASSWORD}
      POSTGRES_DB: ${DATABASE_NAME}
  adminer:
    image: adminer
    restart: always
    ports:
      - 8080:8080
  app:
    image: ghcr.io/mmmylnikov/lpms:latest
    restart: always
    depends_on:
      - db
    command: sh -c "python manage.py migrate &&
                    python manage.py collectstatic --noinput &&
                    gunicorn config.wsgi:application --bind 0.0.0.0:8000"
    volumes:
      - lpms_static:/usr/src/app/shared/static
      - lpms_nginx_conf:/usr/src/app/shared/nginx
    expose:
      - 8000
    env_file:
      - path: ./.env
        required: true
  nginx:
    image: nginx:latest
    restart: always
    ports:
      - 80:80
    depends_on:
      - app
    volumes:
      - lpms_static:/shared/static
      - lpms_nginx_conf:/etc/nginx/conf.d/
volumes:
  lpms_db:
  lpms_static:
  lpms_nginx_conf:

Запустите систему

docker compose up  # (1)
  1. Используйте флаг "-d", чтобы запустить систему в фоновом режиме: docker compose up -d

Поздравляю, система готова к работе!

Перейдите в панель администратора, чтобы добавить пользователей и наполнить вашу систему учебными материалами: http://localhost/admin/

Полезные команды

Собрать статические файлы

Путь для сохранения по умолчанию: shared/static/

docker exec -it lpms-app python manage.py collectstatic

Выполнить миграции

docker exec -it lpms-app python manage.py migrate

Создать суперпользователя

docker exec -it lpms-app python manage.py createsuperuser

Загрузить тестовую базу материалов обучения

Обратите внимание

В настоящий момент тестовая база данных не поставляется с файлами системы. Ее можно получить по запросу. Напишите мне, я вам постараюсь помочь.

docker exec -it lpms-app python manage.py loaddata db_test.json