Простая инструкция: Приглашение сотрудников в Пачку

Эта инструкция для тех, кто не занимается программированием.

---

Что делает эта программа?

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

---

Как подготовить список сотрудников?

1. Откройте файл users.csv.

2. Заполните строки по образцу:

   • email — электронная почта сотрудника (обязательно)
   • role — роль ("user" или "admin")
   • first_name — имя
   • last_name — фамилия
   • nickname — никнейм (можно не заполнять)
   • department — отдел (можно не заполнять)
   • phone_number — телефон (можно не заполнять)
   • title — должность (можно не заполнять)
   • tags - список тегов. Используется, чтобы задать структуру компании по отделам и добавлять пользователей массово в чаты группами (можно не заполнять)

   Как открыть CSV?

3. Рекомендуемый способ:

   • Откройте Excel.
   • Выберите: Данные → Получить данные → Из текста/CSV (или Data → Get Data → From Text/CSV).
   • Найдите свой файл users.csv.
   • В появившемся окне выберите кодировку 65001: Unicode (UTF-8).
   • Нажмите "Загрузить".

4. Google Таблицы:

   • Просто загрузите файл в Google Sheets — всё откроется корректно.

---

Как получить токен администратора?

1. Войдите в Пачку под своей учёткой администратора.
2. Перейдите в автоматизации → API → скопируйте access_token администратора.

---

Способы запуска

🐳 Docker (Рекомендуется)

Преимущества Docker:

• Не нужно устанавливать Ruby
• Изолированная среда выполнения
• Одинаковая работа на всех операционных системах

Требования:

• Установленный Docker
• Установленный Docker Compose

Запуск через Docker:

1. Создайте файл .env в папке проекта и добавьте в него:

   PACHCA_API_URL=https://api.pachca.com/api/shared/v1
   PACHCA_ADMIN_TOKEN=ваш_токен_от_Пачки
   

2. Подготовьте файл users.csv с данными сотрудников.

3. Запустите приглашение:

   docker-compose up --build

4. Логи будут сохранены в папке logs/

Альтернативный запуск через Docker без compose:

# Создайте директорию для логов
mkdir -p logs

# Соберите образ
docker build -t pachka-invite .

# Запустите контейнер
docker run --rm \
  -e PACHCA_API_URL=https://api.pachca.com/api/shared/v1 \
  -e PACHCA_ADMIN_TOKEN=ваш_токен_от_Пачки \
  -v $(pwd)/users.csv:/app/users.csv:ro \
  -v $(pwd)/logs:/app/logs \
  pachka-invite

🔧 Установка Ruby (альтернативный способ)

Если вы предпочитаете не использовать Docker:

1. Убедитесь, что на компьютере установлен язык программирования Ruby:

   • Для Mac чаще всего Ruby уже есть (но иногда его нужно обновить)
   • Для Windows Ruby нужно установить отдельно
   • Инструкция по установке Ruby на официальном сайте: https://www.ruby-lang.org/ru/documentation/installation/
   • Для Windows: https://rubyinstaller.org/

2. Создайте файл .env и добавьте в него:

   PACHCA_API_URL=https://api.pachca.com/api/shared/v1
   PACHCA_ADMIN_TOKEN=ваш_токен_от_Пачки
   

3. Откройте терминал в папке проекта и выполните:

   bundle install
   bundle exec ruby invite_users.rb

---

FAQ (Частые вопросы)

Q: Не запускается скрипт, пишет про ошибку с токеном A: Проверьте, что вы правильно указали токен администратора в файле .env (без пробелов и лишних символов).

Q: Показывает ошибку "Токен не принадлежит администратору" A: Убедитесь, что вы используете токен учетной записи с правами администратора.

Q: Ошибка "URL должен использовать HTTPS протокол" A: Не изменяйте PACHCA_API_URL - он должен начинаться с https://

Q: Не создается контейнер Docker A: Убедитесь, что Docker запущен и у вас есть права на его использование.

---

Безопасность

⚠️ Важные меры безопасности:

Хранение токенов

• Файл .env с токеном — это как ключ от вашей учетной записи
• НЕ отправляйте его никому и НЕ выкладывайте в интернет
• НЕ добавляйте .env в системы контроля версий (Git)
• После рассылки приглашений обязательно удалите токен из файла .env

Логирование

• Логи содержат информацию о процессе приглашения
• Email адреса и токены маскируются в логах для безопасности
• Не публикуйте файлы логов, если там есть личные данные сотрудников

Валидация данных

• Система проверяет формат email адресов
• Валидируются роли пользователей (только "user" или "admin")
• Все входные данные фильтруются перед отправкой

Сетевая безопасность

• Используется только HTTPS для всех запросов
• Токены передаются в заголовках Authorization, не в URL
• Система проверяет права администратора перед началом работы

Аудит безопасности

• Регулярно проверяйте и обновляйте токены доступа
• Просматривайте логи на предмет подозрительной активности
• Используйте минимально необходимые права доступа

Всё!