Update README.md with setup instructions and project details
This commit is contained in:
50
README.md
50
README.md
@@ -1,2 +1,52 @@
|
|||||||
# test-gitea
|
# test-gitea
|
||||||
|
|
||||||
|
Краткий проект для быстрой проверки и тестирования локальной инстанции Gitea.
|
||||||
|
|
||||||
|
## Назначение
|
||||||
|
Репозиторий содержит минимальную заготовку и инструкции для развёртывания и проверки работоспособности Gitea локально (контейнеры или бинарь).
|
||||||
|
|
||||||
|
## Требования
|
||||||
|
- Docker / Docker Compose (рекомендуется) или Linux/Windows с поддержкой запуска Gitea.
|
||||||
|
- Git
|
||||||
|
- Порты: 3000 (веб), 22 (ssh) — при локальном запуске могут быть иные настройки.
|
||||||
|
|
||||||
|
## Быстрая настройка (Docker)
|
||||||
|
1. Создать docker-compose.yml (или использовать локальный):
|
||||||
|
- Поднять сервис gitea и базу данных (например, MariaDB/Postgres).
|
||||||
|
2. Пример команд:
|
||||||
|
- docker-compose up -d
|
||||||
|
- Проверить логи: docker-compose logs -f gitea
|
||||||
|
3. Открыть интерфейс: http://localhost:3000 и пройти первичную настройку.
|
||||||
|
|
||||||
|
## Быстрая проверка репозитория
|
||||||
|
1. Создать пользователя и репозиторий через веб UI.
|
||||||
|
2. На машине выполнить:
|
||||||
|
- git clone http://localhost:3000/<user>/<repo>.git
|
||||||
|
- cd <repo>
|
||||||
|
- touch README.md && git add . && git commit -m "test" && git push
|
||||||
|
|
||||||
|
3. Проверить, что коммит отобразился в веб-интерфейсе.
|
||||||
|
|
||||||
|
## Проверка SSH (опционально)
|
||||||
|
1. Добавить SSH-ключ в профиль Gitea.
|
||||||
|
2. Попробовать:
|
||||||
|
- git clone git@localhost:<user>/<repo>.git
|
||||||
|
- если порт SSH переназначен, указывайте как git clone "ssh://git@localhost:PORT/<user>/<repo>.git"
|
||||||
|
|
||||||
|
## Тестовые сценарии
|
||||||
|
- Регистрация пользователя
|
||||||
|
- Создание/клонирование репозитория по HTTP и SSH
|
||||||
|
- Push/Pull больших файлов (или LFS, если используется)
|
||||||
|
- Восстановление после перезапуска контейнера (проверка персистенции данных)
|
||||||
|
|
||||||
|
## Советы
|
||||||
|
- Используйте volumes для персистентности данных в Docker.
|
||||||
|
- Отключайте внешнюю сеть, если тестируете доступность/изоляцию.
|
||||||
|
- Для автоматизации тестов можно использовать скрипты на bash или CI.
|
||||||
|
|
||||||
|
## Вклад
|
||||||
|
Пулл-реквесты и улучшения инструкций приветствуются. Опишите шаги воспроизведения и цель теста.
|
||||||
|
|
||||||
|
## Лицензия
|
||||||
|
По умолчанию — MIT (укажите свою лицензию при необходимости).
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user