Part DB server

Документация | Демо | Докер-образ

Часть БД

Part-DB — это система управления запасами ваших электронных компонентов с открытым исходным кодом. Он устанавливается на веб-сервере, поэтому доступ к нему можно получить с помощью любого браузера без необходимости установки дополнительного программного обеспечения.

Версия в этом репозитории представляет собой полную переработку устаревшей версии Part-DB (версия < 1.0) на основе современной платформы и является рекомендуемой версией для использования.

Если вы обнаружили ошибку, откройте проблему на GitHub, чтобы каждый мог ее исправить.

Демо

Если вы хотите протестировать Part-DB без ее установки, вы можете использовать этот экземпляр Heroku. (Или эта ссылка на немецкую версию).

Вы можете войти в систему с именем пользователя: user и паролем: user .

Каждое изменение в основной ветке развертывается автоматически, поэтому оно отражает текущий прогресс разработки и может быть не совсем стабильным. Обратите внимание, что используется бесплатный экземпляр Heroku, поэтому первая загрузка страницы может занять некоторое время.

Функции

• Управление запасами ваших электронных деталей. Каждой детали можно присвоить категорию, площадь, производителя, несколько местоположений магазинов и информацию о ценах. Детали можно группировать с помощью тегов. Вы можете связать с деталями различные файлы, такие как таблицы данных или изображения.
• Многоязычная поддержка (в настоящее время немецкий, английский, русский, японский, французский, чешский, датский и китайский)
• Генератор штрих-кодов/этикеток для деталей и мест хранения, сканирование штрих-кодов через веб-камеру с помощью встроенного сканера штрих-кодов
• Пользовательская система с группами и подробными (тонко детализированными) разрешениями. Поддерживается двухфакторная аутентификация (ключи Google Authenticator и Webauthn/U2F), которую можно применять для групп. Можно настроить сброс пароля по электронной почте.
• Дополнительная поддержка единого входа (SSO) через SAML (с помощью промежуточной службы, такой как Keycloak, вы можете подключить Part-DB к существующему серверу LDAP или Active Directory)
• Система импорта/экспорта деталей и структуры данных. Поддерживается импорт спецификации для проектов из KiCAD.
• Управление проектами: создавайте проекты и назначайте детали в спецификации (BOM), чтобы показать, как часто вы можете создавать этот проект и напрямую извлекать все необходимые компоненты из базы данных.
• Журнал событий: отслеживайте, какие изменения происходят с вашим инвентарем, отслеживайте, какой пользователь что делает. Верните свои детали к более ранним версиям.
• Адаптивный дизайн: вы можете использовать Part-DB на своем ПК, планшете и смартфоне, используя один и тот же интерфейс.
• MySQL, SQLite и PostgreSQL поддерживаются в качестве серверных баз данных.
• Поддержка расширенных текстовых описаний и комментариев по частям.
• Поддержка нескольких валют и автоматическое обновление обменных курсов.
• Мощная функция поиска и фильтрации, включая параметрический поиск (поиск деталей по некоторым спецификациям)
• Автоматическое создание миниатюр для изображений
• Используйте облачных провайдеров (таких как Octopart, Digikey, Farnell, LCSC или TME) для автоматического получения информации о деталях, технических характеристик и цен на детали.
• API для доступа к Part-DB из других приложений/скриптов
• Интеграция с KiCad: используйте Part-DB в качестве центрального источника данных для вашего KiCad и просматривайте доступные детали из Part-DB непосредственно внутри KiCad.

Благодаря этим функциям Part-DB полезен любителям, которые хотят отслеживать свои частные запасы электронных деталей или места для производителей, где многие пользователи должны иметь (контролируемый) доступ к общему инвентарю.

Part-DB также используется небольшими компаниями и университетами для управления своими запасами.

Требования

• Веб-сервер (например, Apache2 или nginx), поддерживающий Symfony 6, включая минимальную версию PHP PHP 8.1.
• Сервер базы данных MySQL (минимум 5.7)/ MariaDB (минимум 10.4) или PostgreSQL 10+, если вы не хотите использовать SQLite.
• Настоятельно рекомендуется получить доступ к вашему серверу через Shell!
• Для создания ресурсов на стороне клиента необходимы Yarn и nodejs (>= 18.0).

Установка

Если вы хотите обновить устаревшую (< 1.0.0) версию Part-DB до этой версии, сначала прочтите это.

