copier.yaml

_subdirectory: .copier-template

# Configure jinja2 defaults to make syntax highlighters lives easier
_templates_suffix: .jinja
_envops:
  block_end_string: "%}"
  block_start_string: "{%"
  comment_end_string: "#}"
  comment_start_string: "{#"
  keep_trailing_newline: true
  variable_end_string: "}}"
  variable_start_string: "{{"

_answers_file: .copier-docker-config.yaml

_tasks:
  # Strings get executed under system's default shell
  - "[ -d .git ] || git init"
  - "{% if github_repo_name %}git add remote origin https://github.com/{{ github_username }}/{{ github_repo_name }}.git 2>/dev/null || echo 'origin already exists'{% else %}echo 'No GitHub repository name provided. Skipping git remote add.'{% endif %}"

# questions
docker_project_name:
  type: str
  help: What is your docker project name? (it will be used as docker image name)
  validator: >-
    {% if not (docker_project_name | regex_search('^[a-z][a-z0-9\-]+$')) %}
    docker_project_name must start with a letter, followed one or more letters, digits or dashes in lowercase only
    {% endif %}

friendly_name:
  default: "{{ docker_project_name }}"
  type: str
  help: What is your project friendly name? (it will be used for the title of the documentation)

project_short_description:
  type: str
  help: What is your project short description?

project_description:
  type: str
  help: What is your project description?

project_license:
  type: str
  choices:
    - MIT
    - CC-BY-4.0
    - Apache-2.0
    - GPLv3
    - None

author:
  type: str
  help: What is your name?
  validator: >-
    {% if not (author | regex_search('^[a-zA-Z][a-zA-Z ]+$')) %}
    author must start with a letter, followed one or more letters or spaces
    {% endif %}

github_username:
  type: str
  help: What is your GitHub username?
  validator: >-
    {% if not (github_username | regex_search('^[a-z0-9][a-z0-9\-]+$')) %}
    github_username must start with a letter or digit, followed one or more letters, digits or dashes in lowercase only
    {% endif %}

email:
  default: "{{ github_username }}@"
  type: str
  help: What is your email?
  validator: >-
    {% if not (email | regex_search('^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$')) %}
    email must be a valid email address
    {% endif %}

github_repo_name:
  default: "{{ docker_project_name }}"
  type: str
  help: What is your GitHub repository name?

docker_username:
  default: "{{ github_username }}"
  type: str
  help: What is your Docker username?

docker_base_image_variant_name:
  default: base
  type: str
  help: What is your Docker base image variant?

docker_app_image_variant_name:
  default: app
  type: str
  help: What is your Docker app image variant? (it will be built from the base image)

docker_registry:
  default: ghcr.io
  type: str
  help: What is your Docker registry? (e.g. ghcr.io)

docker_base_build_from:
  default: python:3.9-slim-bookworm
  type: str
  help: What is your Docker image build from?

docker_timezone:
  default: Asia/Seoul
  type: str
  help: What is your Docker time zone?

docker_apt_packages:
  default: "fontconfig fonts-nanum"
  type: str
  help: What is your additional apt packages to install? (separated by space, "curl wget jq sudo tzdata locales locales-all python3-launchpadlib software-properties-common" by default)

docker_container_username:
  default: "app"
  type: str
  help: What is the username of the docker container? (non-root user)

docker_container_uid:
  default: 9001
  type: int
  help: What is the uid of the docker container user?

install_dotfiles:
  default: true
  type: bool
  help: Do you want to install dotfiles?

container_workspace_root:
  default: /workspace
  type: str
  help: What is the workspace root in the docker container?

copy_scripts_dir:
  default: true
  type: bool
  help: "Do you want to copy scripts directory under the workspace root? ? (COPY ./.docker/scripts/ ./scripts/)"

install_pip_requirements:
  default: true
  type: bool
  help: "Do you want to install pip requirements? (add dependencies to requirements.txt under the scripts directory)"

docker_run_command:
  default: /bin/zsh
  type: str
  help: "What is your command to run when the docker image is run? (default: /bin/zsh)"

clone_source_code:
  default: true
  type: bool
  help: Do you want to clone source code?

app_source_repo:
  type: str
  help: What is your source repository URL to clone? (e.g. github_username/repo_name)

app_source_branch:
  default: main
  type: str
  help: "What is your source repository branch to clone? (default: main)"

app_install_root:
  default: "{{ container_workspace_root }}/projects"
  type: str
  help: "What is your source install root? (default: {{ container_workspace_root }}/projects)"

app_clone_dirname:
  default: "{{ app_source_repo | regex_replace('.*/', '') }}"
  type: str
  help: "What is your source repository directory name to clone? (default: {{ app_source_repo | regex_replace('.*/', '') }})"

app_server_name:
  default: app
  type: str
  help: What is your app server name?

launch_scripts:
  default: launch.sh
  type: str
  help: What is your launch script to run when the docker image is run? (put it in the docker scripts directory)

enable_nvidia_gpu:
  default: true
  type: bool
  help: Do you want to enable NVIDIA GPU?

cuda_device_id:
  default: all
  type: str
  help: "What is your CUDA device to use? (default: all)"

start_ssh_service:
  default: true
  type: bool
  help: Do you want to use SSH?

ssh_host_port:
  default: 2222
  type: int
  help: "What is your SSH host port to expose? (default: 2222)"

start_jupyter:
  default: true
  type: bool
  help: Do you want to use Jupyter?

jupyter_host_port:
  default: 18888
  type: int
  help: "What is your Jupyter host port to expose? (default: 8888)"