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

Документация и сообщество

Комплект руководств проекта, расположение исходников, каналы поддержки, контакты и лицензирование

1. Доступная документация

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

  • intro.txt (этот документ): здесь представлены основы балансировки нагрузки, HAProxy как продукт, его возможности и ограничения, известные подводные камни, которых следует избегать, некоторые ограничения конкретных ОС, способы получения, развитие проекта, способы убедиться, что используются все известные исправления, обновление, дополнения и альтернативы.

  • management.txt : объясняет, как запускать haproxy, управлять им во время выполнения, управлять им на нескольких узлах и выполнять обновления без перерыва в обслуживании.

  • configuration.txt : справочное руководство подробно описывает все ключевые слова конфигурации и их параметры. Оно используется, когда требуется изменить конфигурацию.

  • coding-style.txt: предназначен для разработчиков, которые хотят предложить проекту свой код. В нём объясняется стиль, которого следует придерживаться при написании кода. Правила не очень строгие, и не вся кодовая база полностью им соответствует, но изменения, слишком сильно от них отклоняющиеся, будут отклонены.

  • proxy-protocol.txt: фактическая спецификация протокола PROXY, реализованного в HAProxy и ряде сторонних продуктов.

  • security.txt: как сообщить о проблеме безопасности и что считается или не считается уязвимостью.

  • README: как собрать HAProxy из исходного кода

5. Контакты

Если требуется связаться с разработчиками или любым участником сообщества по какому-либо вопросу, обычно лучше всего воспользоваться списком рассылки, отправив сообщение на haproxy@formilux.org . Учтите, что список рассылки и его архивы общедоступны, поэтому следует избегать раскрытия конфиденциальной информации. В нём участвует тысяча пользователей с разным уровнем опыта, и даже на самые сложные вопросы обычно удаётся сравнительно быстро найти оптимальный ответ. Предложения тоже приветствуются. Для пользователей, которым сложно пользоваться электронной почтой, доступна платформа Discourse по адресу http://discourse.haproxy.org/ . Однако учитывайте, что вопросы там читает меньше людей и на большинство из них отвечает очень небольшая команда. В любом случае проявляйте терпение и уважение к тем, кто посвящает своё свободное время помощи другим.

Если кажется, что обнаружена ошибка, но уверенности нет, лучше сообщить об этом в список рассылки. Если есть твёрдая уверенность, что обнаружена ошибка, используется актуальная версия своей ветки и уже есть учётная запись GitHub, можно сразу перейти на https://github.com/haproxy/haproxy/ и создать сообщение об ошибке со всеми доступными подробностями. Этот ресурс тоже общедоступен, поэтому не публикуйте информацию, о раскрытии которой впоследствии можно пожалеть. Поскольку система отслеживания ошибок представляет обсуждение в виде очень длинной ветки, не вставляйте очень длинные дампы (несколько сотен строк и более) в текст, а прикладывайте их как вложения.

Если есть основания полагать, что обнаружена проблема безопасности, обратитесь к файлу doc/security.txt. Он объясняет, что считается или не считается уязвимостью HAProxy и как конфиденциально сообщить о настоящей уязвимости. Большинство предполагаемых проблем безопасности оказываются обычными ошибками, о которых лучше сообщать описанным выше способом.

Полный комплект локальных руководств

Происхождение издания