octopus

Осьминог

Octopus -это легкая, легкая для сервера, легко настройка внутренняя страница вики со встроенной поддержкой программных диаграмм. Он использует Markdown для написания контента и улучшает его с помощью диаграмм Graphviz и Flutechart.js для легкой документации программного обеспечения.

Вот страница вики по умолчанию:

Технология

Octopus - это приложение Jamstack, которое использует Google Firebase в качестве бэкэнда. Вам не нужен веб -сервер (например, Apache) или база данных (например, MySQL), чтобы его запустить. Вы можете развернуть приложение в CDN бесплатно, используя NetLify.

С осьминогом вы можете:

• Требовать, чтобы пользователи были вписались на чтение или редактирование вики (поддерживаемые поставщики: Google, GitHub, электронная почта/пароль, Twitter и телефон),

• Создать правила доступа для чтения и редактирования (ограничить конкретных пользователей или доменов AUTH),

• Хост вики страницы под пользовательским доменом.

Функции

• Создайте новые страницы вики с языком разметки,

• Редактировать меню (используя Markdown), чтобы легко ссылаться на страницы вики,

• Включите диаграммы graphviz и flutechart.js в содержание разметки,

• Посмотрите, кто в настоящее время читает ваши статьи в вики,

• Отрегулируйте свой вики-фронт с помощью React (Create-React-App).

Пример системной диаграммы

Редактирование страниц с помощью Markdown

Установка

1. Клонировать этот репозиторий на ваш компьютер.

2. Скопируйте файл шаблона конфигурации ( src/config/config.template.js ) в src/config/config.js .

cp src/config/config.template.js src/config/config.js

ПРИМЕЧАНИЕ. Вы можете безопасно совершить src/config/config.js в репозиторий. В этом файле не хранятся конфиденциальные учетные данные - все переменные конфигурации в любом случае будут общедоступными в файле .js .

3. Создайте новый проект Firebase здесь: https://firebase.google.com/

4. Выберите «Добавить Firebase в ваше веб -приложение» и скопируйте конфигурацию в src/config/config.js созданный на шаге 2.

5. В консоли Firebase перейдите в Authentication > Метод входа , выберите поставщика и включите его. Осьминог был протестирован с поставщиками Google и Github.

6. Все еще в разделе «Аутентификация» > «Метод входа» , добавьте домен, который будет размещать ваше приложение в авторизованный список доменов .

7. Создайте приложение:

npm install
npm run build

8. Разверните build/ каталог в свой веб -сервер.

Развертывание без сервера

Вы можете пропустить хостинг приложения на своем веб -сервере (шаг 8 из руководства по установке выше). Все, что вам нужно, это развернуть приложение для облачного поставщика CDN.

Мы рекомендуем использовать NetLify.

Он автоматически развернется ваш развернутый осьминог Github Repo после каждого коммита. Он также подготовит готовый к использованию URL, к которому все ваши пользователи могут немедленно получить доступ. Позже вы можете настроить пользовательский домен, чтобы он выглядел более профессиональным.

ПРИМЕЧАНИЕ. При развертывании осьминога через NetLify заполните следующие данные в мастере настройки:

Команда сборки: npm run build
Публикайте каталог: build

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

По умолчанию любой пользователь может просматривать и отредактировать вашу страницу вики. Наверное, это не то, что вы ожидаете!

Чтобы сделать ваш контент доступным только для вашей компании, перейдите в консоль Firebase > Database > Rules и ограничить, кто может читать и редактировать вашу страницу вики.

Вот пример правила, если вы используете Google Wry-Provider, и адрес электронной почты вашей компании заканчивается @LiveChatinc.com :

{
  "rules": {
    ".read": "auth.token.email.endsWith('@livechatinc.com')",
    ".write": "auth.token.email.endsWith('@livechatinc.com')"
  }
}

Вы можете прочитать больше о возможных правилах безопасности в документации «Правила базы данных в реальном времени».

Используя осьминог

Осьминог предназначен для того, чтобы быть очень простым в использовании.

Чтобы создать новую страницу, просто введите URL, который вы хотите создать, например: https://<your-octopus-domain>/test/new-page . Если такая страница еще не была создана, вы увидите следующий экран:

Когда вы нажмете «Создать эту страницу», новая страница будет создана и заполнена контентом по умолчанию, готово к редактированию:

Как только страница будет готова, вы можете легко включить ее в меню:

Вот и все. Отправьте все ваши товарищи по команде на осьминог, и они готовы внести свой вклад!

---

Проект фон

Почему мы построили осьминог?

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

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

Построен с

• Реагировать через Create-React-App.

• Viz.js

• Fliotchark.js

• Пожарная база

Изменение

• 15.09.2017 - «Открыть как .png».

• 13.09.2017 - Первоначальный выпуск

Авторы

Bartosz olchówka / CTO @ LiveChat

Лицензия

Этот проект лицензирован по лицензии MIT - для получения подробной информации см. Файл лицензии.