├── .editorconfig ├── .gitignore ├── .gitlab-ci.yml ├── Dockerfile.template ├── LICENSE ├── Makefile ├── README.md ├── docker-library.template ├── exclude ├── pacman-conf.d-noextract.conf ├── renovate.json ├── rootfs └── etc │ ├── locale.conf │ └── pacman.d │ └── mirrorlist ├── scripts ├── make-dockerfile.sh └── make-rootfs.sh └── sigstore-param-file.yaml /.editorconfig: -------------------------------------------------------------------------------- 1 | root = true 2 | [*] 3 | indent_style = space 4 | end_of_line = lf 5 | charset = utf-8 6 | [Makefile] 7 | indent_style = tab 8 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | build 2 | output 3 | -------------------------------------------------------------------------------- /.gitlab-ci.yml: -------------------------------------------------------------------------------- 1 | default: 2 | image: "archlinux/archlinux:latest" 3 | 4 | stages: 5 | - cleanup 6 | - lint 7 | - rootfs 8 | - image 9 | - test 10 | - pre-release 11 | - release 12 | - publish 13 | 14 | cleanup: 15 | stage: cleanup 16 | tags: 17 | - secure 18 | - docker 19 | only: 20 | refs: 21 | - schedules@archlinux/archlinux-docker 22 | variables: 23 | - $CLEANUP_PACKAGE_REGISTRY == "TRUE" 24 | before_script: 25 | - pacman -Syu --noconfirm jq 26 | script: 27 | - | 28 | for id in $(curl --silent --fail --show-error "${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages?per_page=100&order_by=created_at&sort=asc" | jq '.[] | select(.created_at | split("T")[0] | . < (now-60*60*24*60|strflocaltime("%Y-%m-%d"))) | .id'); do 29 | curl --silent --fail --show-error --request DELETE --header "PRIVATE-TOKEN: ${GITLAB_PROJECT_TOKEN}" "${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/${id}" 30 | done 31 | 32 | lint: 33 | stage: lint 34 | image: hadolint/hadolint:latest-alpine 35 | # DL3018: We don't need apk version pins, we use the bleeding edge 36 | script: hadolint --ignore DL3018 Dockerfile.template 37 | except: 38 | - releases 39 | - tags 40 | 41 | # This is an implicit gitlab stage, with the build.env variables used by either 42 | # other stages or auxiliarry scripts. 43 | get_version: 44 | stage: .pre 45 | script: 46 | - | 47 | # If we're building a tagged release, use the tag (without the 'v' prefix) as the 48 | # BUILD_VERSION. Otherwise, determine a new BUILD_VERSION. 49 | if [[ -n "$CI_COMMIT_TAG" ]]; then 50 | echo "BUILD_VERSION=${CI_COMMIT_TAG/v/}" > build.env 51 | else 52 | echo "BUILD_VERSION=$(date +%Y%m%d).0.$CI_JOB_ID" > build.env 53 | fi 54 | - export $(< build.env) 55 | - echo "PACKAGE_REGISTRY_URL=${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/generic/rootfs/${BUILD_VERSION}" >> build.env 56 | artifacts: 57 | reports: 58 | dotenv: build.env 59 | 60 | .rootfs: 61 | stage: rootfs 62 | parallel: 63 | matrix: 64 | - GROUP: [base, base-devel, multilib-devel] 65 | before_script: 66 | - pacman -Syu --noconfirm git make fakechroot fakeroot 67 | - pacman -Sdd --noconfirm devtools 68 | script: 69 | - make $PWD/output/Dockerfile.$GROUP 70 | artifacts: 71 | paths: 72 | - output/* 73 | exclude: 74 | - output/*.tar 75 | expire_in: 2h 76 | 77 | rootfs: 78 | extends: .rootfs 79 | except: 80 | - master@archlinux/archlinux-docker 81 | - releases@archlinux/archlinux-docker 82 | - schedules@archlinux/archlinux-docker 83 | - tags@archlinux/archlinux-docker 84 | 85 | rootfs:secure: 86 | extends: .rootfs 87 | tags: 88 | - secure 89 | - docker 90 | only: 91 | - master@archlinux/archlinux-docker 92 | - schedules@archlinux/archlinux-docker 93 | except: 94 | - tags 95 | - releases 96 | 97 | .image: 98 | stage: image 99 | parallel: 100 | matrix: 101 | - GROUP: [base, base-devel, multilib-devel] 102 | tags: 103 | - vm 104 | id_tokens: 105 | SIGSTORE_ID_TOKEN: 106 | aud: sigstore 107 | script: 108 | - podman build 109 | -f "$CI_PROJECT_DIR/output/Dockerfile.$GROUP" 110 | -t "$CI_REGISTRY_IMAGE:$GROUP-$CI_COMMIT_REF_SLUG" 111 | "$CI_PROJECT_DIR/output" 112 | - podman push --sign-by-sigstore=<(sed "s/TEMPLATE_OIDC_ID_TOKEN/${SIGSTORE_ID_TOKEN}/" sigstore-param-file.yaml) "$CI_REGISTRY_IMAGE:$GROUP-$CI_COMMIT_REF_SLUG" 113 | 114 | image:build: 115 | extends: .image 116 | except: 117 | - master@archlinux/archlinux-docker 118 | - releases 119 | - schedules@archlinux/archlinux-docker 120 | - tags 121 | before_script: 122 | - pacman -Syu --noconfirm podman 123 | - podman login -u "$CI_REGISTRY_USER" -p "$CI_REGISTRY_PASSWORD" "$CI_REGISTRY" 124 | - 'echo -e "default-docker:\n use-sigstore-attachments: true" > /etc/containers/registries.d/sigstore.yaml' 125 | 126 | image:build:secure: 127 | extends: .image 128 | tags: 129 | - secure 130 | - vm 131 | only: 132 | - master@archlinux/archlinux-docker 133 | - schedules@archlinux/archlinux-docker 134 | except: 135 | - tags 136 | before_script: 137 | - pacman -Syu --noconfirm podman 138 | - podman login -u "$CI_REGISTRY_USER" -p "$CI_REGISTRY_PASSWORD" "$CI_REGISTRY" 139 | - 'echo -e "default-docker:\n use-sigstore-attachments: true" > /etc/containers/registries.d/sigstore.yaml' 140 | 141 | # Build and publish to the Arch Linux group namespaces: 142 | # https://hub.docker.com/r/archlinux/archlinux 143 | # https://quay.io/repository/archlinux/archlinux 144 | image:publish:secure: 145 | extends: .image 146 | retry: 2 147 | tags: 148 | - secure 149 | - vm 150 | only: 151 | - tags@archlinux/archlinux-docker 152 | before_script: 153 | - pacman -Syu --noconfirm podman 154 | - podman login -u "$DOCKERHUB_USERNAME" -p "$DOCKERHUB_ACCESS_TOKEN" "docker.io" 155 | - podman login -u "$QUAY_USERNAME" -p "$QUAY_PASSWORD" "quay.io" 156 | - podman login -u "$GHCR_USERNAME" -p "$GHCR_PASSWORD" "ghcr.io" 157 | - 'echo -e "default-docker:\n use-sigstore-attachments: true" > /etc/containers/registries.d/sigstore.yaml' 158 | script: 159 | - podman build 160 | -f "$CI_PROJECT_DIR/Dockerfile.$GROUP" 161 | -t "archlinux:$GROUP-$BUILD_VERSION" 162 | "$CI_PROJECT_DIR" 163 | - | 164 | for host in "docker.io" "quay.io" "ghcr.io"; do 165 | podman tag "archlinux:$GROUP-$BUILD_VERSION" "$host/archlinux/archlinux:$GROUP" 166 | podman tag "archlinux:$GROUP-$BUILD_VERSION" "$host/archlinux/archlinux:$GROUP-$BUILD_VERSION" 167 | podman push "$host/archlinux/archlinux:$GROUP" 168 | podman push --sign-by-sigstore=<(sed "s/TEMPLATE_OIDC_ID_TOKEN/${SIGSTORE_ID_TOKEN}/" sigstore-param-file.yaml) "$host/archlinux/archlinux:$GROUP-$BUILD_VERSION" 169 | 170 | if [[ "$GROUP" == "base" ]]; then 171 | podman tag "archlinux:$GROUP-$BUILD_VERSION" "$host/archlinux/archlinux:latest" 172 | podman push "$host/archlinux/archlinux:latest" 173 | fi 174 | done 175 | 176 | 177 | .test: 178 | stage: test 179 | dependencies: [] 180 | except: 181 | refs: 182 | - releases 183 | - tags 184 | 185 | .test-script: &test-script 186 | - test "$(cat /etc/group | wc -l)" -gt 10 187 | - test "$(cat /etc/passwd | wc -l)" -gt 10 188 | - pacman -Sy 189 | - pacman -Qqk 190 | - pacman -Syu --noconfirm podman grep 191 | - podman -v 192 | - id -u http 193 | - locale | grep -q UTF-8 194 | 195 | test:base: 196 | extends: .test 197 | image: $CI_REGISTRY_IMAGE:base-$CI_COMMIT_REF_SLUG 198 | script: 199 | - *test-script 200 | 201 | test:base-devel: 202 | extends: .test 203 | image: $CI_REGISTRY_IMAGE:base-devel-$CI_COMMIT_REF_SLUG 204 | script: 205 | - *test-script 206 | - gcc -v 207 | - g++ -v 208 | - make -v 209 | - test -u /usr/bin/sudo # issue 70 210 | - test -u /usr/bin/passwd 211 | 212 | pre-release: 213 | stage: pre-release 214 | image: registry.gitlab.com/gitlab-org/release-cli:latest 215 | tags: 216 | - secure 217 | - docker 218 | only: 219 | refs: 220 | - schedules@archlinux/archlinux-docker 221 | variables: 222 | - $PUBLISH_ARCHLINUX_REPOSITORY == "TRUE" 223 | - $PUBLISH_OFFICIAL_LIBRARY == "TRUE" 224 | before_script: 225 | - apk update 226 | - apk add jq curl bash 227 | script: 228 | - | 229 | echo "Update the description of our daily DockerHub repository at https://hub.docker.com/r/archlinux/archlinux" 230 | TOKEN="$(curl -X POST https://hub.docker.com/v2/users/login -H "Content-Type: application/json" -d "{\"username\": \"${DOCKERHUB_USERNAME}\", \"password\": \"${DOCKERHUB_PASSWORD}\"}" | jq -er .token)" 231 | curl -X PATCH https://hub.docker.com/v2/repositories/archlinux/archlinux/ \ 232 | -H "Authorization: JWT ${TOKEN}" \ 233 | -H "Content-Type: application/json" \ 234 | -d "{\"full_description\": $(cat README.md | jq -sR .)}" 235 | 236 | # Upload rootfs to the Generic Packages Repository 237 | for group in base base-devel multilib-devel; do 238 | rootfs_file="${group}-${BUILD_VERSION}.tar.zst" 239 | mv "output/${group}.tar.zst" "output/${rootfs_file}" 240 | mv "output/${group}.tar.zst.SHA256" "output/${rootfs_file}.SHA256" 241 | sed -i "s|${group}.tar.zst|${rootfs_file}|" "output/${rootfs_file}.SHA256" 242 | echo "Uploading ${rootfs_file}" 243 | curl -sSf --header "JOB-TOKEN: ${CI_JOB_TOKEN}" --upload-file "output/${rootfs_file}" "${PACKAGE_REGISTRY_URL}/" 244 | echo "Uploading ${rootfs_file}.SHA256" 245 | curl -sSf --header "JOB-TOKEN: ${CI_JOB_TOKEN}" --upload-file "output/${rootfs_file}.SHA256" "${PACKAGE_REGISTRY_URL}/" 246 | done 247 | 248 | # Create the Dockerfiles, commit to the release branch 249 | for group in base base-devel multilib-devel; do 250 | rootfs_file="${group}-${BUILD_VERSION}.tar.zst" 251 | ./scripts/make-dockerfile.sh "${rootfs_file}" "${group}" "output" "curl -sOJL \"${PACKAGE_REGISTRY_URL}/${rootfs_file}\"" "${group}" 252 | sed -i "/^COPY ${rootfs_file} \/$/d" output/Dockerfile.${group} 253 | done 254 | # See README.md###Maintenance for notes about `GITLAB_PROJECT_TOKEN` 255 | - > 256 | curl -sSf --request POST -o commit-response.json 257 | --header "PRIVATE-TOKEN: ${GITLAB_PROJECT_TOKEN}" 258 | --form "branch=releases" 259 | --form "commit_message=Release ${BUILD_VERSION}" 260 | --form "actions[][action]=update" 261 | --form "actions[][file_path]=Dockerfile.base" 262 | --form "actions[][content]=> build.env 277 | artifacts: 278 | reports: 279 | dotenv: build.env 280 | 281 | release: 282 | stage: release 283 | dependencies: 284 | - get_version 285 | image: registry.gitlab.com/gitlab-org/release-cli:latest 286 | tags: 287 | - secure 288 | - docker 289 | only: 290 | refs: 291 | - schedules@archlinux/archlinux-docker 292 | variables: 293 | - $PUBLISH_ARCHLINUX_REPOSITORY == "TRUE" 294 | - $PUBLISH_OFFICIAL_LIBRARY == "TRUE" 295 | script: 296 | - echo 'Creating release' 297 | release: 298 | name: 'Release ${BUILD_VERSION}' 299 | description: 'Release ${BUILD_VERSION}' 300 | tag_name: 'v${BUILD_VERSION}' 301 | ref: 'releases' 302 | assets: 303 | links: 304 | - name: 'base-${BUILD_VERSION}.tar.zst' 305 | url: '${PACKAGE_REGISTRY_URL}/base-${BUILD_VERSION}.tar.zst' 306 | - name: 'base-${BUILD_VERSION}.tar.zst.SHA256' 307 | url: '${PACKAGE_REGISTRY_URL}/base-${BUILD_VERSION}.tar.zst.SHA256' 308 | - name: 'base-devel-${BUILD_VERSION}.tar.zst' 309 | url: '${PACKAGE_REGISTRY_URL}/base-devel-${BUILD_VERSION}.tar.zst' 310 | - name: 'base-devel-${BUILD_VERSION}.tar.zst.SHA256' 311 | url: '${PACKAGE_REGISTRY_URL}/base-devel-${BUILD_VERSION}.tar.zst.SHA256' 312 | - name: 'multilib-devel-${BUILD_VERSION}.tar.zst' 313 | url: '${PACKAGE_REGISTRY_URL}/multilib-devel-${BUILD_VERSION}.tar.zst' 314 | - name: 'multilib-devel-${BUILD_VERSION}.tar.zst.SHA256' 315 | url: '${PACKAGE_REGISTRY_URL}/multilib-devel-${BUILD_VERSION}.tar.zst.SHA256' 316 | 317 | # Publish to the official Docker namespace: https://hub.docker.com/_/archlinux 318 | # Note: The description is maintained here: https://github.com/docker-library/docs/tree/master/archlinux 319 | publish-dockerhub: 320 | stage: publish 321 | dependencies: 322 | - get_version 323 | - pre-release 324 | only: 325 | refs: 326 | - schedules 327 | variables: 328 | - $PUBLISH_OFFICIAL_LIBRARY == "TRUE" 329 | before_script: 330 | - export | grep -q BUILD_VERSION= 331 | - export | grep -q BUILD_COMMIT= 332 | - test -n "$BUILD_VERSION" 333 | - test -n "$BUILD_COMMIT" 334 | - test -n "$GITHUB_TOKEN" 335 | - pacman -Syu --noconfirm github-cli git gettext 336 | - git config --global user.email "github@archlinux.org" 337 | - git config --global user.name "Arch Linux Technical User" 338 | script: 339 | - echo "Update the Docker library Github repo" 340 | - mkdir official-images 341 | - cd official-images 342 | - git init 343 | - 'git remote add origin "https://x-access-token:${GITHUB_TOKEN}@github.com/archlinux/official-images.git"' 344 | - git fetch https://github.com/docker-library/official-images.git 345 | - git reset --hard FETCH_HEAD 346 | - head="release/${BUILD_VERSION}" 347 | - git checkout -b "$head" 348 | - cp ../docker-library.template library/archlinux 349 | - | 350 | for group in base base-devel multilib-devel; do 351 | test "${group}" = "base" && extra="latest, " || extra="" 352 | echo "Tags: ${extra}${group}, ${group}-${BUILD_VERSION}" >> library/archlinux 353 | echo "GitCommit: ${BUILD_COMMIT}" >> library/archlinux 354 | echo "GitFetch: refs/tags/v${BUILD_VERSION}" >> library/archlinux 355 | echo "File: Dockerfile.${group}" >> library/archlinux 356 | echo >> library/archlinux 357 | done 358 | - git diff 359 | - git add library/archlinux 360 | - maintainers="$(grep \(@ ../docker-library.template | cut -d\( -f2 | cut -d\) -f1 | xargs)" 361 | - test -n "$maintainers" 362 | - 'git commit 363 | -m "archlinux: Release ${BUILD_VERSION}" 364 | -m "This is an automated release [1]." 365 | -m "[1] ${CI_PROJECT_URL}/-/blob/master/.gitlab-ci.yml"' 366 | - git push -u origin "$head" 367 | - 'gh pr create 368 | --repo docker-library/official-images 369 | --title "$(git show --no-patch --format="%s")" 370 | --body "$(printf "%s\n\n---\n\nMaintainers: ${maintainers}\n" "$(git show --no-patch --format="%b")")" 371 | --base master 372 | --head archlinux:"$head"' 373 | -------------------------------------------------------------------------------- /Dockerfile.template: -------------------------------------------------------------------------------- 1 | # Docker image when built on the official Docker infrastructure. 2 | # They require us to verify the source integrity in some way while making sure that this is a 3 | # reproducible build. 4 | # See https://github.com/docker-library/official-images#image-build 5 | # In order to achieve this, we externally host the rootfs archives and their checksums and then 6 | # just download and verify it in the first stage of this Dockerfile. 7 | # The second stage is for actually configuring the system a little bit. 8 | # Some templating is done in order to allow us to easily build different configurations and to 9 | # allow us to automate the release process. 10 | 11 | # Note: Only official DockerHub images are allowed, see https://gitlab.archlinux.org/archlinux/archlinux-docker/-/commit/daa67d18579024947d69a45e6d028c5adb1c8c23 12 | # While we could use archlinux:base it could also break our build process, so we avoid dog fooding here 13 | FROM alpine:3.22 AS verify 14 | COPY TEMPLATE_ROOTFS_FILE / 15 | 16 | RUN apk add --no-cache curl tar zstd 17 | 18 | RUN TEMPLATE_ROOTFS_DOWNLOAD && \ 19 | echo "TEMPLATE_ROOTFS_HASH" > /tmp/sha256sums.txt && \ 20 | sha256sum -c /tmp/sha256sums.txt && \ 21 | mkdir /rootfs && \ 22 | tar -C /rootfs --extract --file TEMPLATE_ROOTFS_FILE 23 | 24 | FROM scratch AS root 25 | 26 | LABEL org.opencontainers.image.title="TEMPLATE_TITLE" 27 | LABEL org.opencontainers.image.description="Official containerd image of Arch Linux, a simple, lightweight Linux distribution aimed for flexibility." 28 | LABEL org.opencontainers.image.authors="Santiago Torres-Arias (@SantiagoTorres), Christian Rebischke (@shibumi), Justin Kromlinger (@hashworks)" 29 | LABEL org.opencontainers.image.url="https://gitlab.archlinux.org/archlinux/archlinux-docker/-/blob/master/README.md" 30 | LABEL org.opencontainers.image.documentation="https://wiki.archlinux.org/title/Docker#Arch_Linux" 31 | LABEL org.opencontainers.image.source="https://gitlab.archlinux.org/archlinux/archlinux-docker" 32 | LABEL org.opencontainers.image.licenses="GPL-3.0-or-later" 33 | LABEL org.opencontainers.image.version="TEMPLATE_VERSION_ID" 34 | LABEL org.opencontainers.image.revision="TEMPLATE_REVISION" 35 | LABEL org.opencontainers.image.created="TEMPLATE_CREATED" 36 | 37 | COPY --from=verify /rootfs/ / 38 | 39 | RUN ldconfig && \ 40 | sed -i '/BUILD_ID/a VERSION_ID=TEMPLATE_VERSION_ID' /etc/os-release 41 | 42 | ENV LANG=C.UTF-8 43 | CMD ["/usr/bin/bash"] 44 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | OCITOOL=podman # or docker 2 | BUILDDIR=$(shell pwd)/build 3 | OUTPUTDIR=$(shell pwd)/output 4 | 5 | .PHONY: clean 6 | clean: 7 | rm -rf $(BUILDDIR) $(OUTPUTDIR) 8 | 9 | .PRECIOUS: $(OUTPUTDIR)/%.tar.zst 10 | $(OUTPUTDIR)/%.tar.zst: 11 | scripts/make-rootfs.sh $(*) $(BUILDDIR) $(OUTPUTDIR) 12 | 13 | .PRECIOUS: $(OUTPUTDIR)/Dockerfile.% 14 | $(OUTPUTDIR)/Dockerfile.%: $(OUTPUTDIR)/%.tar.zst 15 | scripts/make-dockerfile.sh "$(*).tar.zst" $(*) $(OUTPUTDIR) "true" "Dev" 16 | 17 | # The following is for local builds only, it is not used by the CI/CD pipeline 18 | 19 | all: image-base image-base-devel image-multilib-devel 20 | image-%: $(OUTPUTDIR)/Dockerfile.% 21 | ${OCITOOL} build -f $(OUTPUTDIR)/Dockerfile.$(*) -t archlinux/archlinux:$(*) $(OUTPUTDIR) 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Arch Linux OCI Images 2 | 3 | [![pipeline status][pipeline]][commits] 4 | 5 | Arch Linux provides OCI-Compliant container images in multiple repositories: 6 | * [Weekly in the official DockerHub library][hub-arch]: 7 | `podman pull docker.io/library/archlinux:latest` or `docker pull archlinux:latest` 8 | * [Daily in our DockerHub repository][hub-containers]: 9 | `podman pull docker.io/archlinux/archlinux:latest` or `docker pull archlinux/archlinux:latest` 10 | * [Daily in our quay.io repository][quay-containers]: 11 | `podman pull quay.io/archlinux/archlinux:latest` or `docker pull quay.io/archlinux/archlinux:latest` 12 | * [Daily in our ghcr.io repository][ghcr-containers]: 13 | `podman pull ghcr.io/archlinux/archlinux:latest` or `docker pull ghcr.io/archlinux/archlinux:latest` 14 | 15 | Three versions of the image are provided: `base` (approx. 150 MiB), `base-devel` 16 | (approx. 260 MiB) and `multilib-devel` (approx. 300MiB) containing the 17 | respective meta package. All of them are available as 18 | tags with `latest` pointing to `base`. Additionally, images are tagged with their 19 | date and build job number, f.e. `base-devel-20201118.0.9436`. 20 | 21 | While the images are regularly kept up to date it is strongly recommended 22 | running `pacman -Syu` right after starting a container due to the rolling 23 | release nature of Arch Linux. 24 | 25 | All the images, with the exception of the official DockerHub library image, are 26 | signed by using [cosign's keyless signing][openid-signing]. The images can be 27 | verified with one of the following commands: 28 | ```sh 29 | $ cosign verify docker.io/archlinux/archlinux:latest --certificate-identity-regexp="https://gitlab\.archlinux\.org/archlinux/archlinux-docker//\.gitlab-ci\.yml@refs/tags/v[0-9]+\.0\.[0-9]+" --certificate-oidc-issuer=https://gitlab.archlinux.org 30 | $ cosign verify quay.io/archlinux/archlinux:latest --certificate-identity-regexp="https://gitlab\.archlinux\.org/archlinux/archlinux-docker//\.gitlab-ci\.yml@refs/tags/v[0-9]+\.0\.[0-9]+" --certificate-oidc-issuer=https://gitlab.archlinux.org 31 | $ cosign verify ghcr.io/archlinux/archlinux:latest --certificate-identity-regexp="https://gitlab\.archlinux\.org/archlinux/archlinux-docker//\.gitlab-ci\.yml@refs/tags/v[0-9]+\.0\.[0-9]+" --certificate-oidc-issuer=https://gitlab.archlinux.org 32 | ``` 33 | 34 | ## Principles 35 | * Provide the Arch experience in a Docker image 36 | * Provide the simplest but complete image to `base`, `base-devel` and 37 | `multilib-devel` on a regular basis 38 | * `pacman` needs to work out of the box 39 | * All installed packages have to be kept unmodified 40 | 41 | >>> 42 | ⚠️⚠️⚠️ NOTE: For Security Reasons, these images strip the pacman lsign key. 43 | This is because the same key would be spread to all containers of the same 44 | image, allowing for malicious actors to inject packages (via, for example, 45 | a man-in-the-middle). In order to create a lsign-key run `pacman-key 46 | --init` on the first execution, but be careful to not redistribute that 47 | key.⚠️⚠️⚠️ 48 | >>> 49 | 50 | ## Building your own image 51 | 52 | [This repository][self] contains all scripts and files needed to create an OCI 53 | image for Arch Linux. 54 | 55 | ### Dependencies 56 | Install the following Arch Linux packages: 57 | 58 | * make 59 | * devtools (for the pacman.conf files) 60 | * git (to fetch the commit/revision number) 61 | * podman 62 | * fakechroot 63 | * fakeroot 64 | 65 | Make sure your user can directly interact with Podman (i.e. `podman info` works). 66 | 67 | ### Usage 68 | There are multiple `make image-XXX` targets, where each creates the 69 | respective `archlinux:XXX` image based on the corresponding meta package. 70 | Currently those include `base`, `base-devel` and `multilib-devel`. 71 | 72 | ## Pipeline 73 | 74 | ### Daily releases 75 | 76 | Daily images are build with scheduled [GitLab CI][in-tree-CI] using our own 77 | runner infrastructure. Initially root filesystem archives are constructed and 78 | provided in our [package registry][self-package-registry]. The released 79 | multi-stage Dockerfile downloads those archives and verifies their integrity 80 | before unpacking it into an OCI image layer. Images are built using 81 | [podman](https://podman.io/), which also publishes them to our external 82 | repositories. 83 | 84 | ### Weekly releases 85 | 86 | Weekly releases to the official DockerHub library use the same pipeline as 87 | daily builds. Updates are provided as automatic [pull requests][github-docker-prs] 88 | to the [official-images library][github-docker-arch], whose GitHub pipeline will 89 | build the images using our provided rootfs archives and Dockerfiles. 90 | 91 | ### Development 92 | 93 | Changes in Git feature branches are built and tested using the pipeline as well. 94 | Development images are uploaded to our 95 | [GitLab Container Registry][self-container-registry]. 96 | 97 | ### Maintenance 98 | 99 | Every year in June the content of the protected `GITLAB_PROJECT_TOKEN` variable needs to be replaced. To do this a GitLab admin needs to create a new [Access Token][access-tokens] with `api` and `write_repository` scope and the `Maintainer` role. This will create a new Bot User which needs to be given access to the protected `releases` branch. 100 | 101 | [pipeline]: https://gitlab.archlinux.org/archlinux/archlinux-docker/badges/master/pipeline.svg 102 | [commits]: https://gitlab.archlinux.org/archlinux/archlinux-docker/-/commits/master 103 | 104 | [hub-arch]: https://hub.docker.com/_/archlinux 105 | [hub-containers]: https://hub.docker.com/r/archlinux/archlinux 106 | [quay-containers]: https://quay.io/repository/archlinux/archlinux 107 | [ghcr-containers]: https://github.com/archlinux/archlinux-docker/pkgs/container/archlinux 108 | 109 | [openid-signing]: (https://docs.sigstore.dev/cosign/openid_signing/) 110 | 111 | [self]: https://gitlab.archlinux.org/archlinux/archlinux-docker 112 | 113 | [in-tree-CI]: https://gitlab.archlinux.org/archlinux/archlinux-docker/-/blob/master/.gitlab-ci.yml 114 | [self-package-registry]: https://gitlab.archlinux.org/archlinux/archlinux-docker/-/packages 115 | 116 | [github-docker-prs]: https://github.com/docker-library/official-images/pulls?q=is%3Apr+archlinux+is%3Aclosed+author%3Aarchlinux-github 117 | [github-docker-arch]: https://github.com/docker-library/official-images/blob/master/library/archlinux 118 | 119 | [self-container-registry]: https://gitlab.archlinux.org/archlinux/archlinux-docker/container_registry 120 | 121 | [access-tokens]: https://gitlab.archlinux.org/archlinux/archlinux-docker/-/settings/access_tokens -------------------------------------------------------------------------------- /docker-library.template: -------------------------------------------------------------------------------- 1 | # https://gitlab.archlinux.org/archlinux/archlinux-docker 2 | 3 | Maintainers: Santiago Torres-Arias (@SantiagoTorres), 4 | Christian Rebischke (@shibumi), 5 | Justin Kromlinger (@hashworks) 6 | GitRepo: https://gitlab.archlinux.org/archlinux/archlinux-docker.git 7 | 8 | -------------------------------------------------------------------------------- /exclude: -------------------------------------------------------------------------------- 1 | ./.dockerenv 2 | ./.dockerinit 3 | ./sys 4 | ./proc 5 | ./dev 6 | ./etc/hostname 7 | ./etc/machine-id 8 | ./etc/resolv.conf 9 | ./etc/pacman.d/gnupg/openpgp-revocs.d/* 10 | ./etc/pacman.d/gnupg/private-keys-v1.d/* 11 | ./etc/pacman.d/gnupg/pubring.gpg~ 12 | ./etc/pacman.d/gnupg/S.* 13 | ./root/* 14 | ./tmp/* 15 | ./var/cache/pacman/pkg/* 16 | ./var/lib/pacman/sync/* 17 | ./var/tmp/* 18 | ./alpm-hooks 19 | -------------------------------------------------------------------------------- /pacman-conf.d-noextract.conf: -------------------------------------------------------------------------------- 1 | [options] 2 | NoExtract = usr/share/help/* !usr/share/help/en* !usr/share/help/C/* 3 | NoExtract = usr/share/gtk-doc/html/* usr/share/doc/* 4 | NoExtract = usr/share/locale/* usr/share/X11/locale/* usr/share/i18n/* 5 | NoExtract = !*locale*/en*/* !usr/share/i18n/charmaps/UTF-8.gz !usr/share/*locale*/locale.* 6 | NoExtract = !usr/share/*locales/en_?? !usr/share/*locales/i18n* !usr/share/*locales/iso* 7 | NoExtract = !usr/share/*locales/trans* 8 | NoExtract = !usr/share/X11/locale/C/* 9 | NoExtract = !usr/share/X11/locale/compose.dir !usr/share/X11/locale/iso8859-1/* 10 | NoExtract = !usr/share/*locales/C !usr/share/*locales/POSIX !usr/share/i18n/charmaps/ANSI_X3.4-1968.gz 11 | NoExtract = usr/share/man/* usr/share/info/* 12 | NoExtract = usr/share/vim/vim*/lang/* 13 | NoExtract = etc/pacman.conf etc/pacman.d/mirrorlist 14 | -------------------------------------------------------------------------------- /renovate.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "https://docs.renovatebot.com/renovate-schema.json", 3 | "extends": [ 4 | "config:base" 5 | ] 6 | } 7 | -------------------------------------------------------------------------------- /rootfs/etc/locale.conf: -------------------------------------------------------------------------------- 1 | LANG=C.UTF-8 2 | -------------------------------------------------------------------------------- /rootfs/etc/pacman.d/mirrorlist: -------------------------------------------------------------------------------- 1 | Server = https://geo.mirror.pkgbuild.com/$repo/os/$arch 2 | Server = https://mirror.rackspace.com/archlinux/$repo/os/$arch 3 | Server = https://mirror.leaseweb.net/archlinux/$repo/os/$arch 4 | -------------------------------------------------------------------------------- /scripts/make-dockerfile.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | set -euo pipefail 4 | 5 | declare -r ROOTFS_FILE="$1" 6 | declare -r GROUP="$2" 7 | declare -r OUTPUTDIR="$3" 8 | declare -r DOWNLOAD="$4" 9 | declare -r TITLE="$5" 10 | 11 | # Do not use these directly in the sed below - it will mask git failures 12 | BUILD_VERSION="${BUILD_VERSION:-dev}" 13 | CI_COMMIT_SHA="${CI_COMMIT_SHA:-$(git rev-parse HEAD)}" 14 | 15 | sed -e "s|TEMPLATE_ROOTFS_FILE|$ROOTFS_FILE|" \ 16 | -e "s|TEMPLATE_ROOTFS_DOWNLOAD|$DOWNLOAD|" \ 17 | -e "s|TEMPLATE_ROOTFS_HASH|$(cat $OUTPUTDIR/$ROOTFS_FILE.SHA256)|" \ 18 | -e "s|TEMPLATE_TITLE|Arch Linux $TITLE Image|" \ 19 | -e "s|TEMPLATE_VERSION_ID|$BUILD_VERSION|" \ 20 | -e "s|TEMPLATE_REVISION|$CI_COMMIT_SHA|" \ 21 | -e "s|TEMPLATE_CREATED|$(date -Is)|" \ 22 | Dockerfile.template > "$OUTPUTDIR/Dockerfile.$GROUP" 23 | -------------------------------------------------------------------------------- /scripts/make-rootfs.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | set -euo pipefail 4 | 5 | declare -r WRAPPER="fakechroot -- fakeroot" 6 | 7 | declare -r GROUP="$1" 8 | declare -r BUILDDIR="$2" 9 | declare -r OUTPUTDIR="$3" 10 | 11 | mkdir -vp "$BUILDDIR/alpm-hooks/usr/share/libalpm/hooks" 12 | find /usr/share/libalpm/hooks -exec ln -sf /dev/null "$BUILDDIR/alpm-hooks"{} \; 13 | 14 | mkdir -vp "$BUILDDIR/var/lib/pacman/" "$OUTPUTDIR" 15 | [[ "$GROUP" == "multilib-devel" ]] && pacman_conf=multilib.conf || pacman_conf=extra.conf 16 | install -Dm644 "/usr/share/devtools/pacman.conf.d/$pacman_conf" "$BUILDDIR/etc/pacman.conf" 17 | cat pacman-conf.d-noextract.conf >> "$BUILDDIR/etc/pacman.conf" 18 | 19 | sed 's/Include = /&rootfs/g' < "$BUILDDIR/etc/pacman.conf" > pacman.conf 20 | 21 | sed -i '/#DisableSandbox/{c\ 22 | # No kernel landlock in containerd\ 23 | DisableSandbox 24 | }' "$BUILDDIR/etc/pacman.conf" 25 | 26 | cp --recursive --preserve=timestamps rootfs/* "$BUILDDIR/" 27 | ln -fs /usr/lib/os-release "$BUILDDIR/etc/os-release" 28 | 29 | $WRAPPER -- \ 30 | pacman -Sy -r "$BUILDDIR" \ 31 | --noconfirm --dbpath "$BUILDDIR/var/lib/pacman" \ 32 | --config pacman.conf \ 33 | --noscriptlet \ 34 | --hookdir "$BUILDDIR/alpm-hooks/usr/share/libalpm/hooks/" base "$GROUP" 35 | 36 | $WRAPPER -- chroot "$BUILDDIR" update-ca-trust 37 | $WRAPPER -- chroot "$BUILDDIR" pacman-key --init 38 | $WRAPPER -- chroot "$BUILDDIR" pacman-key --populate 39 | 40 | # add system users 41 | $WRAPPER -- chroot "$BUILDDIR" /usr/bin/systemd-sysusers --root "/" 42 | 43 | # remove passwordless login for root (see CVE-2019-5021 for reference) 44 | sed -i -e 's/^root::/root:!:/' "$BUILDDIR/etc/shadow" 45 | 46 | # fakeroot to map the gid/uid of the builder process to root 47 | # fixes #22 48 | fakeroot -- \ 49 | tar \ 50 | --numeric-owner \ 51 | --xattrs \ 52 | --acls \ 53 | --exclude-from=exclude \ 54 | -C "$BUILDDIR" \ 55 | -c . \ 56 | -f "$OUTPUTDIR/$GROUP.tar" 57 | 58 | cd "$OUTPUTDIR" 59 | zstd --long -T0 -8 "$GROUP.tar" 60 | sha256sum "$GROUP.tar.zst" > "$GROUP.tar.zst.SHA256" 61 | -------------------------------------------------------------------------------- /sigstore-param-file.yaml: -------------------------------------------------------------------------------- 1 | fulcio: 2 | fulcioURL: "https://fulcio.sigstore.dev" 3 | oidcMode: "staticToken" 4 | oidcIssuerURL: "https://gitlab.archlinux.org" 5 | oidcIDToken: "TEMPLATE_OIDC_ID_TOKEN" 6 | rekorURL: "https://rekor.sigstore.dev" 7 | --------------------------------------------------------------------------------