Plane¶

В этой статье

• Plane. Основные возможности
• Особенности сборки
• Начало работы после развертывания Plane
• Создание учетной записи администратора Plane
• Стартовое меню Plane
• Операции с рабочим пространством
• Настройка профиля пользователя
• Заказ сервера с Plane с помощью API

Plane. Основные возможности¶

• Управление задачами и проектами: позволяет создавать и отслеживать задачи, распределять их между участниками команды, устанавливать приоритеты и сроки.
• Гибкие представления: поддерживает различные представления (доска, список, календарь), чтобы соответствовать разным подходам к планированию и отслеживанию прогресса.
• Командная работа: встроенные инструменты для коммуникации и совместной работы помогают команде оставаться на одной волне.
• Микросервисная архитектура: состоит из нескольких контейнеров (frontend, backend, database и др.), что обеспечивает гибкость и масштабируемость.
• Интеграции с внешними системами: возможность подключения к другим инструментам и сервисам для расширения функциональности.
• Системы уведомлений: обеспечивает своевременное информирование о важных событиях и изменениях в проектах.
• Управление рабочими пространствами: позволяет организовать работу различных команд или проектов в рамках одной установки.

Особенности сборки¶

• Предустановленные зависимости - платформа поставляется с Docker и всеми необходимыми контейнерами: frontend, backend, database (PostgreSQL), Redis, RabbitMQ, Minio.
• Ключевые контейнеры:
  • plane-app-admin-1 - панель администратора;
  • plane-app-space-1 - компонент для управления рабочими пространствами;
  • plane-app-api-1 - API-сервер;
  • plane-app-plane-db-1 - база данных PostgreSQL;
  • plane-app-plane-mq-1 - очередь сообщений RabbitMQ;
  • plane-app-plane-redis-1 - кэш Redis;
  • plane-app-plane-minio-1 - хранилище файлов MinIO;
  • nginx-nginx-1 - веб-сервер Nginx для проксирования (jonasal/nginx-certbot:latest).
• Ключевые директории:
  • /opt/plane - основная директория установки;
  • /root/plane-app - директория с конфигурационными файлами;
  • /root/plane-app/plane.env - файл с переменными окружения для настройки.

Начало работы после развертывания Plane¶

После оплаты заказа на указанную при регистрации электронную почту придет уведомление о готовности сервера к работе. В нем будет указан IP-адрес VPS, а также логин и пароль для подключения. Управление оборудованием клиенты нашей компании осуществляют в панели управления серверами и API — Invapi.

Данные для авторизации, которые можно найти или во вкладке Информация >> Тэги панели управления сервером или в присланном e-mail:

• Ссылка для доступа к панели управления Plane с веб-интерфейсом: в теге webpanel;
• Логин и Пароль для управления сервером: приходят в письме на вашу электронную почту при сдаче сервера.

Создание учетной записи администратора Plane¶

После успешного развертывания Plane на вашем сервере, вы можете начать использовать платформу, выполнив следующие шаги:

1. Откройте веб-браузер и перейдите по ссылке из тега webpanel;

2. При первом запуске вам будет предложено создать учетную запись администратора. На странице "Setup your Plane Instance" вам необходимо заполнить следующие поля:

   • First name и Last name - ваше имя и фамилия
   • Email - ваш email-адрес
   • Company name - название вашей компании
   • Set a password и Confirm password - создание и подтверждение пароля
   • В нижней части формы вы можете разрешить Plane анонимно собирать данные об использовании, отметив соответствующий пункт. После заполнения всех полей нажмите кнопку Continue.

Стартовое меню Plane¶

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

Управление рабочими пространствами

После успешной авторизации вы попадете в раздел Settings. Во вкладке General settings вы можете:

• Изменить имя вашего экземпляра и email-адрес администратора;
• Увидеть уникальный ID вашего экземпляра;
• Настроить опции связи и телеметрии:
• Включить/выключить чат с командой поддержки через Intercom;
• Разрешить/запретить сбор анонимных данных об использовании.

После внесения изменений следует сохранить изменения, нажав кнопку Save changes.

В разделе Workspaces on this instance вы можете:

• Просматривать все существующие рабочие пространства;
• Управлять правами на создание рабочих пространств;
• Создавать новые рабочие пространства.

Переключатель Prevent anyone else from creating a workspace позволяет ограничить создание рабочих пространств другими пользователяит. В этом случае для доступа других пользователей к новым рабочим пространствам вам потребуется приглашать их.

Для создания нового рабочего пространства нажмите кнопку Create workspace.

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

В разделе Authentication вы можете:

• Настроить различные способы аутентификации для вашего экземпляра;
• Разрешить/запретить регистрацию новых пользователей без приглашения.

Доступные режимы аутентификации:

• Unique codes - вход по уникальным кодам, отправляемым по email;
• Passwords - вход по email и паролю;
• Google - вход через аккаунт Google;
• GitHub - вход через аккаунт GitHub;
• GitLab - вход через аккаунт GitLab;
• OIDC - аутентификация через протокол OpenID Connect (требуется обновление).

Создание рабочего пространства

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

• Name your workspace - название рабочего пространства;
• Set your workspace's URL - URL вашего рабочего пространства;
• How many people will use this workspace? - примерное количество пользователей.

После заполнения всех полей нажмите кнопку Create workspace или Go back, если вы хотите вернуться к предыдущему шагу.

Просмотр созданных рабочих пространств

После создания рабочего пространства вы вернетесь в раздел Workspaces on this instance, где сможете увидеть все созданные пространства. Для каждого пространства отображается:

• Название и URL;
• Владелец;
• Количество проектов и участников.

Для перехода в конкретное рабочее пространство кликните по его названию или иконке.

Операции с рабочим пространством¶

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

1. Ввести email-адрес в соответствующее поле;
2. Нажать кнопку Продолжить;
3. Выбрать метод аутентификации (если настроено несколько).

Настройка профиля пользователя¶

При первом входе в Plane вам будет предложено настроить свой профиль:

1. Загрузите изображение профиля (опционально);
2. Введите ваше имя и фамилию;
3. Выберите вашу роль (Individual contributor, Senior Leader, Manager и т.д.);
4. Укажите область вашей экспертизы (Engineering, Product, Marketing и т.д.).

После заполнения всех полей нажмите кнопку Continue.

Домашняя страница рабочего пространства

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

• Руководство по быстрому старту с четырьмя основными действиями:
• Создание проекта (Create a project);
• Приглашение членов команды (Invite your team);
• Настройка рабочего пространства (Set up your workspace);
• Персонализация Plane (Make Plane yours);
• Раздел Quicklinks для сохранения важных ресурсов.

В левой части экрана находится навигационное меню для доступа к различным разделам Plane:

• Home (Домашняя страница);
• Inbox (Входящие);
• Projects (Проекты);
• More (Дополнительные опции).

Заказ сервера с Plane с помощью API¶

Для установки данного ПО с использованием API следуйте этой инструкции.