gitage

Основана на NodeJS сервис git-pages.

Зависимости:

• git
• nodejs > 8

Поддерживаемые системы хостинга:

• gogs
• gitea

Обзор

Сервис gitage работает на NodeJS и зависит от веб-хуков систем управления версиями (git, gitea, gogs, gitlab).

Сервис gitage предназначен для предоставления удобной службы pages командам/компаниям и другим закрытым организациям.

Сервис поддерживает отображение файлов с расширением markdown и некоторых других типов файлов для просмотра.

Использование

При первом запуске выполните команду npm run download, чтобы скачать необходимые пакеты.

npm run build
node dist/gitage.js

Настройка сервера

Файл конфигурации называется config (чувствителен к регистру) и располагается в корневой директории развертывания. config

# Включить режим отладки
DEBUG = false
# IP адрес для запуска сервера
HOST = 0.0.0.0
# Порт для запуска сервера
PORT = 1997
# Директория логов, может быть абсолютным или относительным путём
LOG_PATH = logs
# Уровень записи логов
LOG_LEVEL = info
# Корневая директория проекта, может быть абсолютным или относительным путём
PROJECT_ROOT_PATH = projects
# Временная директория для проверки проекта, если поле пустое используется система временных файлов
PROJECT_CHECKOUT_TMP =

Без файла конфигурации используются вышеуказанные значения по умолчанию. Примечание: все ключи конфигурационного файла должны быть записаны большими буквами.## Конфигурация проекта Добавьте файл gitage.config.json в ваш проект, его структура следующая (необязательно):

{
    "type": "markdown",
    "path": "docs",
    "index": "index.html",
    "tag": true,
    "branch": "master",
    "ignore": [
        "file",
        "dir",
        "... "
    ]
}

• type указывает тип содержимого, который будет размещен. В настоящее время поддерживаются только markdown. Оставьте это поле пустым, если вы хотите использовать другой тип (чувствителен к регистру).
• path путь к каталогу размещения, по умолчанию docs.
• index имя страницы по умолчанию в каталоге размещения, по умолчанию index.html/index.md (чувствителен к регистру).
• tag разрешает размещение только при получении метки, по умолчанию false (планируется).
• branch указывает ветку размещения, по умолчанию master (конфигурационный файл должен находиться в главной ветке, чтобы избежать проблем с чтением).

Добавьте адрес в веб-хук вашего проекта: POST http://127.0.0.1:1997/hook/ где 127.0.0.1 — IP адрес сервера развертывания, а 1997 — порт развертывания.### type-markdown Когда type=markdown, можно указать каталог внутри проекта (может быть корневым каталогом /), используемый для публикации документов. В этом режиме весь каталог размещения сканируется, и автоматически создаётся дерево документов. Каждый файл содержит информацию о последнем обновлении пользователя/дата и сообщение об обновлении.

В настоящее время поддерживаются типы файлов .md | .markdown | .txt | .pdf | .docx для просмотра онлайн.

Скриншоты

Часто задаваемые вопросы

Если вы видите ошибочное сообщение:

status code: 405
content: Недопустимый запрос: метод GET недопустим, принимаются только POST

Это может указывать на неправильный адрес хука репозитория, обязательно добавьте в конец символ /.

Разработка

следующая версия

• Журнал checkout каждого репозитория записывается отдельно в файл (по одному файлу за каждый раз)
• Поддержка плагинов
• Оптимизация производительности wet