diff --git a/.dockerignore b/.dockerignore
new file mode 100644
index 0000000..4a23c0f
--- /dev/null
+++ b/.dockerignore
@@ -0,0 +1,5 @@
+.git
+.gitignore
+.github
+.gitattributes
+READMETEMPLATE.md
diff --git a/.gitattributes b/.gitattributes
new file mode 100644
index 0000000..bdb0cab
--- /dev/null
+++ b/.gitattributes
@@ -0,0 +1,17 @@
+# Auto detect text files and perform LF normalization
+* text=auto
+
+# Custom for Visual Studio
+*.cs diff=csharp
+
+# Standard to msysgit
+*.doc diff=astextplain
+*.DOC diff=astextplain
+*.docx diff=astextplain
+*.DOCX diff=astextplain
+*.dot diff=astextplain
+*.DOT diff=astextplain
+*.pdf diff=astextplain
+*.PDF diff=astextplain
+*.rtf diff=astextplain
+*.RTF diff=astextplain
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
new file mode 100755
index 0000000..dc31dc8
--- /dev/null
+++ b/.github/FUNDING.yml
@@ -0,0 +1,3 @@
+github: linuxserver
+open_collective: linuxserver
+custom: ["https://supporters.eff.org/donate/support-work-on-certbot",]
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
new file mode 100644
index 0000000..5b2d56b
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE.md
@@ -0,0 +1,34 @@
+[linuxserverurl]: https://linuxserver.io
+[][linuxserverurl]
+
+If you are new to Docker or this application our issue tracker is **ONLY** used for reporting bugs or requesting features. Please use [our discord server](https://discord.gg/YWrKVTn) for general support.
+
+
+
+------------------------------
+
+## Expected Behavior
+
+
+## Current Behavior
+
+
+## Steps to Reproduce
+
+
+1.
+2.
+3.
+4.
+
+## Environment
+**OS:**
+**CPU architecture:** x86_64/arm32/arm64
+**How docker service was installed:**
+
+
+## Command used to create docker container (run/create/compose/screenshot)
+
+
+## Docker logs
+
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 0000000..26d5031
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,39 @@
+
+
+[linuxserverurl]: https://linuxserver.io
+[][linuxserverurl]
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+------------------------------
+
+We welcome all PR’s though this doesn’t guarantee it will be accepted.
+
+## Description:
+
+
+## Benefits of this PR and context:
+
+
+## How Has This Been Tested?
+
+
+
+
+
+## Source / References:
+
diff --git a/.github/workflows/greetings.yml b/.github/workflows/greetings.yml
new file mode 100644
index 0000000..5756b3f
--- /dev/null
+++ b/.github/workflows/greetings.yml
@@ -0,0 +1,13 @@
+name: Greetings
+
+on: [pull_request, issues]
+
+jobs:
+ greeting:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/first-interaction@v1
+ with:
+ issue-message: 'Thanks for opening your first issue here! Be sure to follow the [issue template](https://github.com/linuxserver/docker-swag/.github/ISSUE_TEMPLATE.md)!'
+ pr-message: 'Thanks for opening this pull request! Be sure to follow the [pull request template](https://github.com/linuxserver/docker-swag/.github/PULL_REQUEST_TEMPLATE.md)!'
+ repo-token: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml
new file mode 100644
index 0000000..1806420
--- /dev/null
+++ b/.github/workflows/stale.yml
@@ -0,0 +1,23 @@
+name: Mark stale issues and pull requests
+
+on:
+ schedule:
+ - cron: "30 1 * * *"
+
+jobs:
+ stale:
+
+ runs-on: ubuntu-latest
+
+ steps:
+ - uses: actions/stale@v1
+ with:
+ stale-issue-message: "This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions."
+ stale-pr-message: "This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions."
+ stale-issue-label: 'no-issue-activity'
+ stale-pr-label: 'no-pr-activity'
+ days-before-stale: 30
+ days-before-close: 365
+ exempt-issue-labels: 'awaiting-approval,work-in-progress'
+ exempt-pr-labels: 'awaiting-approval,work-in-progress'
+ repo-token: ${{ secrets.GITHUB_TOKEN }}
diff --git a/Dockerfile b/Dockerfile
new file mode 100755
index 0000000..0581311
--- /dev/null
+++ b/Dockerfile
@@ -0,0 +1,149 @@
+FROM lsiobase/nginx:3.12
+
+# set version label
+ARG BUILD_DATE
+ARG VERSION
+ARG CERTBOT_VERSION
+LABEL build_version="Linuxserver.io version:- ${VERSION} Build-date:- ${BUILD_DATE}"
+LABEL maintainer="aptalca"
+
+# environment settings
+ENV DHLEVEL=2048 ONLY_SUBDOMAINS=false AWS_CONFIG_FILE=/config/dns-conf/route53.ini
+ENV S6_BEHAVIOUR_IF_STAGE2_FAILS=2
+
+RUN \
+ echo "**** install build packages ****" && \
+ apk add --no-cache --virtual=build-dependencies \
+ g++ \
+ gcc \
+ libffi-dev \
+ openssl-dev \
+ python3-dev && \
+ echo "**** install runtime packages ****" && \
+ apk add --no-cache --upgrade \
+ curl \
+ fail2ban \
+ gnupg \
+ memcached \
+ nginx \
+ nginx-mod-http-echo \
+ nginx-mod-http-fancyindex \
+ nginx-mod-http-geoip2 \
+ nginx-mod-http-headers-more \
+ nginx-mod-http-image-filter \
+ nginx-mod-http-lua \
+ nginx-mod-http-lua-upstream \
+ nginx-mod-http-nchan \
+ nginx-mod-http-perl \
+ nginx-mod-http-redis2 \
+ nginx-mod-http-set-misc \
+ nginx-mod-http-upload-progress \
+ nginx-mod-http-xslt-filter \
+ nginx-mod-mail \
+ nginx-mod-rtmp \
+ nginx-mod-stream \
+ nginx-mod-stream-geoip2 \
+ nginx-vim \
+ php7-bcmath \
+ php7-bz2 \
+ php7-ctype \
+ php7-curl \
+ php7-dom \
+ php7-exif \
+ php7-ftp \
+ php7-gd \
+ php7-iconv \
+ php7-imap \
+ php7-intl \
+ php7-ldap \
+ php7-mcrypt \
+ php7-memcached \
+ php7-mysqli \
+ php7-mysqlnd \
+ php7-opcache \
+ php7-pdo_mysql \
+ php7-pdo_odbc \
+ php7-pdo_pgsql \
+ php7-pdo_sqlite \
+ php7-pear \
+ php7-pecl-apcu \
+ php7-pecl-redis \
+ php7-pgsql \
+ php7-phar \
+ php7-posix \
+ php7-soap \
+ php7-sockets \
+ php7-sodium \
+ php7-sqlite3 \
+ php7-tokenizer \
+ php7-xml \
+ php7-xmlreader \
+ php7-xmlrpc \
+ php7-zip \
+ py3-cryptography \
+ py3-future \
+ py3-pip \
+ whois && \
+ echo "**** install certbot plugins ****" && \
+ if [ -z ${CERTBOT_VERSION+x} ]; then \
+ CERTBOT="certbot"; \
+ else \
+ CERTBOT="certbot==${CERTBOT_VERSION}"; \
+ fi && \
+ pip3 install -U \
+ pip && \
+ pip3 install -U \
+ ${CERTBOT} \
+ certbot-dns-aliyun \
+ certbot-dns-cloudflare \
+ certbot-dns-cloudxns \
+ certbot-dns-cpanel \
+ certbot-dns-digitalocean \
+ certbot-dns-dnsimple \
+ certbot-dns-dnsmadeeasy \
+ certbot-dns-domeneshop \
+ certbot-dns-google \
+ certbot-dns-inwx \
+ certbot-dns-linode \
+ certbot-dns-luadns \
+ certbot-dns-nsone \
+ certbot-dns-ovh \
+ certbot-dns-rfc2136 \
+ certbot-dns-route53 \
+ certbot-dns-transip \
+ certbot-plugin-gandi \
+ cryptography \
+ requests && \
+ echo "**** remove unnecessary fail2ban filters ****" && \
+ rm \
+ /etc/fail2ban/jail.d/alpine-ssh.conf && \
+ echo "**** copy fail2ban default action and filter to /default ****" && \
+ mkdir -p /defaults/fail2ban && \
+ mv /etc/fail2ban/action.d /defaults/fail2ban/ && \
+ mv /etc/fail2ban/filter.d /defaults/fail2ban/ && \
+ echo "**** copy proxy confs to /default ****" && \
+ mkdir -p /defaults/proxy-confs && \
+ curl -o \
+ /tmp/proxy.tar.gz -L \
+ "https://github.com/linuxserver/reverse-proxy-confs/tarball/master" && \
+ tar xf \
+ /tmp/proxy.tar.gz -C \
+ /defaults/proxy-confs --strip-components=1 --exclude=linux*/.gitattributes --exclude=linux*/.github --exclude=linux*/.gitignore --exclude=linux*/LICENSE && \
+ echo "**** configure nginx ****" && \
+ rm -f /etc/nginx/conf.d/default.conf && \
+ curl -o \
+ /defaults/dhparams.pem -L \
+ "https://lsio.ams3.digitaloceanspaces.com/dhparams.pem" && \
+ echo "**** cleanup ****" && \
+ apk del --purge \
+ build-dependencies && \
+ for cleanfiles in *.pyc *.pyo; \
+ do \
+ find /usr/lib/python3.* -iname "${cleanfiles}" -exec rm -f '{}' + \
+ ; done && \
+ rm -rf \
+ /tmp/* \
+ /root/.cache
+
+# add local files
+COPY root/ /
diff --git a/Dockerfile.aarch64 b/Dockerfile.aarch64
new file mode 100755
index 0000000..6c9af0b
--- /dev/null
+++ b/Dockerfile.aarch64
@@ -0,0 +1,149 @@
+FROM lsiobase/nginx:arm64v8-3.12
+
+# set version label
+ARG BUILD_DATE
+ARG VERSION
+ARG CERTBOT_VERSION
+LABEL build_version="Linuxserver.io version:- ${VERSION} Build-date:- ${BUILD_DATE}"
+LABEL maintainer="aptalca"
+
+# environment settings
+ENV DHLEVEL=2048 ONLY_SUBDOMAINS=false AWS_CONFIG_FILE=/config/dns-conf/route53.ini
+ENV S6_BEHAVIOUR_IF_STAGE2_FAILS=2
+
+RUN \
+ echo "**** install build packages ****" && \
+ apk add --no-cache --virtual=build-dependencies \
+ g++ \
+ gcc \
+ libffi-dev \
+ openssl-dev \
+ python3-dev && \
+ echo "**** install runtime packages ****" && \
+ apk add --no-cache --upgrade \
+ curl \
+ fail2ban \
+ gnupg \
+ memcached \
+ nginx \
+ nginx-mod-http-echo \
+ nginx-mod-http-fancyindex \
+ nginx-mod-http-geoip2 \
+ nginx-mod-http-headers-more \
+ nginx-mod-http-image-filter \
+ nginx-mod-http-lua \
+ nginx-mod-http-lua-upstream \
+ nginx-mod-http-nchan \
+ nginx-mod-http-perl \
+ nginx-mod-http-redis2 \
+ nginx-mod-http-set-misc \
+ nginx-mod-http-upload-progress \
+ nginx-mod-http-xslt-filter \
+ nginx-mod-mail \
+ nginx-mod-rtmp \
+ nginx-mod-stream \
+ nginx-mod-stream-geoip2 \
+ nginx-vim \
+ php7-bcmath \
+ php7-bz2 \
+ php7-ctype \
+ php7-curl \
+ php7-dom \
+ php7-exif \
+ php7-ftp \
+ php7-gd \
+ php7-iconv \
+ php7-imap \
+ php7-intl \
+ php7-ldap \
+ php7-mcrypt \
+ php7-memcached \
+ php7-mysqli \
+ php7-mysqlnd \
+ php7-opcache \
+ php7-pdo_mysql \
+ php7-pdo_odbc \
+ php7-pdo_pgsql \
+ php7-pdo_sqlite \
+ php7-pear \
+ php7-pecl-apcu \
+ php7-pecl-redis \
+ php7-pgsql \
+ php7-phar \
+ php7-posix \
+ php7-soap \
+ php7-sockets \
+ php7-sodium \
+ php7-sqlite3 \
+ php7-tokenizer \
+ php7-xml \
+ php7-xmlreader \
+ php7-xmlrpc \
+ php7-zip \
+ py3-cryptography \
+ py3-future \
+ py3-pip \
+ whois && \
+ echo "**** install certbot plugins ****" && \
+ if [ -z ${CERTBOT_VERSION+x} ]; then \
+ CERTBOT="certbot"; \
+ else \
+ CERTBOT="certbot==${CERTBOT_VERSION}"; \
+ fi && \
+ pip3 install -U \
+ pip && \
+ pip3 install -U \
+ ${CERTBOT} \
+ certbot-dns-aliyun \
+ certbot-dns-cloudflare \
+ certbot-dns-cloudxns \
+ certbot-dns-cpanel \
+ certbot-dns-digitalocean \
+ certbot-dns-dnsimple \
+ certbot-dns-dnsmadeeasy \
+ certbot-dns-domeneshop \
+ certbot-dns-google \
+ certbot-dns-inwx \
+ certbot-dns-linode \
+ certbot-dns-luadns \
+ certbot-dns-nsone \
+ certbot-dns-ovh \
+ certbot-dns-rfc2136 \
+ certbot-dns-route53 \
+ certbot-dns-transip \
+ certbot-plugin-gandi \
+ cryptography \
+ requests && \
+ echo "**** remove unnecessary fail2ban filters ****" && \
+ rm \
+ /etc/fail2ban/jail.d/alpine-ssh.conf && \
+ echo "**** copy fail2ban default action and filter to /default ****" && \
+ mkdir -p /defaults/fail2ban && \
+ mv /etc/fail2ban/action.d /defaults/fail2ban/ && \
+ mv /etc/fail2ban/filter.d /defaults/fail2ban/ && \
+ echo "**** copy proxy confs to /default ****" && \
+ mkdir -p /defaults/proxy-confs && \
+ curl -o \
+ /tmp/proxy.tar.gz -L \
+ "https://github.com/linuxserver/reverse-proxy-confs/tarball/master" && \
+ tar xf \
+ /tmp/proxy.tar.gz -C \
+ /defaults/proxy-confs --strip-components=1 --exclude=linux*/.gitattributes --exclude=linux*/.github --exclude=linux*/.gitignore --exclude=linux*/LICENSE && \
+ echo "**** configure nginx ****" && \
+ rm -f /etc/nginx/conf.d/default.conf && \
+ curl -o \
+ /defaults/dhparams.pem -L \
+ "https://lsio.ams3.digitaloceanspaces.com/dhparams.pem" && \
+ echo "**** cleanup ****" && \
+ apk del --purge \
+ build-dependencies && \
+ for cleanfiles in *.pyc *.pyo; \
+ do \
+ find /usr/lib/python3.* -iname "${cleanfiles}" -exec rm -f '{}' + \
+ ; done && \
+ rm -rf \
+ /tmp/* \
+ /root/.cache
+
+# add local files
+COPY root/ /
diff --git a/Dockerfile.armhf b/Dockerfile.armhf
new file mode 100755
index 0000000..bd7d3e1
--- /dev/null
+++ b/Dockerfile.armhf
@@ -0,0 +1,149 @@
+FROM lsiobase/nginx:arm32v7-3.12
+
+# set version label
+ARG BUILD_DATE
+ARG VERSION
+ARG CERTBOT_VERSION
+LABEL build_version="Linuxserver.io version:- ${VERSION} Build-date:- ${BUILD_DATE}"
+LABEL maintainer="aptalca"
+
+# environment settings
+ENV DHLEVEL=2048 ONLY_SUBDOMAINS=false AWS_CONFIG_FILE=/config/dns-conf/route53.ini
+ENV S6_BEHAVIOUR_IF_STAGE2_FAILS=2
+
+RUN \
+ echo "**** install build packages ****" && \
+ apk add --no-cache --virtual=build-dependencies \
+ g++ \
+ gcc \
+ libffi-dev \
+ openssl-dev \
+ python3-dev && \
+ echo "**** install runtime packages ****" && \
+ apk add --no-cache --upgrade \
+ curl \
+ fail2ban \
+ gnupg \
+ memcached \
+ nginx \
+ nginx-mod-http-echo \
+ nginx-mod-http-fancyindex \
+ nginx-mod-http-geoip2 \
+ nginx-mod-http-headers-more \
+ nginx-mod-http-image-filter \
+ nginx-mod-http-lua \
+ nginx-mod-http-lua-upstream \
+ nginx-mod-http-nchan \
+ nginx-mod-http-perl \
+ nginx-mod-http-redis2 \
+ nginx-mod-http-set-misc \
+ nginx-mod-http-upload-progress \
+ nginx-mod-http-xslt-filter \
+ nginx-mod-mail \
+ nginx-mod-rtmp \
+ nginx-mod-stream \
+ nginx-mod-stream-geoip2 \
+ nginx-vim \
+ php7-bcmath \
+ php7-bz2 \
+ php7-ctype \
+ php7-curl \
+ php7-dom \
+ php7-exif \
+ php7-ftp \
+ php7-gd \
+ php7-iconv \
+ php7-imap \
+ php7-intl \
+ php7-ldap \
+ php7-mcrypt \
+ php7-memcached \
+ php7-mysqli \
+ php7-mysqlnd \
+ php7-opcache \
+ php7-pdo_mysql \
+ php7-pdo_odbc \
+ php7-pdo_pgsql \
+ php7-pdo_sqlite \
+ php7-pear \
+ php7-pecl-apcu \
+ php7-pecl-redis \
+ php7-pgsql \
+ php7-phar \
+ php7-posix \
+ php7-soap \
+ php7-sockets \
+ php7-sodium \
+ php7-sqlite3 \
+ php7-tokenizer \
+ php7-xml \
+ php7-xmlreader \
+ php7-xmlrpc \
+ php7-zip \
+ py3-cryptography \
+ py3-future \
+ py3-pip \
+ whois && \
+ echo "**** install certbot plugins ****" && \
+ if [ -z ${CERTBOT_VERSION+x} ]; then \
+ CERTBOT="certbot"; \
+ else \
+ CERTBOT="certbot==${CERTBOT_VERSION}"; \
+ fi && \
+ pip3 install -U \
+ pip && \
+ pip3 install -U \
+ ${CERTBOT} \
+ certbot-dns-aliyun \
+ certbot-dns-cloudflare \
+ certbot-dns-cloudxns \
+ certbot-dns-cpanel \
+ certbot-dns-digitalocean \
+ certbot-dns-dnsimple \
+ certbot-dns-dnsmadeeasy \
+ certbot-dns-domeneshop \
+ certbot-dns-google \
+ certbot-dns-inwx \
+ certbot-dns-linode \
+ certbot-dns-luadns \
+ certbot-dns-nsone \
+ certbot-dns-ovh \
+ certbot-dns-rfc2136 \
+ certbot-dns-route53 \
+ certbot-dns-transip \
+ certbot-plugin-gandi \
+ cryptography \
+ requests && \
+ echo "**** remove unnecessary fail2ban filters ****" && \
+ rm \
+ /etc/fail2ban/jail.d/alpine-ssh.conf && \
+ echo "**** copy fail2ban default action and filter to /default ****" && \
+ mkdir -p /defaults/fail2ban && \
+ mv /etc/fail2ban/action.d /defaults/fail2ban/ && \
+ mv /etc/fail2ban/filter.d /defaults/fail2ban/ && \
+ echo "**** copy proxy confs to /default ****" && \
+ mkdir -p /defaults/proxy-confs && \
+ curl -o \
+ /tmp/proxy.tar.gz -L \
+ "https://github.com/linuxserver/reverse-proxy-confs/tarball/master" && \
+ tar xf \
+ /tmp/proxy.tar.gz -C \
+ /defaults/proxy-confs --strip-components=1 --exclude=linux*/.gitattributes --exclude=linux*/.github --exclude=linux*/.gitignore --exclude=linux*/LICENSE && \
+ echo "**** configure nginx ****" && \
+ rm -f /etc/nginx/conf.d/default.conf && \
+ curl -o \
+ /defaults/dhparams.pem -L \
+ "https://lsio.ams3.digitaloceanspaces.com/dhparams.pem" && \
+ echo "**** cleanup ****" && \
+ apk del --purge \
+ build-dependencies && \
+ for cleanfiles in *.pyc *.pyo; \
+ do \
+ find /usr/lib/python3.* -iname "${cleanfiles}" -exec rm -f '{}' + \
+ ; done && \
+ rm -rf \
+ /tmp/* \
+ /root/.cache
+
+# add local files
+COPY root/ /
diff --git a/Jenkinsfile b/Jenkinsfile
new file mode 100644
index 0000000..9e21bce
--- /dev/null
+++ b/Jenkinsfile
@@ -0,0 +1,746 @@
+pipeline {
+ agent {
+ label 'X86-64-MULTI'
+ }
+ options {
+ buildDiscarder(logRotator(numToKeepStr: '10', daysToKeepStr: '60'))
+ parallelsAlwaysFailFast()
+ }
+ // 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')
+ GITLAB_TOKEN=credentials('b6f0f1dd-6952-4cf6-95d1-9c06380283f0')
+ GITLAB_NAMESPACE=credentials('gitlab-namespace-id')
+ EXT_PIP = 'certbot'
+ BUILD_VERSION_ARG = 'CERTBOT_VERSION'
+ LS_USER = 'linuxserver'
+ LS_REPO = 'docker-swag'
+ CONTAINER_NAME = 'swag'
+ DOCKERHUB_IMAGE = 'linuxserver/swag'
+ DEV_DOCKERHUB_IMAGE = 'lsiodev/swag'
+ PR_DOCKERHUB_IMAGE = 'lspipepr/swag'
+ DIST_IMAGE = 'alpine'
+ MULTIARCH='true'
+ CI='true'
+ CI_WEB='false'
+ CI_PORT='80'
+ CI_SSL='false'
+ CI_DELAY='30'
+ CI_DOCKERENV='TEST_RUN=1'
+ CI_AUTH=''
+ 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.TEMPLATED_FILES = 'Jenkinsfile README.md LICENSE ./.github/FUNDING.yml ./.github/ISSUE_TEMPLATE.md ./.github/PULL_REQUEST_TEMPLATE.md ./.github/workflows/greetings.yml ./.github/workflows/stale.yml ./root/donate.txt'
+ }
+ 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 pip release set the external tag to the pip version
+ stage("Set ENV pip_version"){
+ steps{
+ script{
+ env.EXT_RELEASE = sh(
+ script: '''curl -sL https://pypi.python.org/pypi/${EXT_PIP}/json |jq -r '. | .info.version' ''',
+ returnStdout: true).trim()
+ env.RELEASE_LINK = 'https://pypi.python.org/pypi/' + env.EXT_PIP
+ }
+ }
+ } // 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
+ env.GITHUBIMAGE = 'docker.pkg.github.com/' + env.LS_USER + '/' + env.LS_REPO + '/' + env.CONTAINER_NAME
+ env.GITLABIMAGE = 'registry.gitlab.com/linuxserver.io/' + env.LS_REPO + '/' + env.CONTAINER_NAME
+ 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
+ env.GITHUBIMAGE = 'docker.pkg.github.com/' + env.LS_USER + '/' + env.LS_REPO + '/lsiodev-' + env.CONTAINER_NAME
+ env.GITLABIMAGE = 'registry.gitlab.com/linuxserver.io/' + env.LS_REPO + '/lsiodev-' + env.CONTAINER_NAME
+ 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
+ env.GITHUBIMAGE = 'docker.pkg.github.com/' + env.LS_USER + '/' + env.LS_REPO + '/lspipepr-' + env.CONTAINER_NAME
+ env.GITLABIMAGE = 'registry.gitlab.com/linuxserver.io/' + env.LS_REPO + '/lspipepr-' + env.CONTAINER_NAME
+ 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
+ CURRENTHASH=$(grep -hs ^ ${TEMPLATED_FILES} | md5sum | cut -c1-8)
+ cd ${TEMPDIR}/docker-${CONTAINER_NAME}
+ NEWHASH=$(grep -hs ^ ${TEMPLATED_FILES} | md5sum | cut -c1-8)
+ if [[ "${CURRENTHASH}" != "${NEWHASH}" ]]; then
+ mkdir -p ${TEMPDIR}/repo
+ git clone https://github.com/${LS_USER}/${LS_REPO}.git ${TEMPDIR}/repo/${LS_REPO}
+ cd ${TEMPDIR}/repo/${LS_REPO}
+ git checkout -f master
+ cd ${TEMPDIR}/docker-${CONTAINER_NAME}
+ mkdir -p ${TEMPDIR}/repo/${LS_REPO}/.github/workflows
+ cp --parents ${TEMPLATED_FILES} ${TEMPDIR}/repo/${LS_REPO}/
+ cd ${TEMPDIR}/repo/${LS_REPO}/
+ git add ${TEMPLATED_FILES}
+ git commit -m 'Bot Updating Templated Files'
+ 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}/docker-${CONTAINER_NAME}/docker-${CONTAINER_NAME}.md | awk '{ print $1 }')") ]]; then
+ cp ${TEMPDIR}/docker-${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 Documentation'
+ 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'
+ }
+ }
+ }
+ /* #######################
+ GitLab Mirroring
+ ####################### */
+ // Ping into Gitlab to mirror this repo and have a registry endpoint
+ stage("GitLab Mirror"){
+ when {
+ environment name: 'EXIT_STATUS', value: ''
+ }
+ steps{
+ sh '''curl -H "Content-Type: application/json" -H "Private-Token: ${GITLAB_TOKEN}" -X POST https://gitlab.com/api/v4/projects \
+ -d '{"namespace_id":'${GITLAB_NAMESPACE}',\
+ "name":"'${LS_REPO}'",
+ "mirror":true,\
+ "import_url":"https://github.com/linuxserver/'${LS_REPO}'.git",\
+ "issues_access_level":"disabled",\
+ "merge_requests_access_level":"disabled",\
+ "repository_access_level":"enabled",\
+ "visibility":"public"}' '''
+ }
+ }
+ /* ###############
+ 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}"
+ retry(5) {
+ 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}"
+ retry(5) {
+ 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 \
+ --shm-size=1gb \
+ -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'
+ ]
+ ]) {
+ retry(5) {
+ sh '''#! /bin/bash
+ set -e
+ echo $DOCKERPASS | docker login -u $DOCKERUSER --password-stdin
+ echo $GITHUB_TOKEN | docker login docker.pkg.github.com -u LinuxServer-CI --password-stdin
+ echo $GITLAB_TOKEN | docker login registry.gitlab.com -u LinuxServer.io --password-stdin
+ for PUSHIMAGE in "${GITHUBIMAGE}" "${GITLABIMAGE}" "${IMAGE}"; do
+ docker tag ${IMAGE}:${META_TAG} ${PUSHIMAGE}:${META_TAG}
+ docker tag ${PUSHIMAGE}:${META_TAG} ${PUSHIMAGE}:latest
+ docker push ${PUSHIMAGE}:latest
+ docker push ${PUSHIMAGE}:${META_TAG}
+ done
+ '''
+ }
+ sh '''#! /bin/bash
+ for DELETEIMAGE in "${GITHUBIMAGE}" "{GITLABIMAGE}" "${IMAGE}"; do
+ docker rmi \
+ ${DELETEIMAGE}:${META_TAG} \
+ ${DELETEIMAGE}:latest || :
+ done
+ '''
+ }
+ }
+ }
+ // 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'
+ ]
+ ]) {
+ retry(5) {
+ sh '''#! /bin/bash
+ set -e
+ echo $DOCKERPASS | docker login -u $DOCKERUSER --password-stdin
+ echo $GITHUB_TOKEN | docker login docker.pkg.github.com -u LinuxServer-CI --password-stdin
+ echo $GITLAB_TOKEN | docker login registry.gitlab.com -u LinuxServer.io --password-stdin
+ 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
+ for MANIFESTIMAGE in "${IMAGE}" "${GITLABIMAGE}"; do
+ docker tag ${IMAGE}:amd64-${META_TAG} ${MANIFESTIMAGE}:amd64-${META_TAG}
+ docker tag ${IMAGE}:arm32v7-${META_TAG} ${MANIFESTIMAGE}:arm32v7-${META_TAG}
+ docker tag ${IMAGE}:arm64v8-${META_TAG} ${MANIFESTIMAGE}:arm64v8-${META_TAG}
+ docker tag ${MANIFESTIMAGE}:amd64-${META_TAG} ${MANIFESTIMAGE}:amd64-latest
+ docker tag ${MANIFESTIMAGE}:arm32v7-${META_TAG} ${MANIFESTIMAGE}:arm32v7-latest
+ docker tag ${MANIFESTIMAGE}:arm64v8-${META_TAG} ${MANIFESTIMAGE}:arm64v8-latest
+ docker push ${MANIFESTIMAGE}:amd64-${META_TAG}
+ docker push ${MANIFESTIMAGE}:arm32v7-${META_TAG}
+ docker push ${MANIFESTIMAGE}:arm64v8-${META_TAG}
+ docker push ${MANIFESTIMAGE}:amd64-latest
+ docker push ${MANIFESTIMAGE}:arm32v7-latest
+ docker push ${MANIFESTIMAGE}:arm64v8-latest
+ docker manifest push --purge ${MANIFESTIMAGE}:latest || :
+ docker manifest create ${MANIFESTIMAGE}:latest ${MANIFESTIMAGE}:amd64-latest ${MANIFESTIMAGE}:arm32v7-latest ${MANIFESTIMAGE}:arm64v8-latest
+ docker manifest annotate ${MANIFESTIMAGE}:latest ${MANIFESTIMAGE}:arm32v7-latest --os linux --arch arm
+ docker manifest annotate ${MANIFESTIMAGE}:latest ${MANIFESTIMAGE}:arm64v8-latest --os linux --arch arm64 --variant v8
+ docker manifest push --purge ${MANIFESTIMAGE}:${META_TAG} || :
+ docker manifest create ${MANIFESTIMAGE}:${META_TAG} ${MANIFESTIMAGE}:amd64-${META_TAG} ${MANIFESTIMAGE}:arm32v7-${META_TAG} ${MANIFESTIMAGE}:arm64v8-${META_TAG}
+ docker manifest annotate ${MANIFESTIMAGE}:${META_TAG} ${MANIFESTIMAGE}:arm32v7-${META_TAG} --os linux --arch arm
+ docker manifest annotate ${MANIFESTIMAGE}:${META_TAG} ${MANIFESTIMAGE}:arm64v8-${META_TAG} --os linux --arch arm64 --variant v8
+ docker manifest push --purge ${MANIFESTIMAGE}:latest
+ docker manifest push --purge ${MANIFESTIMAGE}:${META_TAG}
+ done
+ docker tag ${IMAGE}:amd64-${META_TAG} ${GITHUBIMAGE}:amd64-${META_TAG}
+ docker tag ${IMAGE}:arm32v7-${META_TAG} ${GITHUBIMAGE}:arm32v7-${META_TAG}
+ docker tag ${IMAGE}:arm64v8-${META_TAG} ${GITHUBIMAGE}:arm64v8-${META_TAG}
+ docker tag ${GITHUBIMAGE}:amd64-${META_TAG} ${GITHUBIMAGE}:latest
+ docker tag ${GITHUBIMAGE}:amd64-${META_TAG} ${GITHUBIMAGE}:${META_TAG}
+ docker tag ${GITHUBIMAGE}:arm32v7-${META_TAG} ${GITHUBIMAGE}:arm32v7-latest
+ docker tag ${GITHUBIMAGE}:arm64v8-${META_TAG} ${GITHUBIMAGE}:arm64v8-latest
+ docker push ${GITHUBIMAGE}:amd64-${META_TAG}
+ docker push ${GITHUBIMAGE}:arm32v7-${META_TAG}
+ docker push ${GITHUBIMAGE}:arm64v8-${META_TAG}
+ docker push ${GITHUBIMAGE}:latest
+ docker push ${GITHUBIMAGE}:${META_TAG}
+ docker push ${GITHUBIMAGE}:arm32v7-latest
+ docker push ${GITHUBIMAGE}:arm64v8-latest
+ '''
+ }
+ sh '''#! /bin/bash
+ for DELETEIMAGE in "${GITHUBIMAGE}" "${GITLABIMAGE}" "${IMAGE}"; do
+ docker rmi \
+ ${DELETEIMAGE}:amd64-${META_TAG} \
+ ${DELETEIMAGE}:amd64-latest \
+ ${DELETEIMAGE}:arm32v7-${META_TAG} \
+ ${DELETEIMAGE}:arm32v7-latest \
+ ${DELETEIMAGE}:arm64v8-${META_TAG} \
+ ${DELETEIMAGE}:arm64v8-latest || :
+ done
+ docker rmi \
+ lsiodev/buildcache:arm32v7-${COMMIT_SHA}-${BUILD_NUMBER} \
+ lsiodev/buildcache:arm64v8-${COMMIT_SHA}-${BUILD_NUMBER} || :
+ '''
+ }
+ }
+ }
+ // 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
+ echo "Updating PIP version of ${EXT_PIP} to ${EXT_RELEASE_CLEAN}" > 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**PIP 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
+ 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 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 \
+ -v ${TEMPDIR}/docker-${CONTAINER_NAME}:/mnt \
+ lsiodev/readme-sync bash -c 'node sync'
+ rm -Rf ${TEMPDIR} '''
+ }
+ }
+ }
+ // 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 -H "Content-Type: application/json" --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 -H "Content-Type: application/json" --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} '''
+ }
+ }
+ }
+ cleanup {
+ cleanWs()
+ }
+ }
+}
diff --git a/LICENSE b/LICENSE
new file mode 100755
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
+.
diff --git a/README.md b/README.md
index a6ba9a0..f2ae362 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,303 @@
-# docker-swag
\ No newline at end of file
+[](https://linuxserver.io)
+
+[](https://blog.linuxserver.io "all the things you can do with our containers including How-To guides, opinions and much more!")
+[](https://discord.gg/YWrKVTn "realtime support / chat with the community and the team.")
+[](https://discourse.linuxserver.io "post on our community forum.")
+[](https://fleet.linuxserver.io "an online web interface which displays all of our maintained images.")
+[](https://github.com/linuxserver "view the source for all of our repositories.")
+[](https://opencollective.com/linuxserver "please consider helping us by either donating or contributing to our budget")
+
+The [LinuxServer.io](https://linuxserver.io) team brings you another container release featuring:
+
+ * regular and timely application updates
+ * easy user mappings (PGID, PUID)
+ * custom base image with s6 overlay
+ * weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
+ * regular security updates
+
+Find us at:
+* [Blog](https://blog.linuxserver.io) - all the things you can do with our containers including How-To guides, opinions and much more!
+* [Discord](https://discord.gg/YWrKVTn) - realtime support / chat with the community and the team.
+* [Discourse](https://discourse.linuxserver.io) - post on our community forum.
+* [Fleet](https://fleet.linuxserver.io) - an online web interface which displays all of our maintained images.
+* [GitHub](https://github.com/linuxserver) - view the source for all of our repositories.
+* [Open Collective](https://opencollective.com/linuxserver) - please consider helping us by either donating or contributing to our budget
+
+# [linuxserver/swag](https://github.com/linuxserver/docker-swag)
+
+[](https://github.com/linuxserver/docker-swag)
+[](https://github.com/linuxserver/docker-swag/releases)
+[](https://github.com/linuxserver/docker-swag/packages)
+[](https://gitlab.com/Linuxserver.io/docker-swag/container_registry)
+[](https://microbadger.com/images/linuxserver/swag "Get your own version badge on microbadger.com")
+[](https://hub.docker.com/r/linuxserver/swag)
+[](https://hub.docker.com/r/linuxserver/swag)
+[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-swag/job/master/)
+[](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/swag/latest/index.html)
+
+SWAG - Secure Web-server And Gateway (formerly known as letsencrypt, no relation to Let's Encrypt™) sets up an Nginx webserver and reverse proxy with php support and a built-in certbot client that automates free SSL server certificate generation and renewal processes. It also contains fail2ban for intrusion prevention.
+
+[](https://linuxserver.io)
+
+## Supported Architectures
+
+Our images support multiple architectures such as `x86-64`, `arm64` and `armhf`. We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/).
+
+Simply pulling `linuxserver/swag` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
+
+The architectures supported by this image are:
+
+| Architecture | Tag |
+| :----: | --- |
+| x86-64 | amd64-latest |
+| arm64 | arm64v8-latest |
+| armhf | arm32v7-latest |
+
+
+## Usage
+
+Here are some example snippets to help you get started creating a container.
+
+### docker
+
+```
+docker create \
+ --name=swag \
+ --cap-add=NET_ADMIN \
+ -e PUID=1000 \
+ -e PGID=1000 \
+ -e TZ=Europe/London \
+ -e URL=yourdomain.url \
+ -e SUBDOMAINS=www, \
+ -e VALIDATION=http \
+ -e DNSPLUGIN=cloudflare `#optional` \
+ -e PROPAGATION= `#optional` \
+ -e DUCKDNSTOKEN= `#optional` \
+ -e EMAIL= `#optional` \
+ -e ONLY_SUBDOMAINS=false `#optional` \
+ -e EXTRA_DOMAINS= `#optional` \
+ -e STAGING=false `#optional` \
+ -p 443:443 \
+ -p 80:80 `#optional` \
+ -v /path/to/appdata/config:/config \
+ --restart unless-stopped \
+ linuxserver/swag
+```
+
+
+### docker-compose
+
+Compatible with docker-compose v2 schemas.
+
+```
+---
+version: "2.1"
+services:
+ swag:
+ image: linuxserver/swag
+ container_name: swag
+ cap_add:
+ - NET_ADMIN
+ environment:
+ - PUID=1000
+ - PGID=1000
+ - TZ=Europe/London
+ - URL=yourdomain.url
+ - SUBDOMAINS=www,
+ - VALIDATION=http
+ - DNSPLUGIN=cloudflare #optional
+ - PROPAGATION= #optional
+ - DUCKDNSTOKEN= #optional
+ - EMAIL= #optional
+ - ONLY_SUBDOMAINS=false #optional
+ - EXTRA_DOMAINS= #optional
+ - STAGING=false #optional
+ volumes:
+ - /path/to/appdata/config:/config
+ ports:
+ - 443:443
+ - 80:80 #optional
+ restart: unless-stopped
+```
+
+## Parameters
+
+Container images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
+
+| Parameter | Function |
+| :----: | --- |
+| `-p 443` | Https port |
+| `-p 80` | Http port (required for http validation and http -> https redirect) |
+| `-e PUID=1000` | for UserID - see below for explanation |
+| `-e PGID=1000` | for GroupID - see below for explanation |
+| `-e TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
+| `-e URL=yourdomain.url` | Top url you have control over (`customdomain.com` if you own it, or `customsubdomain.ddnsprovider.com` if dynamic dns). |
+| `-e SUBDOMAINS=www,` | Subdomains you'd like the cert to cover (comma separated, no spaces) ie. `www,ftp,cloud`. For a wildcard cert, set this _exactly_ to `wildcard` (wildcard cert is available via `dns` and `duckdns` validation only) |
+| `-e VALIDATION=http` | Certbot validation method to use, options are `http`, `dns` or `duckdns` (`dns` method also requires `DNSPLUGIN` variable set) (`duckdns` method requires `DUCKDNSTOKEN` variable set, and the `SUBDOMAINS` variable must be either empty or set to `wildcard`). |
+| `-e DNSPLUGIN=cloudflare` | Required if `VALIDATION` is set to `dns`. Options are `aliyun`, `cloudflare`, `cloudxns`, `cpanel`, `digitalocean`, `dnsimple`, `dnsmadeeasy`, `domeneshop`, `gandi`, `google`, `inwx`, `linode`, `luadns`, `nsone`, `ovh`, `rfc2136`, `route53` and `transip`. Also need to enter the credentials into the corresponding ini (or json for some plugins) file under `/config/dns-conf`. |
+| `-e PROPAGATION=` | Optionally override (in seconds) the default propagation time for the dns plugins. |
+| `-e DUCKDNSTOKEN=` | Required if `VALIDATION` is set to `duckdns`. Retrieve your token from https://www.duckdns.org |
+| `-e EMAIL=` | Optional e-mail address used for cert expiration notifications. |
+| `-e ONLY_SUBDOMAINS=false` | If you wish to get certs only for certain subdomains, but not the main domain (main domain may be hosted on another machine and cannot be validated), set this to `true` |
+| `-e EXTRA_DOMAINS=` | Additional fully qualified domain names (comma separated, no spaces) ie. `extradomain.com,subdomain.anotherdomain.org,*.anotherdomain.org` |
+| `-e STAGING=false` | Set to `true` to retrieve certs in staging mode. Rate limits will be much higher, but the resulting cert will not pass the browser's security test. Only to be used for testing purposes. |
+| `-v /config` | All the config files including the webroot reside here. |
+
+## Environment variables from files (Docker secrets)
+
+You can set any environment variable from a file by using a special prepend `FILE__`.
+
+As an example:
+
+```
+-e FILE__PASSWORD=/run/secrets/mysecretpassword
+```
+
+Will set the environment variable `PASSWORD` based on the contents of the `/run/secrets/mysecretpassword` file.
+
+## Umask for running applications
+
+For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional `-e UMASK=022` setting.
+Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up [here](https://en.wikipedia.org/wiki/Umask) before asking for support.
+
+## User / Group Identifiers
+
+When using volumes (`-v` flags) permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user `PUID` and group `PGID`.
+
+Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
+
+In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
+
+```
+ $ id username
+ uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
+```
+
+
+
+## Application Setup
+
+### Migrating from the old `linuxserver/letsencrypt` image
+* If using docker cli:
+ * Stop and remove existing container via `docker stop letsencrypt` and `docker rm letsencrypt`
+ * Create new container using the sample on this page (container name: `swag`, image name: `linuxserver/swag`)
+* If using docker compose:
+ * Edit the compose yaml to change the image to `linuxserver/swag` and change the service and container names to `swag`
+ * Issue `docker-compose up -d`
+### Validation and initial setup
+* Before running this container, make sure that the url and subdomains are properly forwarded to this container's host, and that port 443 (and/or 80) is not being used by another service on the host (NAS gui, another webserver, etc.).
+* For `http` validation, port 80 on the internet side of the router should be forwarded to this container's port 80
+* For `dns` validation, make sure to enter your credentials into the corresponding ini (or json for some plugins) file under `/config/dns-conf`
+ * Cloudflare provides free accounts for managing dns and is very easy to use with this image. Make sure that it is set up for "dns only" instead of "dns + proxy"
+ * Google dns plugin is meant to be used with "Google Cloud DNS", a paid enterprise product, and not for "Google Domains DNS"
+* For `duckdns` validation, either leave the `SUBDOMAINS` variable empty or set it to `wildcard`, and set the `DUCKDNSTOKEN` variable with your duckdns token. Due to a limitation of duckdns, the resulting cert will only cover either main subdomain (ie. `yoursubdomain.duckdns.org`), or sub-subdomains (ie. `*.yoursubdomain.duckdns.org`), but will not both at the same time. You can use our [duckdns image](https://hub.docker.com/r/linuxserver/duckdns/) to update your IP on duckdns.org.
+* `--cap-add=NET_ADMIN` is required for fail2ban to modify iptables
+* If you need a dynamic dns provider, you can use the free provider duckdns.org where the `URL` will be `yoursubdomain.duckdns.org` and the `SUBDOMAINS` can be `www,ftp,cloud` with http validation, or `wildcard` with dns validation.
+* After setup, navigate to `https://yourdomain.url` to access the default homepage (http access through port 80 is disabled by default, you can enable it by editing the default site config at `/config/nginx/site-confs/default`).
+* Certs are checked nightly and if expiration is within 30 days, renewal is attempted. If your cert is about to expire in less than 30 days, check the logs under `/config/log/letsencrypt` to see why the renewals have been failing. It is recommended to input your e-mail in docker parameters so you receive expiration notices from Let's Encrypt in those circumstances.
+### Security and password protection
+* The container detects changes to url and subdomains, revokes existing certs and generates new ones during start.
+* The container provides a pre-generated 4096-bit dhparams.pem (rotated weekly via [Jenkins job](https://ci.linuxserver.io/blue/organizations/jenkins/Xtras-Builders-Etc%2Fdhparams-uploader/activity)) for new instances, however you may generate your own by running `docker exec swag openssl dhparam -out /config/nginx/dhparams.pem 4096` WARNING: This takes a very long time
+* If you'd like to password protect your sites, you can use htpasswd. Run the following command on your host to generate the htpasswd file `docker exec -it swag htpasswd -c /config/nginx/.htpasswd `
+* You can add multiple user:pass to `.htpasswd`. For the first user, use the above command, for others, use the above command without the `-c` flag, as it will force deletion of the existing `.htpasswd` and creation of a new one
+* You can also use ldap auth for security and access control. A sample, user configurable ldap.conf is provided, and it requires the separate image [linuxserver/ldap-auth](https://hub.docker.com/r/linuxserver/ldap-auth/) to communicate with an ldap server.
+### Site config and reverse proxy
+* The default site config resides at `/config/nginx/site-confs/default`. Feel free to modify this file, and you can add other conf files to this directory. However, if you delete the `default` file, a new default will be created on container start.
+* Preset reverse proxy config files are added for popular apps. See the `README.md` file under `/config/nginx/proxy_confs` for instructions on how to enable them. The preset confs reside in and get imported from [this repo](https://github.com/linuxserver/reverse-proxy-confs).
+* If you wish to hide your site from search engine crawlers, you may find it useful to add this configuration line to your site config, within the server block, above the line where ssl.conf is included
+`add_header X-Robots-Tag "noindex, nofollow, nosnippet, noarchive";`
+This will *ask* Google et al not to index and list your site. Be careful with this, as you will eventually be de-listed if you leave this line in on a site you wish to be present on search engines
+* If you wish to redirect http to https, you must expose port 80
+### Using certs in other containers
+* This container includes auto-generated pfx and private-fullchain-bundle pem certs that are needed by other apps like Emby and Znc.
+ * To use these certs in other containers, do either of the following:
+ 1. *(Easier)* Mount the container's config folder in other containers (ie. `-v /path-to-le-config:/le-ssl`) and in the other containers, use the cert location `/le-ssl/keys/letsencrypt/`
+ 2. *(More secure)* Mount the SWAG folder `etc` that resides under `/config` in other containers (ie. `-v /path-to-le-config/etc:/le-ssl`) and in the other containers, use the cert location `/le-ssl/letsencrypt/live//` (This is more secure because the first method shares the entire SWAG config folder with other containers, including the www files, whereas the second method only shares the ssl certs)
+ * These certs include:
+ 1. `cert.pem`, `chain.pem`, `fullchain.pem` and `privkey.pem`, which are generated by Let's Encrypt and used by nginx and various other apps
+ 2. `privkey.pfx`, a format supported by Microsoft and commonly used by dotnet apps such as Emby Server (no password)
+ 3. `priv-fullchain-bundle.pem`, a pem cert that bundles the private key and the fullchain, used by apps like ZNC
+### Using fail2ban
+* This container includes fail2ban set up with 3 jails by default:
+ 1. nginx-http-auth
+ 2. nginx-badbots
+ 3. nginx-botsearch
+* To enable or disable other jails, modify the file `/config/fail2ban/jail.local`
+* To modify filters and actions, instead of editing the `.conf` files, create `.local` files with the same name and edit those because .conf files get overwritten when the actions and filters are updated. `.local` files will append whatever's in the `.conf` files (ie. `nginx-http-auth.conf` --> `nginx-http-auth.local`)
+* You can check which jails are active via `docker exec -it swag fail2ban-client status`
+* You can check the status of a specific jail via `docker exec -it swag fail2ban-client status `
+* You can unban an IP via `docker exec -it swag fail2ban-client set unbanip `
+* A list of commands can be found here: https://www.fail2ban.org/wiki/index.php/Commands
+
+
+## Docker Mods
+[](https://mods.linuxserver.io/?mod=swag "view available mods for this container.")
+
+We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to enable additional functionality within the containers. The list of Mods available for this image (if any) can be accessed via the dynamic badge above.
+
+
+## Support Info
+
+* Shell access whilst the container is running: `docker exec -it swag /bin/bash`
+* To monitor the logs of the container in realtime: `docker logs -f swag`
+* container version number
+ * `docker inspect -f '{{ index .Config.Labels "build_version" }}' swag`
+* image version number
+ * `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/swag`
+
+## Updating Info
+
+Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (ie. nextcloud, plex), we do not recommend or support updating apps inside the container. Please consult the [Application Setup](#application-setup) section above to see if it is recommended for the image.
+
+Below are the instructions for updating containers:
+
+### Via Docker Run/Create
+* Update the image: `docker pull linuxserver/swag`
+* Stop the running container: `docker stop swag`
+* Delete the container: `docker rm swag`
+* Recreate a new container with the same docker create parameters as instructed above (if mapped correctly to a host folder, your `/config` folder and settings will be preserved)
+* Start the new container: `docker start swag`
+* You can also remove the old dangling images: `docker image prune`
+
+### Via Docker Compose
+* Update all images: `docker-compose pull`
+ * or update a single image: `docker-compose pull swag`
+* Let compose update all containers as necessary: `docker-compose up -d`
+ * or update a single container: `docker-compose up -d swag`
+* You can also remove the old dangling images: `docker image prune`
+
+### Via Watchtower auto-updater (especially useful if you don't remember the original parameters)
+* Pull the latest image at its tag and replace it with the same env variables in one run:
+ ```
+ docker run --rm \
+ -v /var/run/docker.sock:/var/run/docker.sock \
+ containrrr/watchtower \
+ --run-once swag
+ ```
+
+**Note:** We do not endorse the use of Watchtower as a solution to automated updates of existing Docker containers. In fact we generally discourage automated updates. However, this is a useful tool for one-time manual updates of containers where you have forgotten the original parameters. In the long term, we highly recommend using Docker Compose.
+
+* You can also remove the old dangling images: `docker image prune`
+
+## Building locally
+
+If you want to make local modifications to these images for development purposes or just to customize the logic:
+```
+git clone https://github.com/linuxserver/docker-swag.git
+cd docker-swag
+docker build \
+ --no-cache \
+ --pull \
+ -t linuxserver/swag:latest .
+```
+
+The ARM variants can be built on x86_64 hardware using `multiarch/qemu-user-static`
+```
+docker run --rm --privileged multiarch/qemu-user-static:register --reset
+```
+
+Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64`.
+
+## Versions
+
+* **03.08.20:** - Initial release.
diff --git a/jenkins-vars.yml b/jenkins-vars.yml
new file mode 100644
index 0000000..989b638
--- /dev/null
+++ b/jenkins-vars.yml
@@ -0,0 +1,29 @@
+---
+
+# jenkins variables
+project_name: docker-swag
+external_type: pip_version
+release_type: stable
+release_tag: latest
+ls_branch: master
+repo_vars:
+ - EXT_PIP = 'certbot'
+ - BUILD_VERSION_ARG = 'CERTBOT_VERSION'
+ - LS_USER = 'linuxserver'
+ - LS_REPO = 'docker-swag'
+ - CONTAINER_NAME = 'swag'
+ - DOCKERHUB_IMAGE = 'linuxserver/swag'
+ - DEV_DOCKERHUB_IMAGE = 'lsiodev/swag'
+ - PR_DOCKERHUB_IMAGE = 'lspipepr/swag'
+ - DIST_IMAGE = 'alpine'
+ - MULTIARCH='true'
+ - CI='true'
+ - CI_WEB='false'
+ - CI_PORT='80'
+ - CI_SSL='false'
+ - CI_DELAY='30'
+ - CI_DOCKERENV='TEST_RUN=1'
+ - CI_AUTH=''
+ - CI_WEBPATH=''
+sponsor_links:
+ - { name: "Certbot", url: "https://supporters.eff.org/donate/support-work-on-certbot" }
diff --git a/readme-vars.yml b/readme-vars.yml
new file mode 100755
index 0000000..d8345d1
--- /dev/null
+++ b/readme-vars.yml
@@ -0,0 +1,136 @@
+---
+
+# project information
+project_name: swag
+project_url: "https://linuxserver.io"
+project_logo: "https://github.com/linuxserver/docker-templates/raw/master/linuxserver.io/img/swag.gif"
+project_blurb: "SWAG - Secure Web-server And Gateway (formerly known as letsencrypt, no relation to Let's Encrypt™) sets up an Nginx webserver and reverse proxy with php support and a built-in certbot client that automates free SSL server certificate generation and renewal processes. It also contains fail2ban for intrusion prevention."
+project_lsio_github_repo_url: "https://github.com/linuxserver/docker-{{ project_name }}"
+
+project_blurb_optional_extras_enabled: false
+project_blurb_optional_extras: []
+
+# supported architectures
+available_architectures:
+ - { arch: "{{ arch_x86_64 }}", tag: "amd64-latest"}
+ - { arch: "{{ arch_arm64 }}", tag: "arm64v8-latest"}
+ - { arch: "{{ arch_armhf }}", tag: "arm32v7-latest"}
+
+# development version
+development_versions: false
+development_versions_items:
+ - { tag: "latest", desc: "Stable releases" }
+
+
+# container parameters
+common_param_env_vars_enabled: true #PGID, PUID, etc, you can set it to 'optional'
+param_container_name: "{{ project_name }}"
+param_usage_include_net: false #you can set it to 'optional'
+param_net: "host"
+param_net_desc: "Shares host networking with container."
+param_usage_include_env: true
+param_env_vars:
+ - { env_var: "TZ", env_value: "Europe/London", desc: "Specify a timezone to use EG Europe/London." }
+ - { env_var: "URL", env_value: "yourdomain.url", desc: "Top url you have control over (`customdomain.com` if you own it, or `customsubdomain.ddnsprovider.com` if dynamic dns)." }
+ - { env_var: "SUBDOMAINS", env_value: "www,", desc: "Subdomains you'd like the cert to cover (comma separated, no spaces) ie. `www,ftp,cloud`. For a wildcard cert, set this _exactly_ to `wildcard` (wildcard cert is available via `dns` and `duckdns` validation only)" }
+ - { env_var: "VALIDATION", env_value: "http", desc: "Certbot validation method to use, options are `http`, `dns` or `duckdns` (`dns` method also requires `DNSPLUGIN` variable set) (`duckdns` method requires `DUCKDNSTOKEN` variable set, and the `SUBDOMAINS` variable must be either empty or set to `wildcard`)." }
+param_usage_include_vols: true
+param_volumes:
+ - { vol_path: "/config", vol_host_path: "/path/to/appdata/config", desc: "All the config files including the webroot reside here." }
+param_usage_include_ports: true
+param_ports:
+ - { external_port: "443", internal_port: "443", port_desc: "Https port" }
+param_device_map: false
+param_devices:
+ - { device_path: "/dev/dri", device_host_path: "/dev/dri", desc: "For hardware transcoding" }
+cap_add_param: true
+cap_add_param_vars:
+ - { cap_add_var: "NET_ADMIN" }
+
+# optional container parameters
+opt_param_usage_include_env: true
+opt_param_env_vars:
+ - { env_var: "DNSPLUGIN", env_value: "cloudflare", desc: "Required if `VALIDATION` is set to `dns`. Options are `aliyun`, `cloudflare`, `cloudxns`, `cpanel`, `digitalocean`, `dnsimple`, `dnsmadeeasy`, `domeneshop`, `gandi`, `google`, `inwx`, `linode`, `luadns`, `nsone`, `ovh`, `rfc2136`, `route53` and `transip`. Also need to enter the credentials into the corresponding ini (or json for some plugins) file under `/config/dns-conf`." }
+ - { env_var: "PROPAGATION", env_value: "", desc: "Optionally override (in seconds) the default propagation time for the dns plugins." }
+ - { env_var: "DUCKDNSTOKEN", env_value: "", desc: "Required if `VALIDATION` is set to `duckdns`. Retrieve your token from https://www.duckdns.org" }
+ - { env_var: "EMAIL", env_value: "", desc: "Optional e-mail address used for cert expiration notifications." }
+ - { env_var: "ONLY_SUBDOMAINS", env_value: "false", desc: "If you wish to get certs only for certain subdomains, but not the main domain (main domain may be hosted on another machine and cannot be validated), set this to `true`" }
+ - { env_var: "EXTRA_DOMAINS", env_value: "", desc: "Additional fully qualified domain names (comma separated, no spaces) ie. `extradomain.com,subdomain.anotherdomain.org,*.anotherdomain.org`" }
+ - { env_var: "STAGING", env_value: "false", desc: "Set to `true` to retrieve certs in staging mode. Rate limits will be much higher, but the resulting cert will not pass the browser's security test. Only to be used for testing purposes." }
+opt_param_usage_include_vols: false
+opt_param_volumes:
+ - { vol_path: "/config", vol_host_path: "/path/to/appdata/config", desc: "Configuration files." }
+opt_param_usage_include_ports: true
+opt_param_ports:
+ - { external_port: "80", internal_port: "80", port_desc: "Http port (required for http validation and http -> https redirect)" }
+opt_param_device_map: false
+opt_param_devices:
+ - { device_path: "/dev/dri", device_host_path: "/dev/dri", desc: "For hardware transcoding" }
+opt_cap_add_param: false
+opt_cap_add_param_vars:
+ - { cap_add_var: "NET_ADMIN" }
+
+optional_block_1: false
+optional_block_1_items: ""
+
+# application setup block
+app_setup_block_enabled: true
+app_setup_block: |
+ ### Migrating from the old `linuxserver/letsencrypt` image
+ * If using docker cli:
+ * Stop and remove existing container via `docker stop letsencrypt` and `docker rm letsencrypt`
+ * Create new container using the sample on this page (container name: `swag`, image name: `linuxserver/swag`)
+ * If using docker compose:
+ * Edit the compose yaml to change the image to `linuxserver/swag` and change the service and container names to `swag`
+ * Issue `docker-compose up -d`
+ ### Validation and initial setup
+ * Before running this container, make sure that the url and subdomains are properly forwarded to this container's host, and that port 443 (and/or 80) is not being used by another service on the host (NAS gui, another webserver, etc.).
+ * For `http` validation, port 80 on the internet side of the router should be forwarded to this container's port 80
+ * For `dns` validation, make sure to enter your credentials into the corresponding ini (or json for some plugins) file under `/config/dns-conf`
+ * Cloudflare provides free accounts for managing dns and is very easy to use with this image. Make sure that it is set up for "dns only" instead of "dns + proxy"
+ * Google dns plugin is meant to be used with "Google Cloud DNS", a paid enterprise product, and not for "Google Domains DNS"
+ * For `duckdns` validation, either leave the `SUBDOMAINS` variable empty or set it to `wildcard`, and set the `DUCKDNSTOKEN` variable with your duckdns token. Due to a limitation of duckdns, the resulting cert will only cover either main subdomain (ie. `yoursubdomain.duckdns.org`), or sub-subdomains (ie. `*.yoursubdomain.duckdns.org`), but will not both at the same time. You can use our [duckdns image](https://hub.docker.com/r/linuxserver/duckdns/) to update your IP on duckdns.org.
+ * `--cap-add=NET_ADMIN` is required for fail2ban to modify iptables
+ * If you need a dynamic dns provider, you can use the free provider duckdns.org where the `URL` will be `yoursubdomain.duckdns.org` and the `SUBDOMAINS` can be `www,ftp,cloud` with http validation, or `wildcard` with dns validation.
+ * After setup, navigate to `https://yourdomain.url` to access the default homepage (http access through port 80 is disabled by default, you can enable it by editing the default site config at `/config/nginx/site-confs/default`).
+ * Certs are checked nightly and if expiration is within 30 days, renewal is attempted. If your cert is about to expire in less than 30 days, check the logs under `/config/log/letsencrypt` to see why the renewals have been failing. It is recommended to input your e-mail in docker parameters so you receive expiration notices from Let's Encrypt in those circumstances.
+ ### Security and password protection
+ * The container detects changes to url and subdomains, revokes existing certs and generates new ones during start.
+ * The container provides a pre-generated 4096-bit dhparams.pem (rotated weekly via [Jenkins job](https://ci.linuxserver.io/blue/organizations/jenkins/Xtras-Builders-Etc%2Fdhparams-uploader/activity)) for new instances, however you may generate your own by running `docker exec swag openssl dhparam -out /config/nginx/dhparams.pem 4096` WARNING: This takes a very long time
+ * If you'd like to password protect your sites, you can use htpasswd. Run the following command on your host to generate the htpasswd file `docker exec -it swag htpasswd -c /config/nginx/.htpasswd `
+ * You can add multiple user:pass to `.htpasswd`. For the first user, use the above command, for others, use the above command without the `-c` flag, as it will force deletion of the existing `.htpasswd` and creation of a new one
+ * You can also use ldap auth for security and access control. A sample, user configurable ldap.conf is provided, and it requires the separate image [linuxserver/ldap-auth](https://hub.docker.com/r/linuxserver/ldap-auth/) to communicate with an ldap server.
+ ### Site config and reverse proxy
+ * The default site config resides at `/config/nginx/site-confs/default`. Feel free to modify this file, and you can add other conf files to this directory. However, if you delete the `default` file, a new default will be created on container start.
+ * Preset reverse proxy config files are added for popular apps. See the `README.md` file under `/config/nginx/proxy_confs` for instructions on how to enable them. The preset confs reside in and get imported from [this repo](https://github.com/linuxserver/reverse-proxy-confs).
+ * If you wish to hide your site from search engine crawlers, you may find it useful to add this configuration line to your site config, within the server block, above the line where ssl.conf is included
+ `add_header X-Robots-Tag "noindex, nofollow, nosnippet, noarchive";`
+ This will *ask* Google et al not to index and list your site. Be careful with this, as you will eventually be de-listed if you leave this line in on a site you wish to be present on search engines
+ * If you wish to redirect http to https, you must expose port 80
+ ### Using certs in other containers
+ * This container includes auto-generated pfx and private-fullchain-bundle pem certs that are needed by other apps like Emby and Znc.
+ * To use these certs in other containers, do either of the following:
+ 1. *(Easier)* Mount the container's config folder in other containers (ie. `-v /path-to-le-config:/le-ssl`) and in the other containers, use the cert location `/le-ssl/keys/letsencrypt/`
+ 2. *(More secure)* Mount the SWAG folder `etc` that resides under `/config` in other containers (ie. `-v /path-to-le-config/etc:/le-ssl`) and in the other containers, use the cert location `/le-ssl/letsencrypt/live//` (This is more secure because the first method shares the entire SWAG config folder with other containers, including the www files, whereas the second method only shares the ssl certs)
+ * These certs include:
+ 1. `cert.pem`, `chain.pem`, `fullchain.pem` and `privkey.pem`, which are generated by Let's Encrypt and used by nginx and various other apps
+ 2. `privkey.pfx`, a format supported by Microsoft and commonly used by dotnet apps such as Emby Server (no password)
+ 3. `priv-fullchain-bundle.pem`, a pem cert that bundles the private key and the fullchain, used by apps like ZNC
+ ### Using fail2ban
+ * This container includes fail2ban set up with 3 jails by default:
+ 1. nginx-http-auth
+ 2. nginx-badbots
+ 3. nginx-botsearch
+ * To enable or disable other jails, modify the file `/config/fail2ban/jail.local`
+ * To modify filters and actions, instead of editing the `.conf` files, create `.local` files with the same name and edit those because .conf files get overwritten when the actions and filters are updated. `.local` files will append whatever's in the `.conf` files (ie. `nginx-http-auth.conf` --> `nginx-http-auth.local`)
+ * You can check which jails are active via `docker exec -it swag fail2ban-client status`
+ * You can check the status of a specific jail via `docker exec -it swag fail2ban-client status `
+ * You can unban an IP via `docker exec -it swag fail2ban-client set unbanip `
+ * A list of commands can be found here: https://www.fail2ban.org/wiki/index.php/Commands
+
+app_setup_nginx_reverse_proxy_snippet: false
+app_setup_nginx_reverse_proxy_block: ""
+
+# changelog
+changelogs:
+ - { date: "03.08.20:", desc: "Initial release." }
\ No newline at end of file
diff --git a/root/app/duckdns-txt b/root/app/duckdns-txt
new file mode 100644
index 0000000..d262b24
--- /dev/null
+++ b/root/app/duckdns-txt
@@ -0,0 +1,8 @@
+#!/bin/bash
+
+. /config/donoteditthisfile.conf
+
+curl https://www.duckdns.org/update?domains=${CERTBOT_DOMAIN}\&token=${ORIGDUCKDNSTOKEN}\&txt=${CERTBOT_VALIDATION}
+
+echo "sleeping 60"
+sleep 60
diff --git a/root/app/le-renew.sh b/root/app/le-renew.sh
new file mode 100644
index 0000000..d0804d4
--- /dev/null
+++ b/root/app/le-renew.sh
@@ -0,0 +1,27 @@
+#!/usr/bin/with-contenv bash
+
+. /config/donoteditthisfile.conf
+
+echo "<------------------------------------------------->"
+echo
+echo "<------------------------------------------------->"
+echo "cronjob running on "$(date)
+echo "Running certbot renew"
+if [ "$ORIGVALIDATION" = "dns" ] || [ "$ORIGVALIDATION" = "duckdns" ]; then
+ certbot -n renew \
+ --post-hook "if ps aux | grep [n]ginx: > /dev/null; then s6-svc -h /var/run/s6/services/nginx; fi; \
+ cd /config/keys/letsencrypt && \
+ openssl pkcs12 -export -out privkey.pfx -inkey privkey.pem -in cert.pem -certfile chain.pem -passout pass: && \
+ sleep 1 && \
+ cat privkey.pem fullchain.pem > priv-fullchain-bundle.pem && \
+ chown -R abc:abc /config/etc/letsencrypt"
+else
+ certbot -n renew \
+ --pre-hook "if ps aux | grep [n]ginx: > /dev/null; then s6-svc -d /var/run/s6/services/nginx; fi" \
+ --post-hook "if ps aux | grep 's6-supervise nginx' | grep -v grep > /dev/null; then s6-svc -u /var/run/s6/services/nginx; fi; \
+ cd /config/keys/letsencrypt && \
+ openssl pkcs12 -export -out privkey.pfx -inkey privkey.pem -in cert.pem -certfile chain.pem -passout pass: && \
+ sleep 1 && \
+ cat privkey.pem fullchain.pem > priv-fullchain-bundle.pem && \
+ chown -R abc:abc /config/etc/letsencrypt"
+fi
diff --git a/root/defaults/authelia-location.conf b/root/defaults/authelia-location.conf
new file mode 100644
index 0000000..51cbdd6
--- /dev/null
+++ b/root/defaults/authelia-location.conf
@@ -0,0 +1,11 @@
+## Version 2020/05/31 - Changelog: https://github.com/linuxserver/docker-letsencrypt/commits/master/root/defaults/authelia-location.conf
+# Make sure that your authelia container is in the same user defined bridge network and is named authelia
+# Make sure that the authelia configuration.yml has 'path: "authelia"' defined
+
+auth_request /authelia/api/verify;
+auth_request_set $target_url $scheme://$http_host$request_uri;
+auth_request_set $user $upstream_http_remote_user;
+auth_request_set $groups $upstream_http_remote_groups;
+proxy_set_header Remote-User $user;
+proxy_set_header Remote-Groups $groups;
+error_page 401 =302 https://$http_host/authelia/?rd=$target_url;
diff --git a/root/defaults/authelia-server.conf b/root/defaults/authelia-server.conf
new file mode 100644
index 0000000..3fcef6e
--- /dev/null
+++ b/root/defaults/authelia-server.conf
@@ -0,0 +1,48 @@
+## Version 2020/05/31 - Changelog: https://github.com/linuxserver/docker-letsencrypt/commits/master/root/defaults/authelia-server.conf
+# Make sure that your authelia container is in the same user defined bridge network and is named authelia
+
+location ^~ /authelia {
+ include /config/nginx/proxy.conf;
+ resolver 127.0.0.11 valid=30s;
+ set $upstream_authelia authelia;
+ proxy_pass http://$upstream_authelia:9091;
+}
+
+location = /authelia/api/verify {
+ internal;
+ resolver 127.0.0.11 valid=30s;
+ set $upstream_authelia authelia;
+ proxy_pass_request_body off;
+ proxy_pass http://$upstream_authelia:9091;
+ proxy_set_header Content-Length "";
+
+ # Timeout if the real server is dead
+ proxy_next_upstream error timeout invalid_header http_500 http_502 http_503;
+
+ # [REQUIRED] Needed by Authelia to check authorizations of the resource.
+ # Provide either X-Original-URL and X-Forwarded-Proto or
+ # X-Forwarded-Proto, X-Forwarded-Host and X-Forwarded-Uri or both.
+ # Those headers will be used by Authelia to deduce the target url of the user.
+ # Basic Proxy Config
+ client_body_buffer_size 128k;
+ proxy_set_header Host $host;
+ proxy_set_header X-Original-URL $scheme://$http_host$request_uri;
+ proxy_set_header X-Real-IP $remote_addr;
+ proxy_set_header X-Forwarded-For $remote_addr;
+ proxy_set_header X-Forwarded-Proto $scheme;
+ proxy_set_header X-Forwarded-Host $http_host;
+ proxy_set_header X-Forwarded-Uri $request_uri;
+ proxy_set_header X-Forwarded-Ssl on;
+ proxy_redirect http:// $scheme://;
+ proxy_http_version 1.1;
+ proxy_set_header Connection "";
+ proxy_cache_bypass $cookie_session;
+ proxy_no_cache $cookie_session;
+ proxy_buffers 4 32k;
+
+ # Advanced Proxy Config
+ send_timeout 5m;
+ proxy_read_timeout 240;
+ proxy_send_timeout 240;
+ proxy_connect_timeout 240;
+}
diff --git a/root/defaults/default b/root/defaults/default
new file mode 100644
index 0000000..5c2c5ca
--- /dev/null
+++ b/root/defaults/default
@@ -0,0 +1,147 @@
+## Version 2020/05/23 - Changelog: https://github.com/linuxserver/docker-letsencrypt/commits/master/root/defaults/default
+
+# redirect all traffic to https
+server {
+ listen 80 default_server;
+ listen [::]:80 default_server;
+ server_name _;
+ return 301 https://$host$request_uri;
+}
+
+# main server block
+server {
+ listen 443 ssl http2 default_server;
+ listen [::]:443 ssl http2 default_server;
+
+ root /config/www;
+ index index.html index.htm index.php;
+
+ server_name _;
+
+ # enable subfolder method reverse proxy confs
+ include /config/nginx/proxy-confs/*.subfolder.conf;
+
+ # all ssl related config moved to ssl.conf
+ include /config/nginx/ssl.conf;
+
+ # enable for ldap auth
+ #include /config/nginx/ldap.conf;
+
+ # enable for Authelia
+ #include /config/nginx/authelia-server.conf;
+
+ client_max_body_size 0;
+
+ location / {
+ try_files $uri $uri/ /index.html /index.php?$args =404;
+ }
+
+ location ~ \.php$ {
+ fastcgi_split_path_info ^(.+\.php)(/.+)$;
+ fastcgi_pass 127.0.0.1:9000;
+ fastcgi_index index.php;
+ include /etc/nginx/fastcgi_params;
+ }
+
+# sample reverse proxy config for password protected couchpotato running at IP 192.168.1.50 port 5050 with base url "cp"
+# notice this is within the same server block as the base
+# don't forget to generate the .htpasswd file as described on docker hub
+# location ^~ /cp {
+# auth_basic "Restricted";
+# auth_basic_user_file /config/nginx/.htpasswd;
+# include /config/nginx/proxy.conf;
+# proxy_pass http://192.168.1.50:5050/cp;
+# }
+
+}
+
+# sample reverse proxy config without url base, but as a subdomain "cp", ip and port same as above
+# notice this is a new server block, you need a new server block for each subdomain
+#server {
+# listen 443 ssl http2;
+# listen [::]:443 ssl http2;
+#
+# root /config/www;
+# index index.html index.htm index.php;
+#
+# server_name cp.*;
+#
+# include /config/nginx/ssl.conf;
+#
+# client_max_body_size 0;
+#
+# location / {
+# auth_basic "Restricted";
+# auth_basic_user_file /config/nginx/.htpasswd;
+# include /config/nginx/proxy.conf;
+# proxy_pass http://192.168.1.50:5050;
+# }
+#}
+
+# sample reverse proxy config for "heimdall" via subdomain, with ldap authentication
+# ldap-auth container has to be running and the /config/nginx/ldap.conf file should be filled with ldap info
+# notice this is a new server block, you need a new server block for each subdomain
+#server {
+# listen 443 ssl http2;
+# listen [::]:443 ssl http2;
+#
+# root /config/www;
+# index index.html index.htm index.php;
+#
+# server_name heimdall.*;
+#
+# include /config/nginx/ssl.conf;
+#
+# include /config/nginx/ldap.conf;
+#
+# client_max_body_size 0;
+#
+# location / {
+# # the next two lines will enable ldap auth along with the included ldap.conf in the server block
+# auth_request /auth;
+# error_page 401 =200 /ldaplogin;
+#
+# include /config/nginx/proxy.conf;
+# resolver 127.0.0.11 valid=30s;
+# set $upstream_app heimdall;
+# set $upstream_port 443;
+# set $upstream_proto https;
+# proxy_pass $upstream_proto://$upstream_app:$upstream_port;
+# }
+#}
+
+# sample reverse proxy config for "heimdall" via subdomain, with Authelia
+# Authelia container has to be running in the same user defined bridge network, with container name "authelia", and with 'path: "authelia"' set in its configuration.yml
+# notice this is a new server block, you need a new server block for each subdomain
+#server {
+# listen 443 ssl http2;
+# listen [::]:443 ssl http2;
+#
+# root /config/www;
+# index index.html index.htm index.php;
+#
+# server_name heimdall.*;
+#
+# include /config/nginx/ssl.conf;
+#
+# include /config/nginx/authelia-server.conf;
+#
+# client_max_body_size 0;
+#
+# location / {
+# # the next line will enable Authelia along with the included authelia-server.conf in the server block
+# include /config/nginx/authelia-location.conf;
+#
+# include /config/nginx/proxy.conf;
+# resolver 127.0.0.11 valid=30s;
+# set $upstream_app heimdall;
+# set $upstream_port 443;
+# set $upstream_proto https;
+# proxy_pass $upstream_proto://$upstream_app:$upstream_port;
+# }
+#}
+
+# enable subdomain method reverse proxy confs
+include /config/nginx/proxy-confs/*.subdomain.conf;
+# enable proxy cache for auth
+proxy_cache_path cache/ keys_zone=auth_cache:10m;
diff --git a/root/defaults/dns-conf/aliyun.ini b/root/defaults/dns-conf/aliyun.ini
new file mode 100644
index 0000000..d8a648f
--- /dev/null
+++ b/root/defaults/dns-conf/aliyun.ini
@@ -0,0 +1,6 @@
+# Obtain Aliyun RAM AccessKey
+# https://ram.console.aliyun.com/
+# And ensure your RAM account has AliyunDNSFullAccess permission.
+
+certbot_dns_aliyun:dns_aliyun_access_key = 12345678
+certbot_dns_aliyun:dns_aliyun_access_key_secret = 1234567890abcdef1234567890abcdef
diff --git a/root/defaults/dns-conf/cloudflare.ini b/root/defaults/dns-conf/cloudflare.ini
new file mode 100644
index 0000000..5cd3c0a
--- /dev/null
+++ b/root/defaults/dns-conf/cloudflare.ini
@@ -0,0 +1,9 @@
+# Instructions: https://github.com/certbot/certbot/blob/master/certbot-dns-cloudflare/certbot_dns_cloudflare/__init__.py#L20
+# Replace with your values
+
+# With global api key:
+dns_cloudflare_email = cloudflare@example.com
+dns_cloudflare_api_key = 0123456789abcdef0123456789abcdef01234567
+
+# With token (comment out both lines above and uncomment below):
+#dns_cloudflare_api_token = 0123456789abcdef0123456789abcdef01234567
\ No newline at end of file
diff --git a/root/defaults/dns-conf/cloudxns.ini b/root/defaults/dns-conf/cloudxns.ini
new file mode 100644
index 0000000..a86f7d7
--- /dev/null
+++ b/root/defaults/dns-conf/cloudxns.ini
@@ -0,0 +1,4 @@
+# Instructions: https://github.com/certbot/certbot/blob/master/certbot-dns-cloudxns/certbot_dns_cloudxns/__init__.py#L20
+# Replace with your values
+dns_cloudxns_api_key = 1234567890abcdef1234567890abcdef
+dns_cloudxns_secret_key = 1122334455667788
diff --git a/root/defaults/dns-conf/cpanel.ini b/root/defaults/dns-conf/cpanel.ini
new file mode 100644
index 0000000..28b6953
--- /dev/null
+++ b/root/defaults/dns-conf/cpanel.ini
@@ -0,0 +1,6 @@
+# Instructions: https://github.com/badjware/certbot-dns-cpanel#credentials
+# Replace with your values
+# include the scheme and the port number (usually 2083 for https)
+certbot_dns_cpanel:cpanel_url = https://cpanel.example.com:2083
+certbot_dns_cpanel:cpanel_username = username
+certbot_dns_cpanel:cpanel_password = 1234567890abcdef
\ No newline at end of file
diff --git a/root/defaults/dns-conf/digitalocean.ini b/root/defaults/dns-conf/digitalocean.ini
new file mode 100644
index 0000000..eff7677
--- /dev/null
+++ b/root/defaults/dns-conf/digitalocean.ini
@@ -0,0 +1,3 @@
+# Instructions: https://github.com/certbot/certbot/blob/master/certbot-dns-digitalocean/certbot_dns_digitalocean/__init__.py#L21
+# Replace with your value
+dns_digitalocean_token = 0000111122223333444455556666777788889999aaaabbbbccccddddeeeeffff
diff --git a/root/defaults/dns-conf/dnsimple.ini b/root/defaults/dns-conf/dnsimple.ini
new file mode 100644
index 0000000..8eedb63
--- /dev/null
+++ b/root/defaults/dns-conf/dnsimple.ini
@@ -0,0 +1,3 @@
+# Instructions: https://github.com/certbot/certbot/blob/master/certbot-dns-dnsimple/certbot_dns_dnsimple/__init__.py#L20
+# Replace with your value
+dns_dnsimple_token = MDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAw
diff --git a/root/defaults/dns-conf/dnsmadeeasy.ini b/root/defaults/dns-conf/dnsmadeeasy.ini
new file mode 100644
index 0000000..942c403
--- /dev/null
+++ b/root/defaults/dns-conf/dnsmadeeasy.ini
@@ -0,0 +1,4 @@
+# Instructions: https://github.com/certbot/certbot/blob/master/certbot-dns-dnsmadeeasy/certbot_dns_dnsmadeeasy/__init__.py#L20
+# Replace with your values
+dns_dnsmadeeasy_api_key = 1c1a3c91-4770-4ce7-96f4-54c0eb0e457a
+dns_dnsmadeeasy_secret_key = c9b5625f-9834-4ff8-baba-4ed5f32cae55
diff --git a/root/defaults/dns-conf/domeneshop.ini b/root/defaults/dns-conf/domeneshop.ini
new file mode 100644
index 0000000..e213287
--- /dev/null
+++ b/root/defaults/dns-conf/domeneshop.ini
@@ -0,0 +1,4 @@
+# Instructions: https://github.com/domeneshop/certbot-dns-domeneshop#credentials
+# Replace with your values
+certbot_dns_domeneshop:dns_domeneshop_client_token=1234567890abcdef
+certbot_dns_domeneshop:dns_domeneshop_client_secret=1234567890abcdefghijklmnopqrstuvxyz1234567890abcdefghijklmnopqrs
\ No newline at end of file
diff --git a/root/defaults/dns-conf/gandi.ini b/root/defaults/dns-conf/gandi.ini
new file mode 100644
index 0000000..a5c04b3
--- /dev/null
+++ b/root/defaults/dns-conf/gandi.ini
@@ -0,0 +1,3 @@
+# Instructions: https://github.com/obynio/certbot-plugin-gandi#usage
+# Replace with your value
+certbot_plugin_gandi:dns_api_key=APIKEY
diff --git a/root/defaults/dns-conf/google.json b/root/defaults/dns-conf/google.json
new file mode 100644
index 0000000..c5a59cf
--- /dev/null
+++ b/root/defaults/dns-conf/google.json
@@ -0,0 +1,6 @@
+{
+ "instructions": "https://github.com/certbot/certbot/blob/master/certbot-dns-google/certbot_dns_google/__init__.py",
+ "_comment": "Replace with your values",
+ "type": "service_account",
+ "rest": "..."
+}
\ No newline at end of file
diff --git a/root/defaults/dns-conf/inwx.ini b/root/defaults/dns-conf/inwx.ini
new file mode 100644
index 0000000..3479d23
--- /dev/null
+++ b/root/defaults/dns-conf/inwx.ini
@@ -0,0 +1,6 @@
+# Instructions: https://github.com/oGGy990/certbot-dns-inwx
+# Replace with your values
+certbot_dns_inwx:dns_inwx_url = https://api.domrobot.com/xmlrpc/
+certbot_dns_inwx:dns_inwx_username = your_username
+certbot_dns_inwx:dns_inwx_password = your_password
+certbot_dns_inwx:dns_inwx_shared_secret = your_shared_secret optional
diff --git a/root/defaults/dns-conf/linode.ini b/root/defaults/dns-conf/linode.ini
new file mode 100644
index 0000000..2d434a1
--- /dev/null
+++ b/root/defaults/dns-conf/linode.ini
@@ -0,0 +1,3 @@
+# Instructions: https://github.com/certbot/certbot/blob/master/certbot-dns-linode/certbot_dns_linode/__init__.py#L25
+# Replace with your values
+dns_linode_key = 0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ64
diff --git a/root/defaults/dns-conf/luadns.ini b/root/defaults/dns-conf/luadns.ini
new file mode 100644
index 0000000..01de1dd
--- /dev/null
+++ b/root/defaults/dns-conf/luadns.ini
@@ -0,0 +1,4 @@
+# Instructions: https://github.com/certbot/certbot/blob/master/certbot-dns-luadns/certbot_dns_luadns/__init__.py#L20
+# Replace with your values
+dns_luadns_email = user@example.com
+dns_luadns_token = 0123456789abcdef0123456789abcdef
diff --git a/root/defaults/dns-conf/nsone.ini b/root/defaults/dns-conf/nsone.ini
new file mode 100644
index 0000000..f1858ca
--- /dev/null
+++ b/root/defaults/dns-conf/nsone.ini
@@ -0,0 +1,3 @@
+# Instructions: https://github.com/certbot/certbot/blob/master/certbot-dns-nsone/certbot_dns_nsone/__init__.py#L20
+# Replace with your value
+dns_nsone_api_key = MDAwMDAwMDAwMDAwMDAw
diff --git a/root/defaults/dns-conf/ovh.ini b/root/defaults/dns-conf/ovh.ini
new file mode 100644
index 0000000..f8fef57
--- /dev/null
+++ b/root/defaults/dns-conf/ovh.ini
@@ -0,0 +1,6 @@
+# Instructions: https://github.com/certbot/certbot/blob/master/certbot-dns-ovh/certbot_dns_ovh/__init__.py#L20
+# Replace with your values
+dns_ovh_endpoint = ovh-eu
+dns_ovh_application_key = MDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAw
+dns_ovh_application_secret = MDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAw
+dns_ovh_consumer_key = MDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAw
diff --git a/root/defaults/dns-conf/rfc2136.ini b/root/defaults/dns-conf/rfc2136.ini
new file mode 100644
index 0000000..75b6c7a
--- /dev/null
+++ b/root/defaults/dns-conf/rfc2136.ini
@@ -0,0 +1,11 @@
+# Instructions: https://github.com/certbot/certbot/blob/master/certbot-dns-rfc2136/certbot_dns_rfc2136/__init__.py#L20
+# Replace with your values
+# Target DNS server
+dns_rfc2136_server = 192.0.2.1
+# TSIG key name
+dns_rfc2136_name = keyname.
+# TSIG key secret
+dns_rfc2136_secret = 4q4wM/2I180UXoMyN4INVhJNi8V9BCV+jMw2mXgZw/CSuxUT8C7NKKFs \
+AmKd7ak51vWKgSl12ib86oQRPkpDjg==
+# TSIG key algorithm
+dns_rfc2136_algorithm = HMAC-SHA512
diff --git a/root/defaults/dns-conf/route53.ini b/root/defaults/dns-conf/route53.ini
new file mode 100644
index 0000000..18ce326
--- /dev/null
+++ b/root/defaults/dns-conf/route53.ini
@@ -0,0 +1,5 @@
+# Instructions: https://github.com/certbot/certbot/blob/master/certbot-dns-route53/certbot_dns_route53/__init__.py#L18
+# Replace with your values
+[default]
+aws_access_key_id=AKIAIOSFODNN7EXAMPLE
+aws_secret_access_key=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
diff --git a/root/defaults/dns-conf/transip.ini b/root/defaults/dns-conf/transip.ini
new file mode 100644
index 0000000..f5ec586
--- /dev/null
+++ b/root/defaults/dns-conf/transip.ini
@@ -0,0 +1,6 @@
+# Instructions: https://readthedocs.org/projects/certbot-dns-transip/
+# Convert the key to an RSA key (openssl rsa -in transip.key -out transip-rsa.key)
+# Place .key-file in the same directory as this file. Location "/config/dns-conf" is from within the container
+
+certbot_dns_transip:dns_transip_username =
+certbot_dns_transip:dns_transip_key_file = /config/dns-conf/transip-rsa.key
\ No newline at end of file
diff --git a/root/defaults/fail2ban/fail2ban.local b/root/defaults/fail2ban/fail2ban.local
new file mode 100644
index 0000000..3571c73
--- /dev/null
+++ b/root/defaults/fail2ban/fail2ban.local
@@ -0,0 +1,4 @@
+[Definition]
+
+logtarget = /config/log/fail2ban/fail2ban.log
+dbfile = /config/fail2ban/fail2ban.sqlite3
diff --git a/root/defaults/fail2ban/filter.d/nginx-badbots.conf b/root/defaults/fail2ban/filter.d/nginx-badbots.conf
new file mode 100644
index 0000000..48b3066
--- /dev/null
+++ b/root/defaults/fail2ban/filter.d/nginx-badbots.conf
@@ -0,0 +1,21 @@
+# Fail2Ban configuration file
+#
+# Regexp to catch known spambots and software alike. Please verify
+# that it is your intent to block IPs which were driven by
+# above mentioned bots.
+
+
+[Definition]
+
+badbotscustom = EmailCollector|WebEMailExtrac|TrackBack/1\.02|sogou music spider
+badbots = Atomic_Email_Hunter/4\.0|atSpider/1\.0|autoemailspider|bwh3_user_agent|China Local Browse 2\.6|ContactBot/0\.2|ContentSmartz|DataCha0s/2\.0|DBrowse 1\.4b|DBrowse 1\.4d|Demo Bot DOT 16b|Demo Bot Z 16b|DSurf15a 01|DSurf15a 71|DSurf15a 81|DSurf15a VA|EBrowse 1\.4b|Educate Search VxB|EmailSiphon|EmailSpider|EmailWolf 1\.00|ESurf15a 15|ExtractorPro|Franklin Locator 1\.8|FSurf15a 01|Full Web Bot 0416B|Full Web Bot 0516B|Full Web Bot 2816B|Guestbook Auto Submitter|Industry Program 1\.0\.x|ISC Systems iRc Search 2\.1|IUPUI Research Bot v 1\.9a|LARBIN-EXPERIMENTAL \(efp@gmx\.net\)|LetsCrawl\.com/1\.0 \+http\://letscrawl\.com/|Lincoln State Web Browser|LMQueueBot/0\.2|LWP\:\:Simple/5\.803|Mac Finder 1\.0\.xx|MFC Foundation Class Library 4\.0|Microsoft URL Control - 6\.00\.8xxx|Missauga Locate 1\.0\.0|Missigua Locator 1\.9|Missouri College Browse|Mizzu Labs 2\.2|Mo College 1\.9|MVAClient|Mozilla/2\.0 \(compatible; NEWT ActiveX; Win32\)|Mozilla/3\.0 \(compatible; Indy Library\)|Mozilla/3\.0 \(compatible; scan4mail \(advanced version\) http\://www\.peterspages\.net/?scan4mail\)|Mozilla/4\.0 \(compatible; Advanced Email Extractor v2\.xx\)|Mozilla/4\.0 \(compatible; Iplexx Spider/1\.0 http\://www\.iplexx\.at\)|Mozilla/4\.0 \(compatible; MSIE 5\.0; Windows NT; DigExt; DTS Agent|Mozilla/4\.0 efp@gmx\.net|Mozilla/5\.0 \(Version\: xxxx Type\:xx\)|NameOfAgent \(CMS Spider\)|NASA Search 1\.0|Nsauditor/1\.x|PBrowse 1\.4b|PEval 1\.4b|Poirot|Port Huron Labs|Production Bot 0116B|Production Bot 2016B|Production Bot DOT 3016B|Program Shareware 1\.0\.2|PSurf15a 11|PSurf15a 51|PSurf15a VA|psycheclone|RSurf15a 41|RSurf15a 51|RSurf15a 81|searchbot admin@google\.com|ShablastBot 1\.0|snap\.com beta crawler v0|Snapbot/1\.0|Snapbot/1\.0 \(Snap Shots, \+http\://www\.snap\.com\)|sogou develop spider|Sogou Orion spider/3\.0\(\+http\://www\.sogou\.com/docs/help/webmasters\.htm#07\)|sogou spider|Sogou web spider/3\.0\(\+http\://www\.sogou\.com/docs/help/webmasters\.htm#07\)|sohu agent|SSurf15a 11 |TSurf15a 11|Under the Rainbow 2\.2|User-Agent\: Mozilla/4\.0 \(compatible; MSIE 6\.0; Windows NT 5\.1\)|VadixBot|WebVulnCrawl\.unknown/1\.0 libwww-perl/5\.803|Wells Search II|WEP Search 00
+
+failregex = ^ -.*"(GET|POST|HEAD).*HTTP.*"(?:%(badbots)s|%(badbotscustom)s)"$
+
+ignoreregex =
+
+# DEV Notes:
+# List of bad bots fetched from http://www.user-agents.org
+# Generated on Thu Nov 7 14:23:35 PST 2013 by files/gen_badbots.
+#
+# Author: Yaroslav Halchenko
diff --git a/root/defaults/fail2ban/filter.d/nginx-deny.conf b/root/defaults/fail2ban/filter.d/nginx-deny.conf
new file mode 100644
index 0000000..d9f4694
--- /dev/null
+++ b/root/defaults/fail2ban/filter.d/nginx-deny.conf
@@ -0,0 +1,15 @@
+# fail2ban filter configuration for nginx
+
+
+[Definition]
+
+
+failregex = ^ \[error\] \d+#\d+: \*\d+ (access forbidden by rule), client: , server: \S*, request: "\S+ \S+ HTTP\/\d+\.\d+", host: "\S+"(?:, referrer: "\S+")?\s*$
+
+ignoreregex =
+
+datepattern = {^LN-BEG}
+
+# DEV NOTES:
+#
+# Author: Will L (driz@linuxserver.io)
diff --git a/root/defaults/jail.local b/root/defaults/jail.local
new file mode 100644
index 0000000..1258263
--- /dev/null
+++ b/root/defaults/jail.local
@@ -0,0 +1,57 @@
+## Version 2020/05/10 - Changelog: https://github.com/linuxserver/docker-letsencrypt/commits/master/root/defaults/jail.local
+# This is the custom version of the jail.conf for fail2ban
+# Feel free to modify this and add additional filters
+# Then you can drop the new filter conf files into the fail2ban-filters
+# folder and restart the container
+
+[DEFAULT]
+
+# Changes the default ban action from "iptables-multiport", which causes issues on some platforms, to "iptables-allports".
+banaction = iptables-allports
+
+# "bantime" is the number of seconds that a host is banned.
+bantime = 600
+
+# A host is banned if it has generated "maxretry" during the last "findtime"
+# seconds.
+findtime = 600
+
+# "maxretry" is the number of failures before a host get banned.
+maxretry = 5
+
+
+[ssh]
+
+enabled = false
+
+
+[nginx-http-auth]
+
+enabled = true
+filter = nginx-http-auth
+port = http,https
+logpath = /config/log/nginx/error.log
+
+
+[nginx-badbots]
+
+enabled = true
+port = http,https
+filter = nginx-badbots
+logpath = /config/log/nginx/access.log
+maxretry = 2
+
+
+[nginx-botsearch]
+
+enabled = true
+port = http,https
+filter = nginx-botsearch
+logpath = /config/log/nginx/access.log
+
+[nginx-deny]
+
+enabled = true
+port = http,https
+filter = nginx-deny
+logpath = /config/log/nginx/error.log
diff --git a/root/defaults/ldap.conf b/root/defaults/ldap.conf
new file mode 100644
index 0000000..36a10e3
--- /dev/null
+++ b/root/defaults/ldap.conf
@@ -0,0 +1,92 @@
+## Version 2020/06/02 - Changelog: https://github.com/linuxserver/docker-letsencrypt/commits/master/root/defaults/ldap.conf
+## this conf is meant to be used in conjunction with our ldap-auth image: https://github.com/linuxserver/docker-ldap-auth
+## see the heimdall example in the default site config for info on enabling ldap auth
+## for further instructions on this conf, see https://github.com/nginxinc/nginx-ldap-auth
+
+ location /ldaplogin {
+ resolver 127.0.0.11 valid=30s;
+ set $upstream_auth_app ldap-auth;
+ set $upstream_auth_port 9000;
+ set $upstream_auth_proto http;
+ proxy_pass $upstream_auth_proto://$upstream_auth_app:$upstream_auth_port;
+ proxy_set_header X-Target $request_uri;
+ }
+
+ location = /auth {
+ resolver 127.0.0.11 valid=30s;
+ set $upstream_auth_app ldap-auth;
+ set $upstream_auth_port 8888;
+ set $upstream_auth_proto http;
+ proxy_pass $upstream_auth_proto://$upstream_auth_app:$upstream_auth_port;
+
+ proxy_pass_request_body off;
+ proxy_set_header Content-Length "";
+
+ #Before enabling the below caching options, make sure you have the line "proxy_cache_path cache/ keys_zone=auth_cache:10m;" at the bottom your default site config
+ #proxy_cache auth_cache;
+ #proxy_cache_valid 200 10m;
+ #proxy_cache_key "$http_authorization$cookie_nginxauth";
+
+ # As implemented in nginx-ldap-auth-daemon.py, the ldap-auth daemon
+ # communicates with a LDAP server, passing in the following
+ # parameters to specify which user account to authenticate. To
+ # eliminate the need to modify the Python code, this file contains
+ # 'proxy_set_header' directives that set the values of the
+ # parameters. Set or change them as instructed in the comments.
+ #
+ # Parameter Proxy header
+ # ----------- ----------------
+ # url X-Ldap-URL
+ # starttls X-Ldap-Starttls
+ # basedn X-Ldap-BaseDN
+ # binddn X-Ldap-BindDN
+ # bindpasswd X-Ldap-BindPass
+ # cookiename X-CookieName
+ # realm X-Ldap-Realm
+ # template X-Ldap-Template
+
+ # (Required) Set the URL and port for connecting to the LDAP server,
+ # by replacing 'example.com'.
+ # Do not mix ldaps-style URL and X-Ldap-Starttls as it will not work.
+ proxy_set_header X-Ldap-URL "ldap://example.com";
+
+ # (Optional) Establish a TLS-enabled LDAP session after binding to the
+ # LDAP server.
+ # This is the 'proper' way to establish encrypted TLS connections, see
+ # http://www.openldap.org/faq/data/cache/185.html
+ #proxy_set_header X-Ldap-Starttls "true";
+
+ # (Required) Set the Base DN, by replacing the value enclosed in
+ # double quotes.
+ proxy_set_header X-Ldap-BaseDN "cn=Users,dc=test,dc=local";
+
+ # (Required) Set the Bind DN, by replacing the value enclosed in
+ # double quotes.
+ # If AD, use "root@test.local"
+ proxy_set_header X-Ldap-BindDN "cn=root,dc=test,dc=local";
+
+ # (Required) Set the Bind password, by replacing 'secret'.
+ proxy_set_header X-Ldap-BindPass "secret";
+
+ # (Required) The following directives set the cookie name and pass
+ # it, respectively. They are required for cookie-based
+ # authentication. Comment them out if using HTTP basic
+ # authentication.
+ proxy_set_header X-CookieName "nginxauth";
+ proxy_set_header Cookie nginxauth=$cookie_nginxauth;
+
+ # (Required if using Microsoft Active Directory as the LDAP server)
+ # Set the LDAP template by uncommenting the following directive.
+ #proxy_set_header X-Ldap-Template "(sAMAccountName=%(username)s)";
+
+ # (Optional if using OpenLDAP as the LDAP server) Set the LDAP
+ # template by uncommenting the following directive and replacing
+ # '(cn=%(username)s)' which is the default set in
+ # nginx-ldap-auth-daemon.py.
+ #proxy_set_header X-Ldap-Template "(cn=%(username)s)";
+
+ # (Optional) Set the realm name, by uncommenting the following
+ # directive and replacing 'Restricted' which is the default set
+ # in nginx-ldap-auth-daemon.py.
+ #proxy_set_header X-Ldap-Realm "Restricted";
+ }
diff --git a/root/defaults/nginx.conf b/root/defaults/nginx.conf
new file mode 100644
index 0000000..543fc9b
--- /dev/null
+++ b/root/defaults/nginx.conf
@@ -0,0 +1,105 @@
+## Version 2019/12/19 - Changelog: https://github.com/linuxserver/docker-letsencrypt/commits/master/root/defaults/nginx.conf
+
+user abc;
+worker_processes 4;
+pid /run/nginx.pid;
+include /etc/nginx/modules/*.conf;
+
+events {
+ worker_connections 768;
+ # multi_accept on;
+}
+
+http {
+
+ ##
+ # Basic Settings
+ ##
+
+ sendfile on;
+ tcp_nopush on;
+ tcp_nodelay on;
+ keepalive_timeout 65;
+ types_hash_max_size 2048;
+ variables_hash_max_size 2048;
+ large_client_header_buffers 4 16k;
+
+ # server_tokens off;
+
+ # server_names_hash_bucket_size 64;
+ # server_name_in_redirect off;
+
+ client_max_body_size 0;
+
+ include /etc/nginx/mime.types;
+ default_type application/octet-stream;
+
+ ##
+ # Logging Settings
+ ##
+
+ access_log /config/log/nginx/access.log;
+ error_log /config/log/nginx/error.log;
+
+ ##
+ # Gzip Settings
+ ##
+
+ gzip on;
+ gzip_disable "msie6";
+
+ # gzip_vary on;
+ # gzip_proxied any;
+ # gzip_comp_level 6;
+ # gzip_buffers 16 8k;
+ # gzip_http_version 1.1;
+ # gzip_types text/plain text/css application/json application/x-javascript text/xml application/xml application/xml+rss text/javascript;
+
+ ##
+ # nginx-naxsi config
+ ##
+ # Uncomment it if you installed nginx-naxsi
+ ##
+
+ #include /etc/nginx/naxsi_core.rules;
+
+ ##
+ # nginx-passenger config
+ ##
+ # Uncomment it if you installed nginx-passenger
+ ##
+
+ #passenger_root /usr;
+ #passenger_ruby /usr/bin/ruby;
+
+ ##
+ # Virtual Host Configs
+ ##
+ include /etc/nginx/conf.d/*.conf;
+ include /config/nginx/site-confs/*;
+ lua_load_resty_core off;
+
+}
+
+
+#mail {
+# # See sample authentication script at:
+# # http://wiki.nginx.org/ImapAuthenticateWithApachePhpScript
+#
+# # auth_http localhost/auth.php;
+# # pop3_capabilities "TOP" "USER";
+# # imap_capabilities "IMAP4rev1" "UIDPLUS";
+#
+# server {
+# listen localhost:110;
+# protocol pop3;
+# proxy on;
+# }
+#
+# server {
+# listen localhost:143;
+# protocol imap;
+# proxy on;
+# }
+#}
+daemon off;
diff --git a/root/defaults/proxy.conf b/root/defaults/proxy.conf
new file mode 100644
index 0000000..382ac33
--- /dev/null
+++ b/root/defaults/proxy.conf
@@ -0,0 +1,32 @@
+## Version 2019/10/23 - Changelog: https://github.com/linuxserver/docker-letsencrypt/commits/master/root/defaults/proxy.conf
+
+client_body_buffer_size 128k;
+
+#Timeout if the real server is dead
+proxy_next_upstream error timeout invalid_header http_500 http_502 http_503;
+
+# Advanced Proxy Config
+send_timeout 5m;
+proxy_read_timeout 240;
+proxy_send_timeout 240;
+proxy_connect_timeout 240;
+
+# TLS 1.3 early data
+proxy_set_header Early-Data $ssl_early_data;
+
+# Basic Proxy Config
+proxy_set_header Host $host;
+proxy_set_header X-Real-IP $remote_addr;
+proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+proxy_set_header X-Forwarded-Proto https;
+proxy_set_header X-Forwarded-Host $host;
+proxy_set_header X-Forwarded-Ssl on;
+proxy_redirect http:// $scheme://;
+proxy_http_version 1.1;
+proxy_set_header Connection "";
+#proxy_cookie_path / "/; HTTPOnly; Secure"; # enable at your own risk, may break certain apps
+proxy_cache_bypass $cookie_session;
+proxy_no_cache $cookie_session;
+proxy_buffers 32 4k;
+proxy_headers_hash_bucket_size 128;
+proxy_headers_hash_max_size 1024;
diff --git a/root/defaults/ssl.conf b/root/defaults/ssl.conf
new file mode 100644
index 0000000..ecbd8a3
--- /dev/null
+++ b/root/defaults/ssl.conf
@@ -0,0 +1,48 @@
+## Version 2020/06/17 - Changelog: https://github.com/linuxserver/docker-letsencrypt/commits/master/root/defaults/ssl.conf
+
+### Mozilla Recommendations
+# generated 2020-06-17, Mozilla Guideline v5.4, nginx 1.18.0-r0, OpenSSL 1.1.1g-r0, intermediate configuration
+# https://ssl-config.mozilla.org/#server=nginx&version=1.18.0-r0&config=intermediate&openssl=1.1.1g-r0&guideline=5.4
+
+ssl_session_timeout 1d;
+ssl_session_cache shared:MozSSL:10m; # about 40000 sessions
+ssl_session_tickets off;
+
+# intermediate configuration
+ssl_protocols TLSv1.2 TLSv1.3;
+ssl_ciphers ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:DHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384;
+ssl_prefer_server_ciphers off;
+
+# OCSP stapling
+ssl_stapling on;
+ssl_stapling_verify on;
+
+
+### Linuxserver.io Defaults
+
+# Certificates
+ssl_certificate /config/keys/letsencrypt/fullchain.pem;
+ssl_certificate_key /config/keys/letsencrypt/privkey.pem;
+# verify chain of trust of OCSP response using Root CA and Intermediate certs
+ssl_trusted_certificate /config/keys/letsencrypt/fullchain.pem;
+
+# Diffie-Hellman Parameters
+ssl_dhparam /config/nginx/dhparams.pem;
+
+# Resolver
+resolver 127.0.0.11 valid=30s; # Docker DNS Server
+
+# Enable TLS 1.3 early data
+ssl_early_data on;
+
+# HSTS, remove # from the line below to enable HSTS
+#add_header Strict-Transport-Security "max-age=63072000; includeSubDomains; preload" always;
+
+# Optional additional headers
+#add_header Content-Security-Policy "upgrade-insecure-requests";
+#add_header X-Frame-Options "SAMEORIGIN" always;
+#add_header X-XSS-Protection "1; mode=block" always;
+#add_header X-Content-Type-Options "nosniff" always;
+#add_header X-UA-Compatible "IE=Edge" always;
+#add_header Cache-Control "no-transform" always;
+#add_header Referrer-Policy "same-origin" always;
diff --git a/root/donate.txt b/root/donate.txt
new file mode 100644
index 0000000..ca1e150
--- /dev/null
+++ b/root/donate.txt
@@ -0,0 +1 @@
+Certbot: https://supporters.eff.org/donate/support-work-on-certbot
diff --git a/root/etc/cont-init.d/50-config b/root/etc/cont-init.d/50-config
new file mode 100644
index 0000000..8ef1feb
--- /dev/null
+++ b/root/etc/cont-init.d/50-config
@@ -0,0 +1,302 @@
+#!/usr/bin/with-contenv bash
+
+# Display variables for troubleshooting
+echo -e "Variables set:\\n\
+PUID=${PUID}\\n\
+PGID=${PGID}\\n\
+TZ=${TZ}\\n\
+URL=${URL}\\n\
+SUBDOMAINS=${SUBDOMAINS}\\n\
+EXTRA_DOMAINS=${EXTRA_DOMAINS}\\n\
+ONLY_SUBDOMAINS=${ONLY_SUBDOMAINS}\\n\
+VALIDATION=${VALIDATION}\\n\
+DNSPLUGIN=${DNSPLUGIN}\\n\
+EMAIL=${EMAIL}\\n\
+STAGING=${STAGING}\\n"
+
+# Echo init finish for test runs
+if [ -n "${TEST_RUN}" ]; then
+ echo '[services.d] done.'
+fi
+
+# Sanitize variables
+SANED_VARS=( DNSPLUGIN EMAIL EXTRA_DOMAINS ONLY_SUBDOMAINS STAGING SUBDOMAINS URL VALIDATION )
+for i in "${SANED_VARS[@]}"
+do
+ export echo "$i"="${!i//\"/}"
+ export echo "$i"="$(echo "${!i}" | tr '[:upper:]' '[:lower:]')"
+done
+
+# check to make sure that the required variables are set
+[[ -z "$URL" ]] && \
+ echo "Please pass your URL as an environment variable in your docker run command. See docker info for more details." && \
+ sleep infinity
+
+# make our folders and links
+mkdir -p \
+ /config/{log/letsencrypt,log/fail2ban,etc/letsencrypt,fail2ban,crontabs,dns-conf,geoip2db} \
+ /var/run/fail2ban
+rm -rf /etc/letsencrypt
+ln -s /config/etc/letsencrypt /etc/letsencrypt
+
+# copy dns default configs
+cp -n /defaults/dns-conf/* /config/dns-conf/
+chown -R abc:abc /config/dns-conf
+
+# copy reverse proxy configs
+cp -R /defaults/proxy-confs /config/nginx/
+# remove outdated files (remove this action after 2020/10/17)
+rm -f /config/nginx/proxy-confs/seafile.subdomain.config.sample /config/nginx/proxy-confs/librespeed.subdomain.com.sample
+
+# copy/update the fail2ban config defaults to/in /config
+cp -R /defaults/fail2ban/filter.d /config/fail2ban/
+cp -R /defaults/fail2ban/action.d /config/fail2ban/
+# if jail.local is missing in /config, copy default
+[[ ! -f /config/fail2ban/jail.local ]] && \
+ cp /defaults/jail.local /config/fail2ban/jail.local
+# Replace fail2ban config with user config
+[[ -d /etc/fail2ban/filter.d ]] && \
+ rm -rf /etc/fail2ban/filter.d
+[[ -d /etc/fail2ban/action.d ]] && \
+ rm -rf /etc/fail2ban/action.d
+cp -R /config/fail2ban/filter.d /etc/fail2ban/
+cp -R /config/fail2ban/action.d /etc/fail2ban/
+cp /defaults/fail2ban/fail2ban.local /etc/fail2ban/
+cp /config/fail2ban/jail.local /etc/fail2ban/jail.local
+
+# copy crontab and proxy defaults if needed
+[[ ! -f /config/crontabs/root ]] && \
+ cp /etc/crontabs/root /config/crontabs/
+[[ ! -f /config/nginx/proxy.conf ]] && \
+ cp /defaults/proxy.conf /config/nginx/proxy.conf
+[[ ! -f /config/nginx/ssl.conf ]] && \
+ cp /defaults/ssl.conf /config/nginx/ssl.conf
+[[ ! -f /config/nginx/ldap.conf ]] && \
+ cp /defaults/ldap.conf /config/nginx/ldap.conf
+[[ ! -f /config/nginx/authelia-server.conf ]] && \
+ cp /defaults/authelia-server.conf /config/nginx/authelia-server.conf
+[[ ! -f /config/nginx/authelia-location.conf ]] && \
+ cp /defaults/authelia-location.conf /config/nginx/authelia-location.conf
+
+# copy pre-generated dhparams or generate if needed
+[[ ! -f /config/nginx/dhparams.pem ]] && \
+ cp /defaults/dhparams.pem /config/nginx/dhparams.pem
+if ! grep -q 'PARAMETERS' "/config/nginx/dhparams.pem"; then
+ curl -o /config/nginx/dhparams.pem -L "https://lsio.ams3.digitaloceanspaces.com/dhparams.pem"
+fi
+if ! grep -q 'PARAMETERS' "/config/nginx/dhparams.pem"; then
+ echo "Generating dhparams.pem. This will take a long time. Do not stop the container until this process is completed."
+ openssl dhparam -out /config/nginx/dhparams.pem 4096
+fi
+
+# check to make sure DNSPLUGIN is selected if dns validation is used
+[[ "$VALIDATION" = "dns" ]] && [[ ! "$DNSPLUGIN" =~ ^(aliyun|cloudflare|cloudxns|cpanel|digitalocean|dnsimple|dnsmadeeasy|domeneshop|gandi|google|inwx|linode|luadns|nsone|ovh|rfc2136|route53|transip)$ ]] && \
+ echo "Please set the DNSPLUGIN variable to a valid plugin name. See docker info for more details." && \
+ sleep infinity
+
+# import user crontabs
+rm /etc/crontabs/*
+cp /config/crontabs/* /etc/crontabs/
+
+# create original config file if it doesn't exist
+if [ ! -f "/config/donoteditthisfile.conf" ]; then
+ echo -e "ORIGURL=\"$URL\" ORIGSUBDOMAINS=\"$SUBDOMAINS\" ORIGONLY_SUBDOMAINS=\"$ONLY_SUBDOMAINS\" ORIGEXTRA_DOMAINS=\"$EXTRA_DOMAINS\" ORIGVALIDATION=\"$VALIDATION\" ORIGDNSPLUGIN=\"$DNSPLUGIN\" ORIGPROPAGATION=\"$PROPAGATION\" ORIGSTAGING=\"$STAGING\" ORIGDUCKDNSTOKEN=\"$DUCKDNSTOKEN\"" > /config/donoteditthisfile.conf
+ echo "Created donoteditthisfile.conf"
+fi
+
+# load original config settings
+# shellcheck disable=SC1091
+. /config/donoteditthisfile.conf
+
+# set default validation to http
+if [ -z "$VALIDATION" ]; then
+ VALIDATION="http"
+ echo "VALIDATION parameter not set; setting it to http"
+fi
+
+# if staging is set to true, use the staging server
+if [ "$STAGING" = "true" ]; then
+ echo "NOTICE: Staging is active"
+ ACMESERVER="https://acme-staging-v02.api.letsencrypt.org/directory"
+else
+ ACMESERVER="https://acme-v02.api.letsencrypt.org/directory"
+fi
+
+# figuring out url only vs url & subdomains vs subdomains only
+if [ -n "$SUBDOMAINS" ]; then
+ echo "SUBDOMAINS entered, processing"
+ if [ "$SUBDOMAINS" = "wildcard" ]; then
+ if [ "$ONLY_SUBDOMAINS" = true ]; then
+ export URL_REAL="-d *.${URL}"
+ echo "Wildcard cert for only the subdomains of $URL will be requested"
+ else
+ export URL_REAL="-d *.${URL} -d ${URL}"
+ echo "Wildcard cert for $URL will be requested"
+ fi
+ else
+ echo "SUBDOMAINS entered, processing"
+ for job in $(echo "$SUBDOMAINS" | tr "," " "); do
+ export SUBDOMAINS_REAL="$SUBDOMAINS_REAL -d ${job}.${URL}"
+ done
+ if [ "$ONLY_SUBDOMAINS" = true ]; then
+ URL_REAL="$SUBDOMAINS_REAL"
+ echo "Only subdomains, no URL in cert"
+ else
+ URL_REAL="-d ${URL}${SUBDOMAINS_REAL}"
+ fi
+ echo "Sub-domains processed are: $SUBDOMAINS_REAL"
+ fi
+else
+ echo "No subdomains defined"
+ URL_REAL="-d $URL"
+fi
+
+# add extra domains
+if [ -n "$EXTRA_DOMAINS" ]; then
+ echo "EXTRA_DOMAINS entered, processing"
+ for job in $(echo "$EXTRA_DOMAINS" | tr "," " "); do
+ export EXTRA_DOMAINS_REAL="$EXTRA_DOMAINS_REAL -d ${job}"
+ done
+ echo "Extra domains processed are: $EXTRA_DOMAINS_REAL"
+ URL_REAL="$URL_REAL $EXTRA_DOMAINS_REAL"
+fi
+
+# figuring out whether to use e-mail and which
+if [[ $EMAIL == *@* ]]; then
+ echo "E-mail address entered: ${EMAIL}"
+ EMAILPARAM="-m ${EMAIL} --no-eff-email"
+else
+ echo "No e-mail address entered or address invalid"
+ EMAILPARAM="--register-unsafely-without-email"
+fi
+
+# setting the validation method to use
+if [ "$VALIDATION" = "dns" ]; then
+ if [ "$DNSPLUGIN" = "route53" ]; then
+ if [ -n "$PROPAGATION" ];then PROPAGATIONPARAM="--dns-${DNSPLUGIN}-propagation-seconds ${PROPAGATION}"; fi
+ PREFCHAL="--dns-${DNSPLUGIN} ${PROPAGATIONPARAM} --manual-public-ip-logging-ok"
+ elif [[ "$DNSPLUGIN" =~ ^(cpanel)$ ]]; then
+ if [ -n "$PROPAGATION" ];then PROPAGATIONPARAM="--certbot-dns-${DNSPLUGIN}:${DNSPLUGIN}-propagation-seconds ${PROPAGATION}"; fi
+ PREFCHAL="-a certbot-dns-${DNSPLUGIN}:${DNSPLUGIN} --certbot-dns-${DNSPLUGIN}:${DNSPLUGIN}-credentials /config/dns-conf/${DNSPLUGIN}.ini ${PROPAGATIONPARAM} --manual-public-ip-logging-ok"
+ elif [[ "$DNSPLUGIN" =~ ^(gandi)$ ]]; then
+ if [ -n "$PROPAGATION" ];then echo "Gandi dns plugin does not support setting propagation time"; fi
+ PREFCHAL="-a certbot-plugin-${DNSPLUGIN}:dns --certbot-plugin-${DNSPLUGIN}:dns-credentials /config/dns-conf/${DNSPLUGIN}.ini --manual-public-ip-logging-ok"
+ elif [[ "$DNSPLUGIN" =~ ^(google)$ ]]; then
+ if [ -n "$PROPAGATION" ];then PROPAGATIONPARAM="--dns-${DNSPLUGIN}-propagation-seconds ${PROPAGATION}"; fi
+ PREFCHAL="--dns-${DNSPLUGIN} --dns-${DNSPLUGIN}-credentials /config/dns-conf/${DNSPLUGIN}.json ${PROPAGATIONPARAM} --manual-public-ip-logging-ok"
+ elif [[ "$DNSPLUGIN" =~ ^(aliyun|domeneshop|inwx|transip)$ ]]; then
+ if [ -n "$PROPAGATION" ];then PROPAGATIONPARAM="--certbot-dns-${DNSPLUGIN}:dns-${DNSPLUGIN}-propagation-seconds ${PROPAGATION}"; fi
+ PREFCHAL="-a certbot-dns-${DNSPLUGIN}:dns-${DNSPLUGIN} --certbot-dns-${DNSPLUGIN}:dns-${DNSPLUGIN}-credentials /config/dns-conf/${DNSPLUGIN}.ini ${PROPAGATIONPARAM} --manual-public-ip-logging-ok"
+ else
+ if [ -n "$PROPAGATION" ];then PROPAGATIONPARAM="--dns-${DNSPLUGIN}-propagation-seconds ${PROPAGATION}"; fi
+ PREFCHAL="--dns-${DNSPLUGIN} --dns-${DNSPLUGIN}-credentials /config/dns-conf/${DNSPLUGIN}.ini ${PROPAGATIONPARAM} --manual-public-ip-logging-ok"
+ fi
+ echo "${VALIDATION} validation via ${DNSPLUGIN} plugin is selected"
+elif [ "$VALIDATION" = "tls-sni" ]; then
+ PREFCHAL="--non-interactive --standalone --preferred-challenges http"
+ echo "*****tls-sni validation has been deprecated, attempting http validation instead"
+elif [ "$VALIDATION" = "duckdns" ]; then
+ PREFCHAL="--non-interactive --manual --preferred-challenges dns --manual-public-ip-logging-ok --manual-auth-hook /app/duckdns-txt"
+ chmod +x /app/duckdns-txt
+ echo "duckdns validation is selected"
+ if [ "$SUBDOMAINS" = "wildcard" ]; then
+ echo "the resulting certificate will only cover the subdomains due to a limitation of duckdns, so it is advised to set the root location to use www.subdomain.duckdns.org"
+ export URL_REAL="-d *.${URL}"
+ else
+ echo "the resulting certificate will only cover the main domain due to a limitation of duckdns, ie. subdomain.duckdns.org"
+ export URL_REAL="-d ${URL}"
+ fi
+else
+ PREFCHAL="--non-interactive --standalone --preferred-challenges http"
+ echo "http validation is selected"
+fi
+
+# setting the symlink for key location
+rm -rf /config/keys/letsencrypt
+if [ "$ONLY_SUBDOMAINS" = "true" ] && [ ! "$SUBDOMAINS" = "wildcard" ] ; then
+ DOMAIN="$(echo "$SUBDOMAINS" | tr ',' ' ' | awk '{print $1}').${URL}"
+ ln -s ../etc/letsencrypt/live/"$DOMAIN" /config/keys/letsencrypt
+else
+ ln -s ../etc/letsencrypt/live/"$URL" /config/keys/letsencrypt
+fi
+
+# checking for changes in cert variables, revoking certs if necessary
+if [ ! "$URL" = "$ORIGURL" ] || [ ! "$SUBDOMAINS" = "$ORIGSUBDOMAINS" ] || [ ! "$ONLY_SUBDOMAINS" = "$ORIGONLY_SUBDOMAINS" ] || [ ! "$EXTRA_DOMAINS" = "$ORIGEXTRA_DOMAINS" ] || [ ! "$VALIDATION" = "$ORIGVALIDATION" ] || [ ! "$DNSPLUGIN" = "$ORIGDNSPLUGIN" ] || [ ! "$PROPAGATION" = "$ORIGPROPAGATION" ] || [ ! "$STAGING" = "$ORIGSTAGING" ] || [ ! "$DUCKDNSTOKEN" = "$ORIGDUCKDNSTOKEN" ]; then
+ echo "Different validation parameters entered than what was used before. Revoking and deleting existing certificate, and an updated one will be created"
+ if [ "$ORIGONLY_SUBDOMAINS" = "true" ] && [ ! "$ORIGSUBDOMAINS" = "wildcard" ]; then
+ ORIGDOMAIN="$(echo "$ORIGSUBDOMAINS" | tr ',' ' ' | awk '{print $1}').${ORIGURL}"
+ [[ -f /config/etc/letsencrypt/live/"$ORIGDOMAIN"/fullchain.pem ]] && certbot revoke --non-interactive --cert-path /config/etc/letsencrypt/live/"$ORIGDOMAIN"/fullchain.pem
+ else
+ [[ -f /config/etc/letsencrypt/live/"$ORIGURL"/fullchain.pem ]] && certbot revoke --non-interactive --cert-path /config/etc/letsencrypt/live/"$ORIGURL"/fullchain.pem
+ fi
+ rm -rf /config/etc/letsencrypt
+ mkdir -p /config/etc/letsencrypt
+fi
+
+# saving new variables
+echo -e "ORIGURL=\"$URL\" ORIGSUBDOMAINS=\"$SUBDOMAINS\" ORIGONLY_SUBDOMAINS=\"$ONLY_SUBDOMAINS\" ORIGEXTRA_DOMAINS=\"$EXTRA_DOMAINS\" ORIGVALIDATION=\"$VALIDATION\" ORIGDNSPLUGIN=\"$DNSPLUGIN\" ORIGPROPAGATION=\"$PROPAGATION\" ORIGSTAGING=\"$STAGING\" ORIGDUCKDNSTOKEN=\"$DUCKDNSTOKEN\"" > /config/donoteditthisfile.conf
+
+# alter extension for error message
+if [ "$DNSPLUGIN" = "google" ]; then
+ FILENAME="$DNSPLUGIN.json"
+else
+ FILENAME="$DNSPLUGIN.ini"
+fi
+
+# generating certs if necessary
+if [ ! -f "/config/keys/letsencrypt/fullchain.pem" ]; then
+ echo "Generating new certificate"
+ # shellcheck disable=SC2086
+ certbot certonly --renew-by-default --server $ACMESERVER $PREFCHAL --rsa-key-size 4096 $EMAILPARAM --agree-tos $URL_REAL
+ if [ -d /config/keys/letsencrypt ]; then
+ cd /config/keys/letsencrypt || exit
+ else
+ if [ "$VALIDATION" = "dns" ]; then
+ echo "ERROR: Cert does not exist! Please see the validation error above. Make sure you entered correct credentials into the /config/dns-conf/${FILENAME} file."
+ elif [ "$VALIDATION" = "duckdns" ]; then
+ echo "ERROR: Cert does not exist! Please see the validation error above. Make sure your DUCKDNSTOKEN is correct."
+ else
+ echo "ERROR: Cert does not exist! Please see the validation error above. The issue may be due to incorrect dns or port forwarding settings. Please fix your settings and recreate the container"
+ fi
+ sleep infinity
+ fi
+ openssl pkcs12 -export -out privkey.pfx -inkey privkey.pem -in cert.pem -certfile chain.pem -passout pass:
+ sleep 1
+ cat {privkey,fullchain}.pem > priv-fullchain-bundle.pem
+ echo "New certificate generated; starting nginx"
+else
+ echo "Certificate exists; parameters unchanged; starting nginx"
+fi
+
+# create GeoIP2 folder symlink
+[[ -d /var/lib/libmaxminddb ]] && [[ ! -L /var/lib/libmaxminddb ]] && \
+ rm -rf /var/lib/libmaxminddb
+[[ ! -d /var/lib/libmaxminddb ]] && \
+ ln -s /config/geoip2db /var/lib/libmaxminddb
+# check GeoIP2 database
+if [ -n "$MAXMINDDB_LICENSE_KEY" ]; then
+ sed -i "s|.*MAXMINDDB_LICENSE_KEY.*|MAXMINDDB_LICENSE_KEY=\"${MAXMINDDB_LICENSE_KEY}\"|g" /etc/conf.d/libmaxminddb
+ if [ ! -f /var/lib/libmaxminddb/GeoLite2-City.mmdb ]; then
+ echo "Downloading GeoIP2 City database."
+ /etc/periodic/weekly/libmaxminddb
+ fi
+elif [ -f /var/lib/libmaxminddb/GeoLite2-City.mmdb ]; then
+ echo -e "Currently using the user provided GeoLite2-City.mmdb.\nIf you want to enable weekly auto-updates of the database, retrieve a free license key from MaxMind,\nand add a new env variable \"MAXMINDDB_LICENSE_KEY\", set to your license key."
+else
+ echo -e "Starting 2019/12/30, GeoIP2 databases require personal license key to download. Please retrieve a free license key from MaxMind,\nand add a new env variable \"MAXMINDDB_LICENSE_KEY\", set to your license key."
+fi
+
+# logfiles needed by fail2ban
+[[ ! -f /config/log/nginx/error.log ]] && \
+ touch /config/log/nginx/error.log
+[[ ! -f /config/log/nginx/access.log ]] && \
+ touch /config/log/nginx/access.log
+
+# permissions
+chown -R abc:abc \
+ /config
+chmod -R 0644 /etc/logrotate.d
+chmod -R +r /config/log
+chmod +x /app/le-renew.sh
+chmod 700 /defaults/dns-conf
+chmod 600 /defaults/dns-conf/*
diff --git a/root/etc/cont-init.d/60-renew b/root/etc/cont-init.d/60-renew
new file mode 100644
index 0000000..975c73a
--- /dev/null
+++ b/root/etc/cont-init.d/60-renew
@@ -0,0 +1,10 @@
+#!/usr/bin/with-contenv bash
+
+# Check if the cert is expired or expires within a day, if so, renew
+if openssl x509 -in /config/keys/letsencrypt/fullchain.pem -noout -checkend 86400 >/dev/null; then
+ echo "The cert does not expire within the next day. Letting the cron script handle the renewal attempts overnight (2:08am)."
+else
+ echo "The cert is either expired or it expires within the next day. Attempting to renew. This could take up to 10 minutes."
+ /app/le-renew.sh
+ sleep 1
+fi
\ No newline at end of file
diff --git a/root/etc/crontabs/root b/root/etc/crontabs/root
new file mode 100644
index 0000000..c24fea0
--- /dev/null
+++ b/root/etc/crontabs/root
@@ -0,0 +1,9 @@
+# do daily/weekly/monthly maintenance
+# min hour day month weekday command
+*/15 * * * * run-parts /etc/periodic/15min
+0 * * * * run-parts /etc/periodic/hourly
+0 2 * * * run-parts /etc/periodic/daily
+0 3 * * 6 run-parts /etc/periodic/weekly
+0 5 1 * * run-parts /etc/periodic/monthly
+# renew letsencrypt certs
+8 2 * * * /app/le-renew.sh >> /config/log/letsencrypt/letsencrypt.log 2>&1
diff --git a/root/etc/logrotate.d/fail2ban b/root/etc/logrotate.d/fail2ban
new file mode 100644
index 0000000..7f3e6ce
--- /dev/null
+++ b/root/etc/logrotate.d/fail2ban
@@ -0,0 +1,12 @@
+/config/log/fail2ban/fail2ban.log {
+ weekly
+ rotate 7
+ missingok
+ compress
+ delaycompress
+ nodateext
+ postrotate
+ /usr/bin/fail2ban-client flushlogs 1>/dev/null || true
+ endscript
+ su abc abc
+}
diff --git a/root/etc/logrotate.d/lerotate b/root/etc/logrotate.d/lerotate
new file mode 100644
index 0000000..28a38a7
--- /dev/null
+++ b/root/etc/logrotate.d/lerotate
@@ -0,0 +1,11 @@
+/config/log/letsencrypt/*.log {
+ weekly
+ rotate 52
+ compress
+ delaycompress
+ nodateext
+ missingok
+ notifempty
+ sharedscripts
+ su abc abc
+}
diff --git a/root/etc/services.d/fail2ban/run b/root/etc/services.d/fail2ban/run
new file mode 100644
index 0000000..c023109
--- /dev/null
+++ b/root/etc/services.d/fail2ban/run
@@ -0,0 +1,4 @@
+#!/usr/bin/with-contenv bash
+
+ exec \
+ fail2ban-client -x -f start