docs: rewrite README with structured overview and quick start guide

Replaces the minimal project description with a comprehensive README
including a component overview table, quick start instructions, common
Ansible operations, and links to detailed documentation. Aligns with
Red Panda Approval™ standards.
This commit is contained in:
2026-03-03 12:49:06 +00:00
parent c7be03a743
commit b4d60f2f38
219 changed files with 34586 additions and 2 deletions

166
ansible/gitea/app.ini.j2 Normal file
View File

@@ -0,0 +1,166 @@
; Gitea Configuration File
; Generated by Ansible
APP_NAME = Gitea: Git with a cup of tea
RUN_MODE = prod
[server]
PROTOCOL = http
DOMAIN = {{ gitea_domain }}
ROOT_URL = {{ gitea_root_url }}
HTTP_ADDR = 0.0.0.0
HTTP_PORT = {{ gitea_web_port }}
DISABLE_SSH = false
SSH_DOMAIN = {{ gitea_domain }}
SSH_PORT = {{ gitea_ssh_port }}
SSH_LISTEN_PORT = {{ gitea_ssh_port }}
START_SSH_SERVER = true
LFS_START_SERVER = {{ gitea_lfs_enabled | lower }}
LFS_HTTP_AUTH_EXPIRY = 20m
OFFLINE_MODE = false
[database]
DB_TYPE = {{ gitea_db_type }}
HOST = {{ gitea_db_host }}:{{ gitea_db_port }}
NAME = {{ gitea_db_name }}
USER = {{ gitea_db_user }}
PASSWD = {{ gitea_db_password }}
SSL_MODE = {{ gitea_db_ssl_mode }}
LOG_SQL = false
AUTO_MIGRATION = true
[repository]
ROOT = {{ gitea_repo_root }}
DEFAULT_BRANCH = main
DEFAULT_PRIVATE = public
ENABLE_PUSH_CREATE_USER = true
ENABLE_PUSH_CREATE_ORG = false
DISABLED_REPO_UNITS =
DEFAULT_REPO_UNITS = repo.code,repo.releases,repo.issues,repo.pulls,repo.wiki,repo.projects,repo.packages
[repository.signing]
SIGNING_KEY = default
INITIAL_COMMIT = always
[repository.local]
LOCAL_COPY_PATH = {{ gitea_data_dir }}/tmp/local-repo
[repository.upload]
TEMP_PATH = {{ gitea_data_dir }}/tmp/uploads
[lfs]
PATH = {{ gitea_lfs_dir }}
[security]
INSTALL_LOCK = true
SECRET_KEY = {{ gitea_secret_key }}
MIN_PASSWORD_LENGTH = 8
PASSWORD_COMPLEXITY = lower,upper,digit
PASSWORD_HASH_ALGO = argon2
REVERSE_PROXY_LIMIT = 1
REVERSE_PROXY_TRUSTED_PROXIES = 127.0.0.0/8,::1/128,10.0.0.0/8
[service]
DISABLE_REGISTRATION = {{ gitea_disable_registration | lower }}
REQUIRE_SIGNIN_VIEW = {{ gitea_require_signin_view | lower }}
REGISTER_EMAIL_CONFIRM = false
ENABLE_NOTIFY_MAIL = false
DEFAULT_KEEP_EMAIL_PRIVATE = true
DEFAULT_ALLOW_CREATE_ORGANIZATION = true
DEFAULT_ENABLE_TIMETRACKING = true
NO_REPLY_ADDRESS = noreply.{{ gitea_domain }}
[service.explore]
REQUIRE_SIGNIN_VIEW = {{ gitea_require_signin_view | lower }}
DISABLE_USERS_PAGE = false
[mailer]
ENABLED = true
SMTP_ADDR = {{ smtp_host }}
SMTP_PORT = {{ smtp_port }}
FROM = {{ smtp_from }}
[session]
PROVIDER = memcache
PROVIDER_CONFIG = 127.0.0.1:11211
COOKIE_NAME = gitea_session
COOKIE_SECURE = true
[picture]
AVATAR_UPLOAD_PATH = {{ gitea_data_dir }}/avatars
REPOSITORY_AVATAR_UPLOAD_PATH = {{ gitea_data_dir }}/repo-avatars
DISABLE_GRAVATAR = false
[attachment]
PATH = {{ gitea_data_dir }}/attachments
MAX_SIZE = 50
MAX_FILES = 5
[log]
MODE = console
LEVEL = Info
ENABLE_SSH_LOG = true
;; Sub-logger modes using new 1.21+ format
logger.router.MODE = console
logger.access.MODE = console
[log.console]
LEVEL = Info
STDERR = false
[git]
PATH = /usr/bin/git
DISABLE_DIFF_HIGHLIGHT = false
MAX_GIT_DIFF_LINES = 1000
MAX_GIT_DIFF_LINE_CHARACTERS = 5000
MAX_GIT_DIFF_FILES = 100
GC_ARGS =
[git.timeout]
DEFAULT = 360
MIGRATE = 600
MIRROR = 300
[indexer]
ISSUE_INDEXER_TYPE = bleve
ISSUE_INDEXER_PATH = {{ gitea_data_dir }}/indexers/issues.bleve
REPO_INDEXER_ENABLED = true
REPO_INDEXER_TYPE = bleve
REPO_INDEXER_PATH = {{ gitea_data_dir }}/indexers/repos.bleve
[queue]
TYPE = level
DATADIR = {{ gitea_data_dir }}/queues
[metrics]
ENABLED = {{ gitea_metrics_enabled | lower }}
ENABLED_ISSUE_BY_LABEL = false
ENABLED_ISSUE_BY_REPOSITORY = false
TOKEN = {{ gitea_metrics_token }}
[cache]
ADAPTER = memcache
HOST = 127.0.0.1:11211
ITEM_TTL = 16h
[webhook]
ALLOWED_HOST_LIST = *
[oauth2]
ENABLED = true
JWT_SIGNING_ALGORITHM = RS256
JWT_SECRET = {{ gitea_lfs_jwt_secret }}
[oauth2_client]
ENABLE_AUTO_REGISTRATION = true
ACCOUNT_LINKING = auto
OPENID_CONNECT_SCOPES = openid profile email
UPDATE_AVATAR = false
[packages]
ENABLED = true
CHUNKED_UPLOAD_PATH = {{ gitea_data_dir }}/tmp/package-upload
[actions]
ENABLED = true
DEFAULT_ACTIONS_URL = https://github.com