🤖 Robotics OpenProject 🤖

Веб-приложение представляет собой форк инструмент управления проектами OpenProject (версия 12.5.6) с открытым исходным кодом. Форк был сделан сугубо в целях создания более специализированного инструмента под инженерные проекты лаборатории RTUItLab и не имеет целей коммерциализации данного ПО. В данном исполнении инструмент дорабатывается с локальными требованиями и под актуальные задачи.

🛠️ Системные требования 🛠️

Далее описаны системные требования для стабильной работы до 10 активных человек. Дальнейшей рост требования приложений можно узнать в информационных источниках по OpenProject.

• 💻 Оперативная память: 8 ГБ и выше
• 🔄 Ядра ЦП: 4 ядра, по 1 потоку на каждое
• 💽 Постоянная память: 15 ГБ и выше
• 🌐 Сетевое соединение: 50 Мбит/с и выше

🔧 Установка и запуск 🔧

В первую очередь проект заточен под использование в роли контейнеров Docker, но в ходе разработки было отлажено два способа запуска.

📦 Монолит 📦

Вы можете запустить проект на любом устройстве под управлением ОС Ubuntu 18 и больше. Инструкция с командами для монолитного запуска находятся в данном файле. Данный способ не рекомендуется, ибо запускается на единой машине, зависим от её параметров и создаёт проблемы с отказоустойчивостью.

🐳 Docker Compose 🐳

Для использования данного ПО, как мультиконтейнерное приложение Docker, можно использовать подготовленные конфигурации образов. Для полноценного запуска можно использовать файлы из релиза или загрузить набор файлов на машину с Docker:

• Папка docker
• docker-compose.yml
• docker.example.env
• Папка со скриптами utils-scripts

Краткое описание переменных среды:

• COMPOSE_PROJECT_NAME - описывает название проекта Docker Compose, менять нельзя для работы скриптов utils-scripts
• PUBLIC_HOSTNAME - публичный домен сервера, на котором разворачивается приложение для корректной работы прокси с SSL
• PORT - внутренний порт, который также можно использовать по IP, если прокси не включен
• DOCKER_BUILDKIT - BuildKit для ускорения сборки
• SECRET_KEY_BASE - ключ, которым будет шифроваться БД
• DB_PASSWORD - пароль от БД
• HTTPS_ENABLE - включение требование SSL сертификата при подключении (потребуется настроить прокси)
• AUTO_UPDATE - автообновление (при каждом запуске выполняется проверка на обноление и его установка)

Для работы с контейнерами предлагается использовать заготовленный bash скрипты, которые находятся в специальной папке. Вызывать их нужно из корневого пути репозитория.

run.sh

Выполняет запуск/установку контейнеров приложения. При попытке запустить скрипт без установленных контейнеров, автоматически выполняется установка. В остальном случае, вы можете использовать флаг --setup, который и запускает процесс настройки контейнеров.

Для запуска обновления приложения (обновление подтягивается из данного репозитория, ветки stable) можно использовать флаг --update. Данный процесс потребует некоторое время для нового запуска.

force_update.sh

Позволяет выполнить полную переустановку контейнеров.

Внимание! Данный скрипт не выполняет предварительно сохранение данных, поэтому выполняйте его по надобности.

remove.sh

Выполняет зачистку контейнеров, образов, томов и кэша сборки. Тем самым это отчищает вашу машину от данных об приложении. Может пригодиться при неисправностях сборки.

save_db.sh

Скрипт сохраняет данные приложения, запущенного в Docker. В роли метки-тэга сохранения используется текущая дата и время. Все файлы сохраняются в папке dumps, что позволяет сохранить данные в независимом от виртуальной машины пространстве.

restore_db.sh

Скрипт восстанавливает данные приложения, сохранённые до этого в папке dumps. Изначально выбирается самое последнее сохранение, но вы также можете выбрать нужный тэг с помощью флага --tag <имя_тэга>

➕ Дополнительные плагины ➕

Кроме основных плагинов в данной сборке присутствуют:

• OpenProject GitLab Integration - плагин для работы с GitLab, по аналогии с проприетарным плагином для GitHub. Оригинальный репозиторий: https://github.com/btey/openproject-gitlab-integration

📖 Остальное описание 📖

Прочее описание и документирование исходного кода выполнено в оригинальном репозитории и не требует более дополнения.

📄 Лицензия 📄

Исходный код родительского репозитория приложения и некоторый контент распространяется по открытым лицензиям, что позволяет копировать, адаптировать, изменять, распространять и передавать его с указанием первичного авторства OpenProject Foundation.

Официальная страница проекта: www.openproject.org

Изменения в проекте, опубликованные в данном репозитории распространяются согласно лицензии GNU 3.0