Подсказка: образ докера доступен в jbtronics/part-db1. Как настроить Part-DB через docker описано здесь.

Ниже вы найдете очень приблизительное описание процесса установки. Подробное руководство по установке Part-DB см. здесь.

1. Скопируйте или клонируйте этот репозиторий в папку на вашем сервере.
2. Настройте свой веб-сервер для обслуживания из папки public/ . Дополнительную информацию см. здесь.
3. Скопируйте глобальный файл конфигурации cp .env .env.local и отредактируйте .env.local :
   • Измените строку APP_ENV=dev на APP_ENV=prod
   • Если вы не хотите использовать SQLite, измените значение DATABASE_URL= в соответствии с вашими потребностями (см. здесь) для формата. В более крупных экземплярах с одновременным доступом MySQL более эффективен. Это нелегко изменить позже, поэтому выбирайте мудро.
4. Установите зависимости композитора и сгенерируйте файлы автозагрузки: composer install -o --no-dev
5. Установите зависимости на стороне клиента и соберите их: yarn install и yarn build
6. Необязательно (ускоряет первую загрузку): Кэш разминки: php bin/console cache:warmup
7. Обновите базу данных до новой схемы (или создайте ее, когда она пуста): php bin/console doctrine:migrations:migrate и следуйте приведенным инструкциям. Во время процесса отображается пароль администратора — user. Скопируйте это. Внимание ! Эти действия вносят изменения в вашу базу данных и потенциально могут ее уничтожить. Поэтому обязательно сделайте резервную копию своей базы данных.
8. Вы можете настроить Part-DB через config/parameters.yaml . После установки/обновления Part-DB вам следует проверить, соответствуют ли настройки вашим ожиданиям. Проверьте, соответствует ли partdb.default_currency вашей основной используемой валюте (это нельзя изменить после создания информации о ценах). Запустите php bin/console cache:clear , когда вы что-то меняете.
9. Откройте Part-DB в своем браузере (по URL-адресу, который вы указали) и войдите в систему с правами администратора . Пароль — тот, который выводится при настройке БД. Если вы не можете вспомнить пароль, установите новый с помощью php bin/console app:set-password admin . Вы можете создать новых пользователей с правами администратора и начать использовать Part-DB.

Если вы хотите обновиться до более новой версии, просто скопируйте новые файлы в папку и повторите шаги с 4 по 7.

Обычно случайный пароль генерируется при создании пользователя-администратора во время первоначального создания базы данных, однако вы можете установить первоначальный пароль администратора, установив переменную окружения INITIAL_ADMIN_PW .

Вы можете настроить Part-DB в соответствии со своими потребностями, изменив переменные среды в файле .env.local . См. здесь для получения дополнительной информации.

Обратный прокси

Если вы используете обратный прокси-сервер, вам необходимо убедиться, что прокси правильно установили заголовки X-Forwarded-* , иначе вы получите путаницу HTTP/HTTPS и неправильные имена хостов. Если обратный прокси-сервер находится на другом сервере (или он не может получить доступ к Part-DB через localhost), вам необходимо установить переменную env TRUSTED_PROXIES в соответствии с IP-адресом (или IP-блоком) вашего обратного прокси-сервера. Вы можете сделать это в своем .env.local или (при использовании docker) в файле docker-compose.yml .

Пожертвовать на развитие

Если вы хотите сделать пожертвование разработчику Part-DB, см. кнопку «Спонсор» в верхней панели (рядом с названием репозитория). Там вы найдете различные методы поддержки разработки на ежемесячной или разовой основе.

Построен с

• Symfony 5: основной фреймворк, используемый для серверного PHP.
• Bootstrap 5 и Bootswatch: используются в качестве темы веб-сайта.
• Fontawesome: используется как набор значков.
• Hotwire Stimulus и Hotwire Turbo: интерфейсный Javascript

Авторы

• Ян Бёмер — Начальная работа — GitHub

См. также список участников, принявших участие в этом проекте.

На основе оригинальной Part-DB Кристофа Лехнера и К. Джейкобса.

Лицензия

Part-DB распространяется под лицензией GNU Affero General Public License v3.0 (или, по вашему мнению, более поздней версии). В основном это означает, что вы можете использовать Part-DB для чего угодно (даже использовать его в коммерческих целях), при условии, что вы также публикуете исходный код для каждого изменения, которое вы вносите, в соответствии с AGPL.

См. ЛИЦЕНЗИЮ для получения дополнительной информации.