Files
RepoFoundry/config.env.example
T
Tirsvad e960dd9da8 Set the project license in config.env; AGPL-3.0 default only for a public GitHub project
- PROJECT_LICENSE (a Gitea license key, or none) is read, checked and never asked
- Without it AGPL-3.0 applies only when GitHub is chosen and the project is public
- The license is applied on Gitea with or without GitHub, and checked against the server first
- Plan and summary name the license and where it came from
- MIL-006 accepted; README and config.env.example document the key
- Tests: new test-license.sh; existing tests use a public project where they expect AGPL-3.0

Task: MIL-006#1
Task: MIL-006#2
Task: MIL-006#3
Task: MIL-006#4
Refs #44
Refs #45
Refs #46
Refs #50
2026-10-07 13:08:49 +08:00

59 lines
2.5 KiB
Bash

# RepoFoundry service addresses (not secret).
#
# Copy this file to config.env and adjust it. create-project.sh reads it as
# plain KEY=VALUE lines; it is never executed, so no shell syntax, $variables
# or command substitution works here. Credentials do NOT belong in this file:
# put them in .env (see .env.example). A credential key in this file is
# rejected.
#
# Every URL must start with https:// and must not contain a user name, a
# password, a query string or a fragment.
# GitHub REST API base URL.
GITHUB_API_URL=https://api.github.com
# GitHub web base URL, used for the repository links the script prints and
# for the push-mirror address.
GITHUB_WEB_URL=https://github.com
# Gitea instance base URL. Repository links are derived from it.
GITEA_URL=https://<your gitea instance>/
# Gitea REST API base URL. If you leave this out it is GITEA_URL + /api/v1.
GITEA_API_URL=https://<your gitea instance>/api/v1
# Optional. SSH port of the Gitea server, used for the SSH check and later
# for the framework submodule. Default: 10022.
#GITEA_SSH_PORT=10022
# Optional. How often Gitea pushes to GitHub, as a Go duration (10m0s, 8h0m0s).
# The server may enforce a minimum. Default: 10m0s.
#MIRROR_INTERVAL=10m0s
# Optional. Project details that are set here are not asked. A key that is
# present counts as set, even when empty; only PROJECT_DESCRIPTION may be
# empty. An invalid value stops the run and names the key. Remove or comment
# out a line to be asked for it. The confirmations ("Create these now" and
# the questions about existing repositories, directories and files) are
# always asked. Put a value that contains " #" in double quotes: an unquoted
# " #" starts a comment.
#PROJECT_NAME=my-project
#PROJECT_DESCRIPTION=What the project is for
#PROJECT_VISIBILITY=private # private or public
#GITEA_OWNER=my-organization
#USE_GITHUB=yes # yes or no
#GITHUB_OWNER=my-organization # used only when USE_GITHUB is yes
#PROJECT_DIRECTORY=./my-project
#ENABLE_PLAN_GATE=no # yes or no
# Optional. The license of the project, as a Gitea license key (AGPL-3.0, MIT,
# ...), or none for no license. It is never asked. When absent, AGPL-3.0 is
# applied only if GitHub is used and the project is public; otherwise there
# is no license. The Gitea server must offer the license.
#PROJECT_LICENSE=AGPL-3.0
# Optional. OWNER/NAME of the SQA-QC-Framework repository on the Gitea server;
# it is added to the new project as a submodule over SSH.
# Default: TirSystem/SQA-QC-Framework.
#FRAMEWORK_REPO=TirSystem/SQA-QC-Framework