diff --git a/Jenkinsfile b/Jenkinsfile
new file mode 100644
index 0000000..ed64e8d
--- /dev/null
+++ b/Jenkinsfile
@@ -0,0 +1,670 @@
+pipeline {
+ agent {
+ label 'X86-64-MULTI'
+ }
+ // Input to determine if this is a package check
+ parameters {
+ string(defaultValue: 'false', description: 'package check run', name: 'PACKAGE_CHECK')
+ }
+ // Configuration for the variables used for this specific repo
+ environment {
+ BUILDS_DISCORD=credentials('build_webhook_url')
+ GITHUB_TOKEN=credentials('498b4638-2d02-4ce5-832d-8a57d01d97ab')
+ EXT_GIT_BRANCH = 'master'
+ EXT_USER = 'c9'
+ EXT_REPO = 'core'
+ BUILD_VERSION_ARG = 'CLOUD9_VERSION'
+ LS_USER = 'linuxserver'
+ LS_REPO = 'docker-baseimage-cloud9'
+ CONTAINER_NAME = 'baseimage-cloud9'
+ DOCKERHUB_IMAGE = 'lsiobase/cloud9'
+ DEV_DOCKERHUB_IMAGE = 'lsiodev/cloud9-base'
+ PR_DOCKERHUB_IMAGE = 'lspipepr/cloud9-base'
+ DIST_IMAGE = 'ubuntu'
+ MULTIARCH='true'
+ CI='true'
+ CI_WEB='true'
+ CI_PORT='8000'
+ CI_SSL='false'
+ CI_DELAY='120'
+ CI_DOCKERENV='TZ=US/Pacific'
+ CI_AUTH='user:password'
+ CI_WEBPATH=''
+ }
+ stages {
+ // Setup all the basic environment variables needed for the build
+ stage("Set ENV Variables base"){
+ steps{
+ script{
+ env.EXIT_STATUS = ''
+ env.LS_RELEASE = sh(
+ script: '''docker run --rm alexeiled/skopeo sh -c 'skopeo inspect docker://docker.io/'${DOCKERHUB_IMAGE}':latest 2>/dev/null' | jq -r '.Labels.build_version' | awk '{print $3}' | grep '\\-ls' || : ''',
+ returnStdout: true).trim()
+ env.LS_RELEASE_NOTES = sh(
+ script: '''cat readme-vars.yml | awk -F \\" '/date: "[0-9][0-9].[0-9][0-9].[0-9][0-9]:/ {print $4;exit;}' | sed -E ':a;N;$!ba;s/\\r{0,1}\\n/\\\\n/g' ''',
+ returnStdout: true).trim()
+ env.GITHUB_DATE = sh(
+ script: '''date '+%Y-%m-%dT%H:%M:%S%:z' ''',
+ returnStdout: true).trim()
+ env.COMMIT_SHA = sh(
+ script: '''git rev-parse HEAD''',
+ returnStdout: true).trim()
+ env.CODE_URL = 'https://github.com/' + env.LS_USER + '/' + env.LS_REPO + '/commit/' + env.GIT_COMMIT
+ env.DOCKERHUB_LINK = 'https://hub.docker.com/r/' + env.DOCKERHUB_IMAGE + '/tags/'
+ env.PULL_REQUEST = env.CHANGE_ID
+ env.LICENSE_TAG = sh(
+ script: '''#!/bin/bash
+ if [ -e LICENSE ] ; then
+ cat LICENSE | md5sum | cut -c1-8
+ else
+ echo none
+ fi''',
+ returnStdout: true).trim()
+ }
+ script{
+ env.LS_RELEASE_NUMBER = sh(
+ script: '''echo ${LS_RELEASE} |sed 's/^.*-ls//g' ''',
+ returnStdout: true).trim()
+ }
+ script{
+ env.LS_TAG_NUMBER = sh(
+ script: '''#! /bin/bash
+ tagsha=$(git rev-list -n 1 ${LS_RELEASE} 2>/dev/null)
+ if [ "${tagsha}" == "${COMMIT_SHA}" ]; then
+ echo ${LS_RELEASE_NUMBER}
+ elif [ -z "${GIT_COMMIT}" ]; then
+ echo ${LS_RELEASE_NUMBER}
+ else
+ echo $((${LS_RELEASE_NUMBER} + 1))
+ fi''',
+ returnStdout: true).trim()
+ }
+ }
+ }
+ /* #######################
+ Package Version Tagging
+ ####################### */
+ // Grab the current package versions in Git to determine package tag
+ stage("Set Package tag"){
+ steps{
+ script{
+ env.PACKAGE_TAG = sh(
+ script: '''#!/bin/bash
+ if [ -e package_versions.txt ] ; then
+ cat package_versions.txt | md5sum | cut -c1-8
+ else
+ echo none
+ fi''',
+ returnStdout: true).trim()
+ }
+ }
+ }
+ /* ########################
+ External Release Tagging
+ ######################## */
+ // If this is a github commit trigger determine the current commit at head
+ stage("Set ENV github_commit"){
+ steps{
+ script{
+ env.EXT_RELEASE = sh(
+ script: '''curl -s https://api.github.com/repos/${EXT_USER}/${EXT_REPO}/commits/${EXT_GIT_BRANCH} | jq -r '. | .sha' | cut -c1-8 ''',
+ returnStdout: true).trim()
+ }
+ }
+ }
+ // If this is a github commit trigger Set the external release link
+ stage("Set ENV commit_link"){
+ steps{
+ script{
+ env.RELEASE_LINK = 'https://github.com/' + env.EXT_USER + '/' + env.EXT_REPO + '/commit/' + env.EXT_RELEASE
+ }
+ }
+ }
+ // Sanitize the release tag and strip illegal docker or github characters
+ stage("Sanitize tag"){
+ steps{
+ script{
+ env.EXT_RELEASE_CLEAN = sh(
+ script: '''echo ${EXT_RELEASE} | sed 's/[~,%@+;:/]//g' ''',
+ returnStdout: true).trim()
+ }
+ }
+ }
+ // If this is a master build use live docker endpoints
+ stage("Set ENV live build"){
+ when {
+ branch "master"
+ environment name: 'CHANGE_ID', value: ''
+ }
+ steps {
+ script{
+ env.IMAGE = env.DOCKERHUB_IMAGE
+ if (env.MULTIARCH == 'true') {
+ env.CI_TAGS = 'amd64-' + env.EXT_RELEASE_CLEAN + '-ls' + env.LS_TAG_NUMBER + '|arm32v7-' + env.EXT_RELEASE_CLEAN + '-ls' + env.LS_TAG_NUMBER + '|arm64v8-' + env.EXT_RELEASE_CLEAN + '-ls' + env.LS_TAG_NUMBER
+ } else {
+ env.CI_TAGS = env.EXT_RELEASE_CLEAN + '-ls' + env.LS_TAG_NUMBER
+ }
+ env.META_TAG = env.EXT_RELEASE_CLEAN + '-ls' + env.LS_TAG_NUMBER
+ }
+ }
+ }
+ // If this is a dev build use dev docker endpoints
+ stage("Set ENV dev build"){
+ when {
+ not {branch "master"}
+ environment name: 'CHANGE_ID', value: ''
+ }
+ steps {
+ script{
+ env.IMAGE = env.DEV_DOCKERHUB_IMAGE
+ if (env.MULTIARCH == 'true') {
+ env.CI_TAGS = 'amd64-' + env.EXT_RELEASE_CLEAN + '-pkg-' + env.PACKAGE_TAG + '-dev-' + env.COMMIT_SHA + '|arm32v7-' + env.EXT_RELEASE_CLEAN + '-pkg-' + env.PACKAGE_TAG + '-dev-' + env.COMMIT_SHA + '|arm64v8-' + env.EXT_RELEASE_CLEAN + '-pkg-' + env.PACKAGE_TAG + '-dev-' + env.COMMIT_SHA
+ } else {
+ env.CI_TAGS = env.EXT_RELEASE_CLEAN + '-pkg-' + env.PACKAGE_TAG + '-dev-' + env.COMMIT_SHA
+ }
+ env.META_TAG = env.EXT_RELEASE_CLEAN + '-pkg-' + env.PACKAGE_TAG + '-dev-' + env.COMMIT_SHA
+ env.DOCKERHUB_LINK = 'https://hub.docker.com/r/' + env.DEV_DOCKERHUB_IMAGE + '/tags/'
+ }
+ }
+ }
+ // If this is a pull request build use dev docker endpoints
+ stage("Set ENV PR build"){
+ when {
+ not {environment name: 'CHANGE_ID', value: ''}
+ }
+ steps {
+ script{
+ env.IMAGE = env.PR_DOCKERHUB_IMAGE
+ if (env.MULTIARCH == 'true') {
+ env.CI_TAGS = 'amd64-' + env.EXT_RELEASE_CLEAN + '-pkg-' + env.PACKAGE_TAG + '-pr-' + env.PULL_REQUEST + '|arm32v7-' + env.EXT_RELEASE_CLEAN + '-pkg-' + env.PACKAGE_TAG + '-pr-' + env.PULL_REQUEST + '|arm64v8-' + env.EXT_RELEASE_CLEAN + '-pkg-' + env.PACKAGE_TAG + '-pr-' + env.PULL_REQUEST
+ } else {
+ env.CI_TAGS = env.EXT_RELEASE_CLEAN + '-pkg-' + env.PACKAGE_TAG + '-pr-' + env.PULL_REQUEST
+ }
+ env.META_TAG = env.EXT_RELEASE_CLEAN + '-pkg-' + env.PACKAGE_TAG + '-pr-' + env.PULL_REQUEST
+ env.CODE_URL = 'https://github.com/' + env.LS_USER + '/' + env.LS_REPO + '/pull/' + env.PULL_REQUEST
+ env.DOCKERHUB_LINK = 'https://hub.docker.com/r/' + env.PR_DOCKERHUB_IMAGE + '/tags/'
+ }
+ }
+ }
+ // Run ShellCheck
+ stage('ShellCheck') {
+ when {
+ environment name: 'CI', value: 'true'
+ }
+ steps {
+ withCredentials([
+ string(credentialsId: 'spaces-key', variable: 'DO_KEY'),
+ string(credentialsId: 'spaces-secret', variable: 'DO_SECRET')
+ ]) {
+ script{
+ env.SHELLCHECK_URL = 'https://lsio-ci.ams3.digitaloceanspaces.com/' + env.IMAGE + '/' + env.META_TAG + '/shellcheck-result.xml'
+ }
+ sh '''curl -sL https://raw.githubusercontent.com/linuxserver/docker-shellcheck/master/checkrun.sh | /bin/bash'''
+ sh '''#! /bin/bash
+ set -e
+ docker pull lsiodev/spaces-file-upload:latest
+ docker run --rm \
+ -e DESTINATION=\"${IMAGE}/${META_TAG}/shellcheck-result.xml\" \
+ -e FILE_NAME="shellcheck-result.xml" \
+ -e MIMETYPE="text/xml" \
+ -v ${WORKSPACE}:/mnt \
+ -e SECRET_KEY=\"${DO_SECRET}\" \
+ -e ACCESS_KEY=\"${DO_KEY}\" \
+ -t lsiodev/spaces-file-upload:latest \
+ python /upload.py'''
+ }
+ }
+ }
+ // Use helper containers to render templated files
+ stage('Update-Templates') {
+ when {
+ branch "master"
+ environment name: 'CHANGE_ID', value: ''
+ expression {
+ env.CONTAINER_NAME != null
+ }
+ }
+ steps {
+ sh '''#! /bin/bash
+ set -e
+ TEMPDIR=$(mktemp -d)
+ docker pull linuxserver/jenkins-builder:latest
+ docker run --rm -e CONTAINER_NAME=${CONTAINER_NAME} -e GITHUB_BRANCH=master -v ${TEMPDIR}:/ansible/jenkins linuxserver/jenkins-builder:latest
+ docker pull linuxserver/doc-builder:latest
+ docker run --rm -e CONTAINER_NAME=${CONTAINER_NAME} -e GITHUB_BRANCH=master -v ${TEMPDIR}:/ansible/readme linuxserver/doc-builder:latest
+ if [ "$(md5sum ${TEMPDIR}/${LS_REPO}/Jenkinsfile | awk '{ print $1 }')" != "$(md5sum Jenkinsfile | awk '{ print $1 }')" ] || \
+ [ "$(md5sum ${TEMPDIR}/${CONTAINER_NAME}/README.md | awk '{ print $1 }')" != "$(md5sum README.md | awk '{ print $1 }')" ] || \
+ [ "$(cat ${TEMPDIR}/${LS_REPO}/LICENSE | md5sum | cut -c1-8)" != "${LICENSE_TAG}" ]; then
+ mkdir -p ${TEMPDIR}/repo
+ git clone https://github.com/${LS_USER}/${LS_REPO}.git ${TEMPDIR}/repo/${LS_REPO}
+ git --git-dir ${TEMPDIR}/repo/${LS_REPO}/.git checkout -f master
+ cp ${TEMPDIR}/${CONTAINER_NAME}/README.md ${TEMPDIR}/repo/${LS_REPO}/
+ cp ${TEMPDIR}/docker-${CONTAINER_NAME}/Jenkinsfile ${TEMPDIR}/repo/${LS_REPO}/
+ cp ${TEMPDIR}/docker-${CONTAINER_NAME}/LICENSE ${TEMPDIR}/repo/${LS_REPO}/
+ cd ${TEMPDIR}/repo/${LS_REPO}/
+ git --git-dir ${TEMPDIR}/repo/${LS_REPO}/.git add Jenkinsfile README.md LICENSE
+ git --git-dir ${TEMPDIR}/repo/${LS_REPO}/.git commit -m 'Bot Updating Templated Files'
+ git --git-dir ${TEMPDIR}/repo/${LS_REPO}/.git push https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/${LS_USER}/${LS_REPO}.git --all
+ echo "true" > /tmp/${COMMIT_SHA}-${BUILD_NUMBER}
+ else
+ echo "false" > /tmp/${COMMIT_SHA}-${BUILD_NUMBER}
+ fi
+ mkdir -p ${TEMPDIR}/gitbook
+ git clone https://github.com/linuxserver/docker-documentation.git ${TEMPDIR}/gitbook/docker-documentation
+ if [[ "${BRANCH_NAME}" == "master" ]] && [[ (! -f ${TEMPDIR}/gitbook/docker-documentation/images/docker-${CONTAINER_NAME}.md) || ("$(md5sum ${TEMPDIR}/gitbook/docker-documentation/images/docker-${CONTAINER_NAME}.md | awk '{ print $1 }')" != "$(md5sum ${TEMPDIR}/${CONTAINER_NAME}/docker-${CONTAINER_NAME}.md | awk '{ print $1 }')") ]]; then
+ cp ${TEMPDIR}/${CONTAINER_NAME}/docker-${CONTAINER_NAME}.md ${TEMPDIR}/gitbook/docker-documentation/images/
+ cd ${TEMPDIR}/gitbook/docker-documentation/
+ git add images/docker-${CONTAINER_NAME}.md
+ git commit -m 'Bot Updating Templated Files'
+ git push https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/linuxserver/docker-documentation.git --all
+ fi
+ rm -Rf ${TEMPDIR}'''
+ script{
+ env.FILES_UPDATED = sh(
+ script: '''cat /tmp/${COMMIT_SHA}-${BUILD_NUMBER}''',
+ returnStdout: true).trim()
+ }
+ }
+ }
+ // Exit the build if the Templated files were just updated
+ stage('Template-exit') {
+ when {
+ branch "master"
+ environment name: 'CHANGE_ID', value: ''
+ environment name: 'FILES_UPDATED', value: 'true'
+ expression {
+ env.CONTAINER_NAME != null
+ }
+ }
+ steps {
+ script{
+ env.EXIT_STATUS = 'ABORTED'
+ }
+ }
+ }
+ /* ###############
+ Build Container
+ ############### */
+ // Build Docker container for push to LS Repo
+ stage('Build-Single') {
+ when {
+ environment name: 'MULTIARCH', value: 'false'
+ environment name: 'EXIT_STATUS', value: ''
+ }
+ steps {
+ sh "docker build --no-cache --pull -t ${IMAGE}:${META_TAG} \
+ --build-arg ${BUILD_VERSION_ARG}=${EXT_RELEASE} --build-arg VERSION=\"${META_TAG}\" --build-arg BUILD_DATE=${GITHUB_DATE} ."
+ }
+ }
+ // Build MultiArch Docker containers for push to LS Repo
+ stage('Build-Multi') {
+ when {
+ environment name: 'MULTIARCH', value: 'true'
+ environment name: 'EXIT_STATUS', value: ''
+ }
+ parallel {
+ stage('Build X86') {
+ steps {
+ sh "docker build --no-cache --pull -t ${IMAGE}:amd64-${META_TAG} \
+ --build-arg ${BUILD_VERSION_ARG}=${EXT_RELEASE} --build-arg VERSION=\"${META_TAG}\" --build-arg BUILD_DATE=${GITHUB_DATE} ."
+ }
+ }
+ stage('Build ARMHF') {
+ agent {
+ label 'ARMHF'
+ }
+ steps {
+ withCredentials([
+ [
+ $class: 'UsernamePasswordMultiBinding',
+ credentialsId: '3f9ba4d5-100d-45b0-a3c4-633fd6061207',
+ usernameVariable: 'DOCKERUSER',
+ passwordVariable: 'DOCKERPASS'
+ ]
+ ]) {
+ echo 'Logging into DockerHub'
+ sh '''#! /bin/bash
+ echo $DOCKERPASS | docker login -u $DOCKERUSER --password-stdin
+ '''
+ sh "docker build --no-cache --pull -f Dockerfile.armhf -t ${IMAGE}:arm32v7-${META_TAG} \
+ --build-arg ${BUILD_VERSION_ARG}=${EXT_RELEASE} --build-arg VERSION=\"${META_TAG}\" --build-arg BUILD_DATE=${GITHUB_DATE} ."
+ sh "docker tag ${IMAGE}:arm32v7-${META_TAG} lsiodev/buildcache:arm32v7-${COMMIT_SHA}-${BUILD_NUMBER}"
+ sh "docker push lsiodev/buildcache:arm32v7-${COMMIT_SHA}-${BUILD_NUMBER}"
+ sh '''docker rmi \
+ ${IMAGE}:arm32v7-${META_TAG} \
+ lsiodev/buildcache:arm32v7-${COMMIT_SHA}-${BUILD_NUMBER} || :'''
+ }
+ }
+ }
+ stage('Build ARM64') {
+ agent {
+ label 'ARM64'
+ }
+ steps {
+ withCredentials([
+ [
+ $class: 'UsernamePasswordMultiBinding',
+ credentialsId: '3f9ba4d5-100d-45b0-a3c4-633fd6061207',
+ usernameVariable: 'DOCKERUSER',
+ passwordVariable: 'DOCKERPASS'
+ ]
+ ]) {
+ echo 'Logging into DockerHub'
+ sh '''#! /bin/bash
+ echo $DOCKERPASS | docker login -u $DOCKERUSER --password-stdin
+ '''
+ sh "docker build --no-cache --pull -f Dockerfile.aarch64 -t ${IMAGE}:arm64v8-${META_TAG} \
+ --build-arg ${BUILD_VERSION_ARG}=${EXT_RELEASE} --build-arg VERSION=\"${META_TAG}\" --build-arg BUILD_DATE=${GITHUB_DATE} ."
+ sh "docker tag ${IMAGE}:arm64v8-${META_TAG} lsiodev/buildcache:arm64v8-${COMMIT_SHA}-${BUILD_NUMBER}"
+ sh "docker push lsiodev/buildcache:arm64v8-${COMMIT_SHA}-${BUILD_NUMBER}"
+ sh '''docker rmi \
+ ${IMAGE}:arm64v8-${META_TAG} \
+ lsiodev/buildcache:arm64v8-${COMMIT_SHA}-${BUILD_NUMBER} || :'''
+ }
+ }
+ }
+ }
+ }
+ // Take the image we just built and dump package versions for comparison
+ stage('Update-packages') {
+ when {
+ branch "master"
+ environment name: 'CHANGE_ID', value: ''
+ environment name: 'EXIT_STATUS', value: ''
+ }
+ steps {
+ sh '''#! /bin/bash
+ set -e
+ TEMPDIR=$(mktemp -d)
+ if [ "${MULTIARCH}" == "true" ]; then
+ LOCAL_CONTAINER=${IMAGE}:amd64-${META_TAG}
+ else
+ LOCAL_CONTAINER=${IMAGE}:${META_TAG}
+ fi
+ if [ "${DIST_IMAGE}" == "alpine" ]; then
+ docker run --rm --entrypoint '/bin/sh' -v ${TEMPDIR}:/tmp ${LOCAL_CONTAINER} -c '\
+ apk info -v > /tmp/package_versions.txt && \
+ sort -o /tmp/package_versions.txt /tmp/package_versions.txt && \
+ chmod 777 /tmp/package_versions.txt'
+ elif [ "${DIST_IMAGE}" == "ubuntu" ]; then
+ docker run --rm --entrypoint '/bin/sh' -v ${TEMPDIR}:/tmp ${LOCAL_CONTAINER} -c '\
+ apt list -qq --installed | sed "s#/.*now ##g" | cut -d" " -f1 > /tmp/package_versions.txt && \
+ sort -o /tmp/package_versions.txt /tmp/package_versions.txt && \
+ chmod 777 /tmp/package_versions.txt'
+ fi
+ NEW_PACKAGE_TAG=$(md5sum ${TEMPDIR}/package_versions.txt | cut -c1-8 )
+ echo "Package tag sha from current packages in buit container is ${NEW_PACKAGE_TAG} comparing to old ${PACKAGE_TAG} from github"
+ if [ "${NEW_PACKAGE_TAG}" != "${PACKAGE_TAG}" ]; then
+ git clone https://github.com/${LS_USER}/${LS_REPO}.git ${TEMPDIR}/${LS_REPO}
+ git --git-dir ${TEMPDIR}/${LS_REPO}/.git checkout -f master
+ cp ${TEMPDIR}/package_versions.txt ${TEMPDIR}/${LS_REPO}/
+ cd ${TEMPDIR}/${LS_REPO}/
+ wait
+ git add package_versions.txt
+ git commit -m 'Bot Updating Package Versions'
+ git push https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/${LS_USER}/${LS_REPO}.git --all
+ echo "true" > /tmp/packages-${COMMIT_SHA}-${BUILD_NUMBER}
+ echo "Package tag updated, stopping build process"
+ else
+ echo "false" > /tmp/packages-${COMMIT_SHA}-${BUILD_NUMBER}
+ echo "Package tag is same as previous continue with build process"
+ fi
+ rm -Rf ${TEMPDIR}'''
+ script{
+ env.PACKAGE_UPDATED = sh(
+ script: '''cat /tmp/packages-${COMMIT_SHA}-${BUILD_NUMBER}''',
+ returnStdout: true).trim()
+ }
+ }
+ }
+ // Exit the build if the package file was just updated
+ stage('PACKAGE-exit') {
+ when {
+ branch "master"
+ environment name: 'CHANGE_ID', value: ''
+ environment name: 'PACKAGE_UPDATED', value: 'true'
+ environment name: 'EXIT_STATUS', value: ''
+ }
+ steps {
+ script{
+ env.EXIT_STATUS = 'ABORTED'
+ }
+ }
+ }
+ // Exit the build if this is just a package check and there are no changes to push
+ stage('PACKAGECHECK-exit') {
+ when {
+ branch "master"
+ environment name: 'CHANGE_ID', value: ''
+ environment name: 'PACKAGE_UPDATED', value: 'false'
+ environment name: 'EXIT_STATUS', value: ''
+ expression {
+ params.PACKAGE_CHECK == 'true'
+ }
+ }
+ steps {
+ script{
+ env.EXIT_STATUS = 'ABORTED'
+ }
+ }
+ }
+ /* #######
+ Testing
+ ####### */
+ // Run Container tests
+ stage('Test') {
+ when {
+ environment name: 'CI', value: 'true'
+ environment name: 'EXIT_STATUS', value: ''
+ }
+ steps {
+ withCredentials([
+ string(credentialsId: 'spaces-key', variable: 'DO_KEY'),
+ string(credentialsId: 'spaces-secret', variable: 'DO_SECRET')
+ ]) {
+ script{
+ env.CI_URL = 'https://lsio-ci.ams3.digitaloceanspaces.com/' + env.IMAGE + '/' + env.META_TAG + '/index.html'
+ }
+ sh '''#! /bin/bash
+ set -e
+ docker pull lsiodev/ci:latest
+ if [ "${MULTIARCH}" == "true" ]; then
+ docker pull lsiodev/buildcache:arm32v7-${COMMIT_SHA}-${BUILD_NUMBER}
+ docker pull lsiodev/buildcache:arm64v8-${COMMIT_SHA}-${BUILD_NUMBER}
+ docker tag lsiodev/buildcache:arm32v7-${COMMIT_SHA}-${BUILD_NUMBER} ${IMAGE}:arm32v7-${META_TAG}
+ docker tag lsiodev/buildcache:arm64v8-${COMMIT_SHA}-${BUILD_NUMBER} ${IMAGE}:arm64v8-${META_TAG}
+ fi
+ docker run --rm \
+ -v /var/run/docker.sock:/var/run/docker.sock \
+ -e IMAGE=\"${IMAGE}\" \
+ -e DELAY_START=\"${CI_DELAY}\" \
+ -e TAGS=\"${CI_TAGS}\" \
+ -e META_TAG=\"${META_TAG}\" \
+ -e PORT=\"${CI_PORT}\" \
+ -e SSL=\"${CI_SSL}\" \
+ -e BASE=\"${DIST_IMAGE}\" \
+ -e SECRET_KEY=\"${DO_SECRET}\" \
+ -e ACCESS_KEY=\"${DO_KEY}\" \
+ -e DOCKER_ENV=\"${CI_DOCKERENV}\" \
+ -e WEB_SCREENSHOT=\"${CI_WEB}\" \
+ -e WEB_AUTH=\"${CI_AUTH}\" \
+ -e WEB_PATH=\"${CI_WEBPATH}\" \
+ -e DO_REGION="ams3" \
+ -e DO_BUCKET="lsio-ci" \
+ -t lsiodev/ci:latest \
+ python /ci/ci.py'''
+ }
+ }
+ }
+ /* ##################
+ Release Logic
+ ################## */
+ // If this is an amd64 only image only push a single image
+ stage('Docker-Push-Single') {
+ when {
+ environment name: 'MULTIARCH', value: 'false'
+ environment name: 'EXIT_STATUS', value: ''
+ }
+ steps {
+ withCredentials([
+ [
+ $class: 'UsernamePasswordMultiBinding',
+ credentialsId: '3f9ba4d5-100d-45b0-a3c4-633fd6061207',
+ usernameVariable: 'DOCKERUSER',
+ passwordVariable: 'DOCKERPASS'
+ ]
+ ]) {
+ echo 'Logging into DockerHub'
+ sh '''#! /bin/bash
+ echo $DOCKERPASS | docker login -u $DOCKERUSER --password-stdin
+ '''
+ sh "docker tag ${IMAGE}:${META_TAG} ${IMAGE}:latest"
+ sh "docker push ${IMAGE}:latest"
+ sh "docker push ${IMAGE}:${META_TAG}"
+ sh '''docker rmi \
+ ${IMAGE}:${META_TAG} \
+ ${IMAGE}:latest || :'''
+
+ }
+ }
+ }
+ // If this is a multi arch release push all images and define the manifest
+ stage('Docker-Push-Multi') {
+ when {
+ environment name: 'MULTIARCH', value: 'true'
+ environment name: 'EXIT_STATUS', value: ''
+ }
+ steps {
+ withCredentials([
+ [
+ $class: 'UsernamePasswordMultiBinding',
+ credentialsId: '3f9ba4d5-100d-45b0-a3c4-633fd6061207',
+ usernameVariable: 'DOCKERUSER',
+ passwordVariable: 'DOCKERPASS'
+ ]
+ ]) {
+ sh '''#! /bin/bash
+ echo $DOCKERPASS | docker login -u $DOCKERUSER --password-stdin
+ '''
+ sh '''#! /bin/bash
+ if [ "${CI}" == "false" ]; then
+ docker pull lsiodev/buildcache:arm32v7-${COMMIT_SHA}-${BUILD_NUMBER}
+ docker pull lsiodev/buildcache:arm64v8-${COMMIT_SHA}-${BUILD_NUMBER}
+ docker tag lsiodev/buildcache:arm32v7-${COMMIT_SHA}-${BUILD_NUMBER} ${IMAGE}:arm32v7-${META_TAG}
+ docker tag lsiodev/buildcache:arm64v8-${COMMIT_SHA}-${BUILD_NUMBER} ${IMAGE}:arm64v8-${META_TAG}
+ fi'''
+ sh "docker tag ${IMAGE}:amd64-${META_TAG} ${IMAGE}:amd64-latest"
+ sh "docker tag ${IMAGE}:arm32v7-${META_TAG} ${IMAGE}:arm32v7-latest"
+ sh "docker tag ${IMAGE}:arm64v8-${META_TAG} ${IMAGE}:arm64v8-latest"
+ sh "docker push ${IMAGE}:amd64-${META_TAG}"
+ sh "docker push ${IMAGE}:arm32v7-${META_TAG}"
+ sh "docker push ${IMAGE}:arm64v8-${META_TAG}"
+ sh "docker push ${IMAGE}:amd64-latest"
+ sh "docker push ${IMAGE}:arm32v7-latest"
+ sh "docker push ${IMAGE}:arm64v8-latest"
+ sh "docker manifest push --purge ${IMAGE}:latest || :"
+ sh "docker manifest create ${IMAGE}:latest ${IMAGE}:amd64-latest ${IMAGE}:arm32v7-latest ${IMAGE}:arm64v8-latest"
+ sh "docker manifest annotate ${IMAGE}:latest ${IMAGE}:arm32v7-latest --os linux --arch arm"
+ sh "docker manifest annotate ${IMAGE}:latest ${IMAGE}:arm64v8-latest --os linux --arch arm64 --variant v8"
+ sh "docker manifest push --purge ${IMAGE}:${META_TAG} || :"
+ sh "docker manifest create ${IMAGE}:${META_TAG} ${IMAGE}:amd64-${META_TAG} ${IMAGE}:arm32v7-${META_TAG} ${IMAGE}:arm64v8-${META_TAG}"
+ sh "docker manifest annotate ${IMAGE}:${META_TAG} ${IMAGE}:arm32v7-${META_TAG} --os linux --arch arm"
+ sh "docker manifest annotate ${IMAGE}:${META_TAG} ${IMAGE}:arm64v8-${META_TAG} --os linux --arch arm64 --variant v8"
+ sh "docker manifest push --purge ${IMAGE}:latest"
+ sh "docker manifest push --purge ${IMAGE}:${META_TAG}"
+ }
+ }
+ }
+ // If this is a public release tag it in the LS Github
+ stage('Github-Tag-Push-Release') {
+ when {
+ branch "master"
+ expression {
+ env.LS_RELEASE != env.EXT_RELEASE_CLEAN + '-ls' + env.LS_TAG_NUMBER
+ }
+ environment name: 'CHANGE_ID', value: ''
+ environment name: 'EXIT_STATUS', value: ''
+ }
+ steps {
+ echo "Pushing New tag for current commit ${EXT_RELEASE_CLEAN}-ls${LS_TAG_NUMBER}"
+ sh '''curl -H "Authorization: token ${GITHUB_TOKEN}" -X POST https://api.github.com/repos/${LS_USER}/${LS_REPO}/git/tags \
+ -d '{"tag":"'${EXT_RELEASE_CLEAN}'-ls'${LS_TAG_NUMBER}'",\
+ "object": "'${COMMIT_SHA}'",\
+ "message": "Tagging Release '${EXT_RELEASE_CLEAN}'-ls'${LS_TAG_NUMBER}' to master",\
+ "type": "commit",\
+ "tagger": {"name": "LinuxServer Jenkins","email": "jenkins@linuxserver.io","date": "'${GITHUB_DATE}'"}}' '''
+ echo "Pushing New release for Tag"
+ sh '''#! /bin/bash
+ curl -s https://api.github.com/repos/${EXT_USER}/${EXT_REPO}/commits/${EXT_GIT_BRANCH} | jq '. | .commit.message' | sed 's:^.\\(.*\\).$:\\1:' > releasebody.json
+ echo '{"tag_name":"'${EXT_RELEASE_CLEAN}'-ls'${LS_TAG_NUMBER}'",\
+ "target_commitish": "master",\
+ "name": "'${EXT_RELEASE_CLEAN}'-ls'${LS_TAG_NUMBER}'",\
+ "body": "**LinuxServer Changes:**\\n\\n'${LS_RELEASE_NOTES}'\\n**'${EXT_REPO}' Changes:**\\n\\n' > start
+ printf '","draft": false,"prerelease": false}' >> releasebody.json
+ paste -d'\\0' start releasebody.json > releasebody.json.done
+ curl -H "Authorization: token ${GITHUB_TOKEN}" -X POST https://api.github.com/repos/${LS_USER}/${LS_REPO}/releases -d @releasebody.json.done'''
+ }
+ }
+ // Use helper container to sync the current README on master to the dockerhub endpoint
+ stage('Sync-README') {
+ when {
+ environment name: 'CHANGE_ID', value: ''
+ environment name: 'EXIT_STATUS', value: ''
+ }
+ steps {
+ withCredentials([
+ [
+ $class: 'UsernamePasswordMultiBinding',
+ credentialsId: '3f9ba4d5-100d-45b0-a3c4-633fd6061207',
+ usernameVariable: 'DOCKERUSER',
+ passwordVariable: 'DOCKERPASS'
+ ]
+ ]) {
+ sh '''#! /bin/bash
+ docker pull lsiodev/readme-sync
+ docker run --rm=true \
+ -e DOCKERHUB_USERNAME=$DOCKERUSER \
+ -e DOCKERHUB_PASSWORD=$DOCKERPASS \
+ -e GIT_REPOSITORY=${LS_USER}/${LS_REPO} \
+ -e DOCKER_REPOSITORY=${IMAGE} \
+ -e GIT_BRANCH=master \
+ lsiodev/readme-sync bash -c 'node sync' '''
+ }
+ }
+ }
+ // If this is a Pull request send the CI link as a comment on it
+ stage('Pull Request Comment') {
+ when {
+ not {environment name: 'CHANGE_ID', value: ''}
+ environment name: 'CI', value: 'true'
+ environment name: 'EXIT_STATUS', value: ''
+ }
+ steps {
+ sh '''curl -H "Authorization: token ${GITHUB_TOKEN}" -X POST https://api.github.com/repos/${LS_USER}/${LS_REPO}/issues/${PULL_REQUEST}/comments \
+ -d '{"body": "I am a bot, here are the test results for this PR: \\n'${CI_URL}' \\n'${SHELLCHECK_URL}'"}' '''
+ }
+ }
+ }
+ /* ######################
+ Send status to Discord
+ ###################### */
+ post {
+ always {
+ script{
+ if (env.EXIT_STATUS == "ABORTED"){
+ sh 'echo "build aborted"'
+ }
+ else if (currentBuild.currentResult == "SUCCESS"){
+ sh ''' curl -X POST --data '{"avatar_url": "https://wiki.jenkins-ci.org/download/attachments/2916393/headshot.png","embeds": [{"color": 1681177,\
+ "description": "**Build:** '${BUILD_NUMBER}'\\n**CI Results:** '${CI_URL}'\\n**ShellCheck Results:** '${SHELLCHECK_URL}'\\n**Status:** Success\\n**Job:** '${RUN_DISPLAY_URL}'\\n**Change:** '${CODE_URL}'\\n**External Release:**: '${RELEASE_LINK}'\\n**DockerHub:** '${DOCKERHUB_LINK}'\\n"}],\
+ "username": "Jenkins"}' ${BUILDS_DISCORD} '''
+ }
+ else {
+ sh ''' curl -X POST --data '{"avatar_url": "https://wiki.jenkins-ci.org/download/attachments/2916393/headshot.png","embeds": [{"color": 16711680,\
+ "description": "**Build:** '${BUILD_NUMBER}'\\n**CI Results:** '${CI_URL}'\\n**ShellCheck Results:** '${SHELLCHECK_URL}'\\n**Status:** failure\\n**Job:** '${RUN_DISPLAY_URL}'\\n**Change:** '${CODE_URL}'\\n**External Release:**: '${RELEASE_LINK}'\\n**DockerHub:** '${DOCKERHUB_LINK}'\\n"}],\
+ "username": "Jenkins"}' ${BUILDS_DISCORD} '''
+ }
+ }
+ }
+ }
+}
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..f288702
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,674 @@
+ GNU GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc.
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+ The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works. By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users. We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors. You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+ To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights. Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received. You must make sure that they, too, receive
+or can get the source code. And you must show them these terms so they
+know their rights.
+
+ Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+ For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software. For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+ Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so. This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software. The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable. Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products. If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+ Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary. To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ TERMS AND CONDITIONS
+
+ 0. Definitions.
+
+ "This License" refers to version 3 of the GNU General Public License.
+
+ "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+ "The Program" refers to any copyrightable work licensed under this
+License. Each licensee is addressed as "you". "Licensees" and
+"recipients" may be individuals or organizations.
+
+ To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy. The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+ A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+ To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy. Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+ To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies. Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+ An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License. If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+ 1. Source Code.
+
+ The "source code" for a work means the preferred form of the work
+for making modifications to it. "Object code" means any non-source
+form of a work.
+
+ A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+ The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form. A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+ The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities. However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work. For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+ The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+ The Corresponding Source for a work in source code form is that
+same work.
+
+ 2. Basic Permissions.
+
+ All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met. This License explicitly affirms your unlimited
+permission to run the unmodified Program. The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work. This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+ You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force. You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright. Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+ Conveying under any other circumstances is permitted solely under
+the conditions stated below. Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+ 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+ No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+ When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+ 4. Conveying Verbatim Copies.
+
+ You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+ You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+ 5. Conveying Modified Source Versions.
+
+ You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+ a) The work must carry prominent notices stating that you modified
+ it, and giving a relevant date.
+
+ b) The work must carry prominent notices stating that it is
+ released under this License and any conditions added under section
+ 7. This requirement modifies the requirement in section 4 to
+ "keep intact all notices".
+
+ c) You must license the entire work, as a whole, under this
+ License to anyone who comes into possession of a copy. This
+ License will therefore apply, along with any applicable section 7
+ additional terms, to the whole of the work, and all its parts,
+ regardless of how they are packaged. This License gives no
+ permission to license the work in any other way, but it does not
+ invalidate such permission if you have separately received it.
+
+ d) If the work has interactive user interfaces, each must display
+ Appropriate Legal Notices; however, if the Program has interactive
+ interfaces that do not display Appropriate Legal Notices, your
+ work need not make them do so.
+
+ A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit. Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+ 6. Conveying Non-Source Forms.
+
+ You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+ a) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by the
+ Corresponding Source fixed on a durable physical medium
+ customarily used for software interchange.
+
+ b) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by a
+ written offer, valid for at least three years and valid for as
+ long as you offer spare parts or customer support for that product
+ model, to give anyone who possesses the object code either (1) a
+ copy of the Corresponding Source for all the software in the
+ product that is covered by this License, on a durable physical
+ medium customarily used for software interchange, for a price no
+ more than your reasonable cost of physically performing this
+ conveying of source, or (2) access to copy the
+ Corresponding Source from a network server at no charge.
+
+ c) Convey individual copies of the object code with a copy of the
+ written offer to provide the Corresponding Source. This
+ alternative is allowed only occasionally and noncommercially, and
+ only if you received the object code with such an offer, in accord
+ with subsection 6b.
+
+ d) Convey the object code by offering access from a designated
+ place (gratis or for a charge), and offer equivalent access to the
+ Corresponding Source in the same way through the same place at no
+ further charge. You need not require recipients to copy the
+ Corresponding Source along with the object code. If the place to
+ copy the object code is a network server, the Corresponding Source
+ may be on a different server (operated by you or a third party)
+ that supports equivalent copying facilities, provided you maintain
+ clear directions next to the object code saying where to find the
+ Corresponding Source. Regardless of what server hosts the
+ Corresponding Source, you remain obligated to ensure that it is
+ available for as long as needed to satisfy these requirements.
+
+ e) Convey the object code using peer-to-peer transmission, provided
+ you inform other peers where the object code and Corresponding
+ Source of the work are being offered to the general public at no
+ charge under subsection 6d.
+
+ A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+ A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling. In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage. For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product. A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+ "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source. The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+ If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information. But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+ The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed. Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+ Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+ 7. Additional Terms.
+
+ "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law. If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+ When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it. (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.) You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+ Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+ a) Disclaiming warranty or limiting liability differently from the
+ terms of sections 15 and 16 of this License; or
+
+ b) Requiring preservation of specified reasonable legal notices or
+ author attributions in that material or in the Appropriate Legal
+ Notices displayed by works containing it; or
+
+ c) Prohibiting misrepresentation of the origin of that material, or
+ requiring that modified versions of such material be marked in
+ reasonable ways as different from the original version; or
+
+ d) Limiting the use for publicity purposes of names of licensors or
+ authors of the material; or
+
+ e) Declining to grant rights under trademark law for use of some
+ trade names, trademarks, or service marks; or
+
+ f) Requiring indemnification of licensors and authors of that
+ material by anyone who conveys the material (or modified versions of
+ it) with contractual assumptions of liability to the recipient, for
+ any liability that these contractual assumptions directly impose on
+ those licensors and authors.
+
+ All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10. If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term. If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+ If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+ Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+ 8. Termination.
+
+ You may not propagate or modify a covered work except as expressly
+provided under this License. Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+ However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+ Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+ Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License. If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+ 9. Acceptance Not Required for Having Copies.
+
+ You are not required to accept this License in order to receive or
+run a copy of the Program. Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance. However,
+nothing other than this License grants you permission to propagate or
+modify any covered work. These actions infringe copyright if you do
+not accept this License. Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+ 10. Automatic Licensing of Downstream Recipients.
+
+ Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License. You are not responsible
+for enforcing compliance by third parties with this License.
+
+ An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations. If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+ You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License. For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+ 11. Patents.
+
+ A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based. The
+work thus licensed is called the contributor's "contributor version".
+
+ A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version. For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+ Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+ In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement). To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+ If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients. "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+ If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+ A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License. You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+ Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+ 12. No Surrender of Others' Freedom.
+
+ If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all. For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+ 13. Use with the GNU Affero General Public License.
+
+ Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work. The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+ 14. Revised Versions of this License.
+
+ The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+ Each version is given a distinguishing version number. If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation. If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+ If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+ Later license versions may give you additional or different
+permissions. However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+ 15. Disclaimer of Warranty.
+
+ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+ 16. Limitation of Liability.
+
+ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+ 17. Interpretation of Sections 15 and 16.
+
+ If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+
+ Copyright (C)
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program. If not, see .
+
+Also add information on how to contact you by electronic and paper mail.
+
+ If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+ Copyright (C)
+ This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+ You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+.
+
+ The GNU General Public License does not permit incorporating your program
+into proprietary programs. If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library. If this is what you want to do, use the GNU Lesser General
+Public License instead of this License. But first, please read
+.