├── .gitignore ├── .dockerignore ├── root ├── app │ ├── start-redbot.sh │ └── functions │ │ ├── check-mount.sh │ │ ├── configure-redbot.sh │ │ ├── setup-env.sh │ │ ├── update-redbot.sh │ │ ├── main-loop.sh │ │ └── pylav_setup.py ├── defaults │ └── config.json └── usr │ └── bin │ └── redbot-setup ├── .github ├── dependabot.yml ├── ISSUE_TEMPLATE │ ├── feature-request.md │ └── bug-report.md └── workflows │ └── build.yml ├── Dockerfile ├── README.md └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | /ignore/ 2 | -------------------------------------------------------------------------------- /.dockerignore: -------------------------------------------------------------------------------- 1 | * 2 | !root/ 3 | -------------------------------------------------------------------------------- /root/app/start-redbot.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env sh 2 | set -euf 3 | 4 | # Perform mount check 5 | /app/functions/check-mount.sh 6 | 7 | # Setup environment 8 | . /app/functions/setup-env.sh 9 | 10 | # Start bot loop 11 | . /app/functions/main-loop.sh 12 | -------------------------------------------------------------------------------- /root/defaults/config.json: -------------------------------------------------------------------------------- 1 | { 2 | "docker": { 3 | "DATA_PATH": "/data", 4 | "COG_PATH_APPEND": "cogs", 5 | "CORE_PATH_APPEND": "core", 6 | "STORAGE_TYPE": "JSON", 7 | "STORAGE_DETAILS": {} 8 | } 9 | } 10 | -------------------------------------------------------------------------------- /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | version: 2 2 | updates: 3 | # Maintain dependencies for GitHub Actions 4 | - package-ecosystem: "github-actions" 5 | directory: "/" 6 | schedule: 7 | interval: "daily" 8 | groups: 9 | github-actions: 10 | patterns: 11 | - "*" 12 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature-request.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Feature Request 3 | about: I know how to make this image better! 4 | title: '' 5 | labels: enhancement 6 | assignees: PhasecoreX 7 | 8 | --- 9 | 10 | **Is your feature request related to a problem? Please describe.** 11 | A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] 12 | 13 | **Describe the solution you'd like** 14 | A clear and concise description of what you want to happen. 15 | 16 | **Describe alternatives you've considered** 17 | A clear and concise description of any alternative solutions or features you've considered. 18 | 19 | **Additional context** 20 | Add any other context or screenshots about the feature request here. 21 | -------------------------------------------------------------------------------- /root/app/functions/check-mount.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env sh 2 | set -euf 3 | 4 | # Ensure that /data is mounted with execute permissions 5 | MOUNT_OUTPUT=$(mount | grep " /data ") 6 | case "${MOUNT_OUTPUT}" in 7 | *noexec*) 8 | echo "" 9 | echo "ERROR" 10 | echo "Your /data mount does not allow execution, as the \"noexec\" flag is present:" 11 | echo "" 12 | echo "${MOUNT_OUTPUT}" 13 | echo "" 14 | echo "In order for this container to work correctly, either remove \"noexec\"" 15 | echo "from the host mount options that /data is using (usually by editing" 16 | echo "the hosts /etc/fstab file), or choose a different location on the host" 17 | echo "for the /data volume that allows execution." 18 | exit 1 19 | ;; 20 | esac 21 | -------------------------------------------------------------------------------- /root/usr/bin/redbot-setup: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env sh 2 | set -euf 3 | 4 | if ! [ -t 0 ]; then 5 | echo "redbot-setup needs to be run in an interactive shell (docker run -it)" 6 | exit 1 7 | fi 8 | 9 | # Setup environment 10 | . /app/functions/setup-env.sh 11 | 12 | # Update redbot if needed 13 | /app/functions/update-redbot.sh 14 | 15 | # Let the user know what the bot instance name is 16 | echo "o--------------------------------------------o" 17 | echo "| |" 18 | echo "| NOTE |" 19 | echo "| |" 20 | echo "| When asked for an instance name, |" 21 | echo "| you MUST use \"docker\" |" 22 | echo "| |" 23 | echo "o--------------------------------------------o" 24 | 25 | # Run the command 26 | python -m redbot.setup "$@" 27 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/bug-report.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bug Report 3 | about: Something is broken! 4 | title: '' 5 | labels: bug 6 | assignees: PhasecoreX 7 | 8 | --- 9 | 10 | 18 | 19 | **Describe the bug** 20 | A clear and concise description of what the bug is. 21 | 22 | **Run command** 23 | ``` 24 | The Docker command/docker-compose.yml you are using to start the bot. 25 | Be sure to censor your bot token (or any other sensitive info) if it is present! 26 | ``` 27 | 28 | **Environment info:** 29 | What system are you running Docker on? 30 | 31 | **Additional context** 32 | Add any other context about the problem here. A more in-depth description, logs, screenshots, whatever. 33 | -------------------------------------------------------------------------------- /root/app/functions/configure-redbot.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env sh 2 | set -euf 3 | 4 | # Make sure we are in the venv 5 | [ -n "${VIRTUAL_ENV:-}" ] 6 | 7 | # Gather prefixes if supplied 8 | PREFIXES="" 9 | if [ -n "${PREFIX5:-}" ]; then 10 | PREFIXES="--prefix ${PREFIX5} ${PREFIXES}" 11 | unset PREFIX5 12 | fi 13 | if [ -n "${PREFIX4:-}" ]; then 14 | PREFIXES="--prefix ${PREFIX4} ${PREFIXES}" 15 | unset PREFIX4 16 | fi 17 | if [ -n "${PREFIX3:-}" ]; then 18 | PREFIXES="--prefix ${PREFIX3} ${PREFIXES}" 19 | unset PREFIX3 20 | fi 21 | if [ -n "${PREFIX2:-}" ]; then 22 | PREFIXES="--prefix ${PREFIX2} ${PREFIXES}" 23 | unset PREFIX2 24 | fi 25 | if [ -n "${PREFIX:-}" ]; then 26 | PREFIXES="--prefix ${PREFIX} ${PREFIXES}" 27 | unset PREFIX 28 | fi 29 | 30 | # Set configurations 31 | if [ -n "${OWNER:-}" ]; then 32 | echo "Setting bot owner..." 33 | python -O -m redbot docker --edit --no-prompt --owner "${OWNER}" 34 | unset OWNER 35 | fi 36 | 37 | if [ -n "${TOKEN:-}" ]; then 38 | echo "Setting bot token..." 39 | python -O -m redbot docker --edit --no-prompt --token "${TOKEN}" 40 | unset TOKEN 41 | fi 42 | 43 | if [ -n "${PREFIXES}" ]; then 44 | echo "Setting bot prefix(es)..." 45 | # shellcheck disable=SC2086 46 | python -O -m redbot docker --edit --no-prompt ${PREFIXES} 47 | unset PREFIXES 48 | fi 49 | -------------------------------------------------------------------------------- /root/app/functions/setup-env.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env sh 2 | set -euf 3 | 4 | # Remove old python venv if detected 5 | PYVERSION=$(realpath "$(command -v python)" | grep -o '[^/]*$') 6 | if [ ! -f "/data/venv/.pyversion" ] || [ "$(cat "/data/venv/.pyversion")" != "${PYVERSION}" ]; then 7 | rm -rf /data/venv 8 | mkdir -p /data/venv 9 | echo "${PYVERSION}" >"/data/venv/.pyversion" 10 | fi 11 | 12 | # If config file doesn't exist, make one 13 | if ! [ -f "/data/config.json" ]; then 14 | if [ -f "${HOME}/config.json" ]; then 15 | # Migrating old data 16 | echo "Moving ${HOME}/config.json to /data/config.json" 17 | mv "${HOME}/config.json" /data/config.json 18 | else 19 | # Default to JSON storage 20 | cp /defaults/config.json /data/config.json 21 | fi 22 | fi 23 | 24 | # If config symlink is broken because user mounted the home directory (/config or /root), make it 25 | if [ "$(readlink -f "${HOME}/.config/Red-DiscordBot/config.json")" != "/data/config.json" ]; then 26 | rm -rf "${HOME}/.config/Red-DiscordBot/config.json" 27 | mkdir -p "${HOME}/.config/Red-DiscordBot" 28 | ln -s /data/config.json "${HOME}/.config/Red-DiscordBot/config.json" 29 | fi 30 | 31 | # Prepare and activate venv 32 | echo "Activating Python virtual environment..." 33 | mkdir -p /data/venv 34 | python -m venv --upgrade --upgrade-deps /data/venv 35 | python -m venv /data/venv 36 | . /data/venv/bin/activate 37 | -------------------------------------------------------------------------------- /root/app/functions/update-redbot.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env sh 2 | set -euf 3 | 4 | stringContain() { case $2 in *$1* ) return 0;; *) return 1;; esac ;} 5 | 6 | # Make sure we are in the venv 7 | [ -n "${VIRTUAL_ENV:-}" ] 8 | 9 | # Determine if we need SetupTools Extras 10 | if [ -z "${STORAGE_TYPE:-}" ]; then 11 | STORAGE_TYPE=$(jq -r .docker.STORAGE_TYPE /data/config.json | tr '[:upper:]' '[:lower:]') 12 | fi 13 | SETUPTOOLS_EXTRAS="" 14 | if [ "${STORAGE_TYPE}" != "json" ]; then 15 | SETUPTOOLS_EXTRAS="[${STORAGE_TYPE}]" 16 | fi 17 | 18 | if stringContain "pylav" "${PCX_DISCORDBOT_TAG}"; then 19 | if [ -z "${PYLAV__DOCKER_DEV_SKIP_INSTALL:-}" ]; then 20 | git config --global --add safe.directory '*' 21 | python /app/functions/pylav_setup.py 22 | fi 23 | fi 24 | 25 | if [ -n "${CUSTOM_REDBOT_PACKAGE:-}" ]; then 26 | echo "WARNING: You have specified a custom Red-DiscordBot Pip install. Little to no support will be given for this setup." 27 | echo "Updating Red-DiscordBot with \"${CUSTOM_REDBOT_PACKAGE}\"..." 28 | python -m pip install --upgrade --upgrade-strategy eager --no-cache-dir wheel "${CUSTOM_REDBOT_PACKAGE}" 29 | echo "${CUSTOM_REDBOT_PACKAGE}" >"/data/venv/.redbotversion" 30 | else 31 | # Update redbot 32 | REDBOT_PACKAGE_NAME="Red-DiscordBot${SETUPTOOLS_EXTRAS}${REDBOT_VERSION:-}" 33 | UPGRADE_STRATEGY="" 34 | if [ ! -f "/data/venv/.redbotversion" ] || [ "$(cat "/data/venv/.redbotversion")" != "${REDBOT_PACKAGE_NAME}" ]; then 35 | UPGRADE_STRATEGY="--upgrade-strategy eager" 36 | fi 37 | echo "Updating ${REDBOT_PACKAGE_NAME}..." 38 | # shellcheck disable=SC2086 39 | python -m pip install --upgrade ${UPGRADE_STRATEGY} --no-cache-dir wheel "${REDBOT_PACKAGE_NAME}" 40 | echo "${REDBOT_PACKAGE_NAME}" >"/data/venv/.redbotversion" 41 | fi 42 | -------------------------------------------------------------------------------- /root/app/functions/main-loop.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env sh 2 | set -euf 3 | 4 | # Make sure we are in the venv 5 | [ -n "${VIRTUAL_ENV:-}" ] 6 | 7 | # Forward SIGTERM to child 8 | # Thank you https://unix.stackexchange.com/a/444676 9 | prep_term() { 10 | unset term_child_pid 11 | unset term_kill_needed 12 | trap 'handle_term' TERM INT 13 | } 14 | handle_term() { 15 | if [ -n "${term_child_pid:-}" ]; then 16 | kill -TERM "${term_child_pid}" 2>/dev/null 17 | else 18 | term_kill_needed="yes" 19 | fi 20 | } 21 | wait_term() { 22 | term_child_pid=$! 23 | if [ -n "${term_kill_needed:-}" ]; then 24 | kill -TERM "${term_child_pid}" 2>/dev/null 25 | fi 26 | wait "${term_child_pid}" 27 | trap - TERM INT 28 | wait "${term_child_pid}" 29 | } 30 | 31 | # Main loop 32 | FIRST_RUN=1 33 | RETURN_CODE=26 34 | while [ "${RETURN_CODE}" -eq 26 ]; do 35 | # Update redbot if needed 36 | /app/functions/update-redbot.sh 37 | 38 | # Only configure bot if this is the first run 39 | if [ "${FIRST_RUN}" -eq 1 ]; then 40 | . /app/functions/configure-redbot.sh 41 | FIRST_RUN=0 42 | fi 43 | 44 | # For default JSON setup... 45 | if [ "$(jq -r .docker.STORAGE_TYPE /data/config.json | tr '[:upper:]' '[:lower:]')" = "json" ]; then 46 | # ...make sure token and prefix are configured 47 | if [ ! -f "/data/core/settings.json" ] || ! jq -e '."0".GLOBAL.token' /data/core/settings.json > /dev/null || ! jq -e '."0".GLOBAL.prefix' /data/core/settings.json > /dev/null; then 48 | echo "" 49 | echo "ERROR" 50 | echo "The configuration file is missing the bot token and/or prefix." 51 | echo "If this is the first time you are running the bot, make sure" 52 | echo "you specify the \"TOKEN\" and \"PREFIX\" environment variables" 53 | echo "(you can remove them after successfully running the bot once)" 54 | exit 1 55 | fi 56 | fi 57 | 58 | echo "Starting Red-DiscordBot!" 59 | set +e 60 | # If we are running in an interactive shell, we can't (and don't need to) do any of the fancy interrupt catching 61 | if [ -t 0 ]; then 62 | # shellcheck disable=SC2086 63 | python -O -m redbot docker ${EXTRA_ARGS:-} 64 | RETURN_CODE=$? 65 | else 66 | prep_term 67 | # shellcheck disable=SC2086 68 | python -O -m redbot docker ${EXTRA_ARGS:-} & 69 | wait_term 70 | RETURN_CODE=$? 71 | fi 72 | set -e 73 | 74 | if [ "${RETURN_CODE}" -eq 26 ]; then 75 | echo "Red-DiscordBot has requested a restart" 76 | fi 77 | done 78 | 79 | echo "Red-DiscordBot has stopped with exit code ${RETURN_CODE}" 80 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM python:3.11-slim-bookworm AS core-build 2 | 3 | # Add PhasecoreX user-entrypoint script 4 | ADD https://raw.githubusercontent.com/PhasecoreX/docker-user-image/master/user-entrypoint.sh /bin/user-entrypoint 5 | RUN chmod +rx /bin/user-entrypoint && /bin/user-entrypoint --init 6 | ENTRYPOINT ["/bin/user-entrypoint"] 7 | 8 | RUN set -eux; \ 9 | # Install Red-DiscordBot dependencies 10 | apt-get update; \ 11 | apt-get install -y --no-install-recommends \ 12 | # Red-DiscordBot 13 | build-essential \ 14 | git \ 15 | # Required for building PyNaCl 16 | libsodium-dev \ 17 | # Required for building CFFI 18 | libffi-dev \ 19 | # start-redbot.sh 20 | jq \ 21 | # ssh repo support 22 | openssh-client \ 23 | ; \ 24 | rm -rf /var/lib/apt/lists/*; \ 25 | # Set up all three config locations 26 | mkdir -p /root/.config/Red-DiscordBot; \ 27 | ln -s /data/config.json /root/.config/Red-DiscordBot/config.json; \ 28 | mkdir -p /usr/local/share/Red-DiscordBot; \ 29 | ln -s /data/config.json /usr/local/share/Red-DiscordBot/config.json; \ 30 | mkdir -p /config/.config/Red-DiscordBot; \ 31 | ln -s /data/config.json /config/.config/Red-DiscordBot/config.json; 32 | 33 | VOLUME /data 34 | 35 | ENV SODIUM_INSTALL=system 36 | 37 | 38 | 39 | FROM core-build AS core 40 | 41 | ARG PCX_DISCORDBOT_BUILD 42 | ARG PCX_DISCORDBOT_COMMIT 43 | 44 | ENV PCX_DISCORDBOT_BUILD=${PCX_DISCORDBOT_BUILD} PCX_DISCORDBOT_COMMIT=${PCX_DISCORDBOT_COMMIT} PCX_DISCORDBOT_TAG=core 45 | 46 | COPY root/ / 47 | 48 | CMD ["/app/start-redbot.sh"] 49 | 50 | ####################################################################################### 51 | 52 | FROM core-build AS extra-build 53 | 54 | RUN set -eux; \ 55 | # Install popular cog dependencies 56 | apt-get update; \ 57 | apt-get install -y --no-install-recommends \ 58 | # NotSoBot 59 | libmagickwand-dev \ 60 | libaa1-dev \ 61 | # CrabRave 62 | ffmpeg \ 63 | imagemagick \ 64 | # RSS (SciPy has no wheels for armv7) 65 | $([ "$(uname --machine)" = "armv7l" ] && echo "gfortran libopenblas-dev liblapack-dev") \ 66 | # ReTrigger 67 | tesseract-ocr \ 68 | ; \ 69 | # CrabRave needs this policy removed 70 | sed -i '/@\*/d' /etc/ImageMagick-6/policy.xml; \ 71 | rm -rf /var/lib/apt/lists/*; 72 | 73 | 74 | 75 | FROM extra-build AS extra 76 | 77 | ARG PCX_DISCORDBOT_BUILD 78 | ARG PCX_DISCORDBOT_COMMIT 79 | 80 | ENV PCX_DISCORDBOT_BUILD=${PCX_DISCORDBOT_BUILD} PCX_DISCORDBOT_COMMIT=${PCX_DISCORDBOT_COMMIT} PCX_DISCORDBOT_TAG=extra 81 | 82 | COPY root/ / 83 | 84 | CMD ["/app/start-redbot.sh"] 85 | 86 | ####################################################################################### 87 | 88 | FROM core-build AS core-audio-build 89 | 90 | RUN set -eux; \ 91 | # Install redbot audio dependencies 92 | apt-get update; \ 93 | apt-get install -y --no-install-recommends \ 94 | openjdk-17-jre-headless \ 95 | ; \ 96 | rm -rf /var/lib/apt/lists/*; 97 | 98 | 99 | 100 | FROM core-audio-build AS core-audio 101 | 102 | ARG PCX_DISCORDBOT_BUILD 103 | ARG PCX_DISCORDBOT_COMMIT 104 | 105 | ENV PCX_DISCORDBOT_BUILD=${PCX_DISCORDBOT_BUILD} PCX_DISCORDBOT_COMMIT=${PCX_DISCORDBOT_COMMIT} PCX_DISCORDBOT_TAG=core-audio 106 | 107 | COPY root/ / 108 | 109 | CMD ["/app/start-redbot.sh"] 110 | 111 | ####################################################################################### 112 | 113 | FROM extra-build AS extra-audio-build 114 | 115 | RUN set -eux; \ 116 | # Install redbot audio dependencies 117 | apt-get update; \ 118 | apt-get install -y --no-install-recommends \ 119 | openjdk-17-jre-headless \ 120 | ; \ 121 | rm -rf /var/lib/apt/lists/*; 122 | 123 | 124 | 125 | FROM extra-audio-build AS extra-audio 126 | 127 | ARG PCX_DISCORDBOT_BUILD 128 | ARG PCX_DISCORDBOT_COMMIT 129 | 130 | ENV PCX_DISCORDBOT_BUILD=${PCX_DISCORDBOT_BUILD} PCX_DISCORDBOT_COMMIT=${PCX_DISCORDBOT_COMMIT} PCX_DISCORDBOT_TAG=extra-audio 131 | 132 | COPY root/ / 133 | 134 | CMD ["/app/start-redbot.sh"] 135 | 136 | ####################################################################################### 137 | 138 | FROM core-build AS core-pylav-build 139 | 140 | RUN set -eux; \ 141 | # Install pylav dependencies 142 | apt-get update; \ 143 | apt-get install -y --no-install-recommends \ 144 | libaio1 \ 145 | libaio-dev \ 146 | ; \ 147 | rm -rf /var/lib/apt/lists/*; \ 148 | mkdir -p /data/pylav; 149 | 150 | 151 | FROM core-pylav-build AS core-pylav 152 | 153 | ARG PCX_DISCORDBOT_BUILD 154 | ARG PCX_DISCORDBOT_COMMIT 155 | 156 | ENV PCX_DISCORDBOT_BUILD=${PCX_DISCORDBOT_BUILD} PCX_DISCORDBOT_COMMIT=${PCX_DISCORDBOT_COMMIT} PCX_DISCORDBOT_TAG=core-pylav 157 | ENV PYLAV__DATA_FOLDER=/data/pylav PYLAV__YAML_CONFIG=/data/pylav/pylav.yaml PYLAV__IN_CONTAINER=1 158 | 159 | COPY root/ / 160 | 161 | CMD ["/app/start-redbot.sh"] 162 | 163 | ####################################################################################### 164 | 165 | FROM extra-build AS extra-pylav-build 166 | 167 | RUN set -eux; \ 168 | # Install pylav dependencies 169 | apt-get update; \ 170 | apt-get install -y --no-install-recommends \ 171 | libaio1 \ 172 | libaio-dev \ 173 | ; \ 174 | rm -rf /var/lib/apt/lists/*; \ 175 | mkdir -p /data/pylav; 176 | 177 | 178 | FROM extra-pylav-build AS extra-pylav 179 | 180 | ARG PCX_DISCORDBOT_BUILD 181 | ARG PCX_DISCORDBOT_COMMIT 182 | 183 | ENV PCX_DISCORDBOT_BUILD=${PCX_DISCORDBOT_BUILD} PCX_DISCORDBOT_COMMIT=${PCX_DISCORDBOT_COMMIT} PCX_DISCORDBOT_TAG=extra-pylav 184 | ENV PYLAV__DATA_FOLDER=/data/pylav PYLAV__YAML_CONFIG=/data/pylav/pylav.yaml PYLAV__IN_CONTAINER=1 185 | 186 | COPY root/ / 187 | 188 | CMD ["/app/start-redbot.sh"] 189 | -------------------------------------------------------------------------------- /.github/workflows/build.yml: -------------------------------------------------------------------------------- 1 | name: build 2 | 3 | on: 4 | push: 5 | branches: 6 | - master 7 | paths: 8 | - Dockerfile 9 | - .github/workflows/build.yml 10 | - root/** 11 | pull_request: 12 | branches: 13 | - master 14 | paths: 15 | - Dockerfile 16 | - .github/workflows/build.yml 17 | - root/** 18 | repository_dispatch: 19 | types: 20 | - upstream_image_update 21 | workflow_dispatch: 22 | 23 | jobs: 24 | docker: 25 | runs-on: ubuntu-latest 26 | permissions: 27 | packages: write 28 | env: 29 | TITLE: Red-DiscordBot 30 | GHCR_SLUG: ghcr.io/phasecorex/red-discordbot 31 | DOCK_SLUG: docker.io/phasecorex/red-discordbot 32 | steps: 33 | - 34 | name: Checkout 35 | uses: actions/checkout@v6 36 | - 37 | name: Docker meta 38 | id: meta 39 | uses: docker/metadata-action@v5 40 | with: 41 | images: | 42 | ${{ env.GHCR_SLUG }} 43 | ${{ env.DOCK_SLUG }} 44 | labels: | 45 | maintainer=${{ github.repository_owner }} 46 | org.opencontainers.image.vendor=${{ github.repository_owner }} 47 | org.opencontainers.image.title=${{ env.TITLE }} 48 | - 49 | name: Set up QEMU 50 | uses: docker/setup-qemu-action@v3 51 | - 52 | name: Set up Docker Buildx 53 | uses: docker/setup-buildx-action@v3 54 | - 55 | name: Login to GitHub Container Registry 56 | if: github.event_name != 'pull_request' 57 | uses: docker/login-action@v3 58 | with: 59 | registry: ghcr.io 60 | username: ${{ github.repository_owner }} 61 | password: ${{ secrets.GITHUB_TOKEN }} 62 | - 63 | name: Login to DockerHub 64 | if: github.event_name != 'pull_request' 65 | uses: docker/login-action@v3 66 | with: 67 | username: ${{ secrets.DOCKERHUB_USERNAME }} 68 | password: ${{ secrets.DOCKERHUB_TOKEN }} 69 | - 70 | name: Build and push extra-audio 71 | uses: docker/build-push-action@v6 72 | with: 73 | target: extra-audio 74 | platforms: | 75 | linux/amd64 76 | linux/arm/v7 77 | linux/arm64 78 | push: ${{ github.event_name != 'pull_request' }} 79 | tags: | 80 | ${{ env.GHCR_SLUG }}:full-py311 81 | ${{ env.DOCK_SLUG }}:full-py311 82 | ${{ env.GHCR_SLUG }}:full 83 | ${{ env.DOCK_SLUG }}:full 84 | ${{ env.GHCR_SLUG }}:extra-audio-py311 85 | ${{ env.DOCK_SLUG }}:extra-audio-py311 86 | ${{ env.GHCR_SLUG }}:extra-audio 87 | ${{ env.DOCK_SLUG }}:extra-audio 88 | build-args: | 89 | PCX_DISCORDBOT_BUILD=${{ github.run_id }} 90 | PCX_DISCORDBOT_COMMIT=${{ github.sha }} 91 | cache-from: | 92 | ${{ env.GHCR_SLUG }}:extra-audio 93 | labels: ${{ steps.meta.outputs.labels }} 94 | - 95 | name: Build and push core 96 | uses: docker/build-push-action@v6 97 | with: 98 | target: core 99 | platforms: | 100 | linux/amd64 101 | linux/arm/v7 102 | linux/arm64 103 | push: ${{ github.event_name != 'pull_request' }} 104 | tags: | 105 | ${{ env.GHCR_SLUG }}:noaudio-py311 106 | ${{ env.DOCK_SLUG }}:noaudio-py311 107 | ${{ env.GHCR_SLUG }}:noaudio 108 | ${{ env.DOCK_SLUG }}:noaudio 109 | ${{ env.GHCR_SLUG }}:core-py311 110 | ${{ env.DOCK_SLUG }}:core-py311 111 | ${{ env.GHCR_SLUG }}:core 112 | ${{ env.DOCK_SLUG }}:core 113 | build-args: | 114 | PCX_DISCORDBOT_BUILD=${{ github.run_id }} 115 | PCX_DISCORDBOT_COMMIT=${{ github.sha }} 116 | cache-from: | 117 | ${{ env.GHCR_SLUG }}:extra-audio 118 | labels: ${{ steps.meta.outputs.labels }} 119 | - 120 | name: Build and push extra 121 | uses: docker/build-push-action@v6 122 | with: 123 | target: extra 124 | platforms: | 125 | linux/amd64 126 | linux/arm/v7 127 | linux/arm64 128 | push: ${{ github.event_name != 'pull_request' }} 129 | tags: | 130 | ${{ env.GHCR_SLUG }}:extra-py311 131 | ${{ env.DOCK_SLUG }}:extra-py311 132 | ${{ env.GHCR_SLUG }}:extra 133 | ${{ env.DOCK_SLUG }}:extra 134 | build-args: | 135 | PCX_DISCORDBOT_BUILD=${{ github.run_id }} 136 | PCX_DISCORDBOT_COMMIT=${{ github.sha }} 137 | cache-from: | 138 | ${{ env.GHCR_SLUG }}:extra-audio 139 | labels: ${{ steps.meta.outputs.labels }} 140 | - 141 | name: Build and push core-audio 142 | uses: docker/build-push-action@v6 143 | with: 144 | target: core-audio 145 | platforms: | 146 | linux/amd64 147 | linux/arm/v7 148 | linux/arm64 149 | push: ${{ github.event_name != 'pull_request' }} 150 | tags: | 151 | ${{ env.GHCR_SLUG }}:audio-py311 152 | ${{ env.DOCK_SLUG }}:audio-py311 153 | ${{ env.GHCR_SLUG }}:audio 154 | ${{ env.DOCK_SLUG }}:audio 155 | ${{ env.GHCR_SLUG }}:core-audio-py311 156 | ${{ env.DOCK_SLUG }}:core-audio-py311 157 | ${{ env.GHCR_SLUG }}:core-audio 158 | ${{ env.DOCK_SLUG }}:core-audio 159 | ${{ env.GHCR_SLUG }}:latest 160 | ${{ env.DOCK_SLUG }}:latest 161 | build-args: | 162 | PCX_DISCORDBOT_BUILD=${{ github.run_id }} 163 | PCX_DISCORDBOT_COMMIT=${{ github.sha }} 164 | cache-from: | 165 | ${{ env.GHCR_SLUG }}:core 166 | ${{ env.GHCR_SLUG }}:core-audio 167 | labels: ${{ steps.meta.outputs.labels }} 168 | - 169 | name: Build and push core-pylav 170 | uses: docker/build-push-action@v6 171 | with: 172 | target: core-pylav 173 | platforms: | 174 | linux/amd64 175 | linux/arm/v7 176 | linux/arm64 177 | push: ${{ github.event_name != 'pull_request' }} 178 | tags: | 179 | ${{ env.GHCR_SLUG }}:pylav 180 | ${{ env.DOCK_SLUG }}:pylav 181 | ${{ env.GHCR_SLUG }}:core-pylav 182 | ${{ env.DOCK_SLUG }}:core-pylav 183 | ${{ env.GHCR_SLUG }}:latest-pylav 184 | ${{ env.DOCK_SLUG }}:latest-pylav 185 | build-args: | 186 | PCX_DISCORDBOT_BUILD=${{ github.run_id }} 187 | PCX_DISCORDBOT_COMMIT=${{ github.sha }} 188 | cache-from: | 189 | ${{ env.GHCR_SLUG }}:core-audio 190 | ${{ env.GHCR_SLUG }}:core-pylav 191 | labels: ${{ steps.meta.outputs.labels }} 192 | - 193 | name: Build and push extra-pylav 194 | uses: docker/build-push-action@v6 195 | with: 196 | target: extra-pylav 197 | platforms: | 198 | linux/amd64 199 | linux/arm/v7 200 | linux/arm64 201 | push: ${{ github.event_name != 'pull_request' }} 202 | tags: | 203 | ${{ env.GHCR_SLUG }}:full-pylav 204 | ${{ env.DOCK_SLUG }}:full-pylav 205 | ${{ env.GHCR_SLUG }}:extra-pylav 206 | ${{ env.DOCK_SLUG }}:extra-pylav 207 | build-args: | 208 | PCX_DISCORDBOT_BUILD=${{ github.run_id }} 209 | PCX_DISCORDBOT_COMMIT=${{ github.sha }} 210 | cache-from: | 211 | ${{ env.GHCR_SLUG }}:extra-audio 212 | ${{ env.GHCR_SLUG }}:core-pylav 213 | ${{ env.GHCR_SLUG }}:extra-pylav 214 | labels: ${{ steps.meta.outputs.labels }} 215 | - 216 | name: Check manifest 217 | if: github.event_name != 'pull_request' 218 | run: | 219 | docker buildx imagetools inspect ${{ env.GHCR_SLUG }}:core 220 | docker buildx imagetools inspect ${{ env.GHCR_SLUG }}:extra 221 | docker buildx imagetools inspect ${{ env.GHCR_SLUG }}:core-audio 222 | docker buildx imagetools inspect ${{ env.GHCR_SLUG }}:extra-audio 223 | docker buildx imagetools inspect ${{ env.GHCR_SLUG }}:core-pylav 224 | docker buildx imagetools inspect ${{ env.GHCR_SLUG }}:extra-pylav 225 | docker buildx imagetools inspect ${{ env.DOCK_SLUG }}:core 226 | docker buildx imagetools inspect ${{ env.DOCK_SLUG }}:extra 227 | docker buildx imagetools inspect ${{ env.DOCK_SLUG }}:core-audio 228 | docker buildx imagetools inspect ${{ env.DOCK_SLUG }}:extra-audio 229 | docker buildx imagetools inspect ${{ env.DOCK_SLUG }}:core-pylav 230 | docker buildx imagetools inspect ${{ env.DOCK_SLUG }}:extra-pylav 231 | - 232 | name: Check pull 233 | if: github.event_name != 'pull_request' 234 | run: | 235 | docker pull ${{ env.GHCR_SLUG }}:core 236 | docker pull ${{ env.GHCR_SLUG }}:extra 237 | docker pull ${{ env.GHCR_SLUG }}:core-audio 238 | docker pull ${{ env.GHCR_SLUG }}:extra-audio 239 | docker pull ${{ env.GHCR_SLUG }}:core-pylav 240 | docker pull ${{ env.GHCR_SLUG }}:extra-pylav 241 | docker image inspect ${{ env.GHCR_SLUG }}:core 242 | docker image inspect ${{ env.GHCR_SLUG }}:extra 243 | docker image inspect ${{ env.GHCR_SLUG }}:core-audio 244 | docker image inspect ${{ env.GHCR_SLUG }}:extra-audio 245 | docker image inspect ${{ env.GHCR_SLUG }}:core-pylav 246 | docker image inspect ${{ env.GHCR_SLUG }}:extra-pylav 247 | docker pull ${{ env.DOCK_SLUG }}:core 248 | docker pull ${{ env.DOCK_SLUG }}:extra 249 | docker pull ${{ env.DOCK_SLUG }}:core-audio 250 | docker pull ${{ env.DOCK_SLUG }}:extra-audio 251 | docker pull ${{ env.DOCK_SLUG }}:core-pylav 252 | docker pull ${{ env.DOCK_SLUG }}:extra-pylav 253 | docker image inspect ${{ env.DOCK_SLUG }}:core 254 | docker image inspect ${{ env.DOCK_SLUG }}:extra 255 | docker image inspect ${{ env.DOCK_SLUG }}:core-audio 256 | docker image inspect ${{ env.DOCK_SLUG }}:extra-audio 257 | docker image inspect ${{ env.DOCK_SLUG }}:core-pylav 258 | docker image inspect ${{ env.DOCK_SLUG }}:extra-pylav 259 | -------------------------------------------------------------------------------- /root/app/functions/pylav_setup.py: -------------------------------------------------------------------------------- 1 | import logging 2 | import pathlib 3 | import os 4 | import shutil 5 | import subprocess 6 | import sys 7 | import json 8 | from typing import Set, Dict, Union, Any 9 | 10 | RepoManagerSetting = pathlib.Path("/data/cogs/RepoManager/settings.json") 11 | DownloaderSetting = pathlib.Path("/data/cogs/Downloader/settings.json") 12 | DownloaderLibFolder = pathlib.Path("/data/cogs/Downloader/lib") 13 | RepoManagerRepoFolder = pathlib.Path("/data/cogs/RepoManager/repos/pylav") 14 | CogManagerCogFolder = pathlib.Path("/data/cogs/CogManager/cogs") 15 | CogRepoURL = "https://github.com/PyLav/Red-Cogs" 16 | DATA_FOLDER = pathlib.Path(os.environ.get("PYLAV__DATA_FOLDER", "/data/pylav")) 17 | PyLavHashFile = DATA_FOLDER / ".hashfile" 18 | 19 | logging.basicConfig(level=logging.INFO, format="%(asctime)s %(levelname)5s: %(message)s", datefmt="%Y-%m-%d %H:%M:%S") 20 | 21 | log = logging.getLogger("PyLavSetup") 22 | 23 | DEV_PYLAV = os.environ.get("PYLAV__DEV_LIB") 24 | DEV_PYLAV_COGS = os.environ.get("PYLAV__DEV_COG") 25 | DEV_BRANCH = os.environ.get("PYLAV__DEV_BRANCH", "develop") 26 | 27 | with pathlib.Path("/data/config.json").open("r", encoding="utf-8") as __f: 28 | IS_JSON = json.load(__f)["docker"]["STORAGE_TYPE"].upper() == "JSON" 29 | 30 | if not IS_JSON: 31 | RepoManagerRepoFolder = DATA_FOLDER / "git-cogs" 32 | 33 | 34 | def get_git_env() -> Dict[str, str]: 35 | env = os.environ.copy() 36 | env["GIT_TERMINAL_PROMPT"] = "0" 37 | env.pop("GIT_ASKPASS", None) 38 | env["LC_ALL"] = "C" 39 | env["LANGUAGE"] = "C" 40 | return env 41 | 42 | 43 | def create_or_update_repo_manager_setting() -> None: 44 | if not RepoManagerSetting.exists(): 45 | log.info("Creating RepoManager setting") 46 | with RepoManagerSetting.open("w", encoding="utf-8") as f: 47 | json.dump({"170708480": {"GLOBAL": {"repos": {"pylav": DEV_BRANCH}}}}, f) 48 | else: 49 | log.info("Updating RepoManager setting") 50 | with RepoManagerSetting.open("r", encoding="utf-8") as f: 51 | exiting_data = json.load(f) 52 | if "pylav" not in exiting_data["170708480"]["GLOBAL"]["repos"]: 53 | exiting_data["170708480"]["GLOBAL"]["repos"]["pylav"] = DEV_BRANCH 54 | with RepoManagerSetting.open("w", encoding="utf-8") as f: 55 | json.dump(exiting_data, f) 56 | 57 | 58 | def create_or_update_downloader_setting(data: Dict[str, Dict[str, Union[str, bool]]]) -> None: 59 | if not DownloaderSetting.exists(): 60 | log.info("Creating Downloader setting") 61 | with DownloaderSetting.open("w", encoding="utf-8") as f: 62 | json.dump({"998240343": {"GLOBAL": {"installed_cogs": {"pylav": data}}}}, f) 63 | else: 64 | log.info("Updating Downloader setting") 65 | with DownloaderSetting.open("r", encoding="utf-8") as f: 66 | exiting_data = json.load(f) 67 | exiting_data["998240343"]["GLOBAL"]["installed_cogs"]["pylav"] = data 68 | with DownloaderSetting.open("w", encoding="utf-8") as f: 69 | json.dump(exiting_data, f) 70 | 71 | 72 | def clone_or_update_pylav_repo() -> str: 73 | env = get_git_env() 74 | if (RepoManagerRepoFolder / ".git").exists(): 75 | log.info("Updating PyLav repo") 76 | subprocess.call(["git", "reset", "--hard", "HEAD", "-q"], cwd=RepoManagerRepoFolder, env=env) 77 | subprocess.call(["git", "clean", "-f", "-d", "-q"], cwd=RepoManagerRepoFolder, env=env) 78 | subprocess.call(["git", "checkout", DEV_BRANCH], cwd=RepoManagerRepoFolder, env=env) 79 | subprocess.call(["git", "pull", "-q", "--rebase", "--autostash"], cwd=RepoManagerRepoFolder, env=env) 80 | 81 | else: 82 | log.info("Cloning PyLav repo") 83 | subprocess.call(["git", "clone", CogRepoURL, RepoManagerRepoFolder], cwd=RepoManagerRepoFolder, env=env) 84 | subprocess.call(["git", "checkout", DEV_BRANCH], cwd=RepoManagerRepoFolder, env=env) 85 | return subprocess.check_output(["git", "rev-parse", "HEAD"], cwd=RepoManagerRepoFolder, env=env).decode().strip() 86 | 87 | 88 | def get_pylav_cogs() -> Dict[str, pathlib.Path]: 89 | return ( 90 | { 91 | cog.name: cog 92 | for cog in RepoManagerRepoFolder.iterdir() 93 | if cog.is_dir() and (cog.name.startswith("pl") or cog.name == "audio") 94 | } 95 | if not DEV_PYLAV_COGS 96 | else { 97 | cog.name: cog 98 | for cog in pathlib.Path(DEV_PYLAV_COGS).iterdir() 99 | if cog.is_dir() and (cog.name.startswith("pl") or cog.name == "audio") 100 | } 101 | ) 102 | 103 | 104 | def copy_and_overwrite(from_path: Union[str, os.PathLike[str]], to_path: Union[str, os.PathLike[str]], 105 | symlink: bool = False) -> None: 106 | if os.path.exists(to_path): 107 | if not os.path.islink(to_path): 108 | shutil.rmtree(to_path) 109 | else: 110 | os.unlink(to_path) 111 | if symlink: 112 | log.info("Symlinking %s to %s", from_path, to_path) 113 | os.symlink(from_path, to_path) 114 | else: 115 | log.info("Copying %s to %s", from_path, to_path) 116 | shutil.copytree(from_path, to_path) 117 | 118 | 119 | def install_or_update_pylav_cogs(cogs: Dict[str, pathlib.Path], symlink: bool = False) -> None: 120 | for cog in cogs.values(): 121 | copy_and_overwrite(cog, CogManagerCogFolder / cog.name, symlink=symlink) 122 | 123 | 124 | def get_requirements_for_all_cogs(cogs: Dict[str, pathlib.Path]) -> Set[str]: 125 | requirements = set() 126 | for cog in cogs.values(): 127 | if (cog / "info.json").exists(): 128 | with (cog / "info.json").open("r", encoding="utf-8") as f: 129 | data = json.load(f) 130 | if "requirements" in data: 131 | for req in data["requirements"]: 132 | if DEV_PYLAV and req.startswith("Py-Lav"): 133 | continue 134 | requirements.add(req) 135 | return requirements 136 | 137 | 138 | def install_requirements( 139 | cogs: Dict[str, pathlib.Path] 140 | ) -> tuple[ 141 | subprocess.Popen[str] | subprocess.Popen[str | bytes | Any] | None, 142 | subprocess.Popen[str] | subprocess.Popen[str | bytes | Any] | None, 143 | ]: 144 | proc = None 145 | proc2 = None 146 | if requirements := get_requirements_for_all_cogs(cogs): 147 | log.info("Installing requirements: %s", requirements) 148 | proc = subprocess.Popen( 149 | [ 150 | sys.executable, 151 | "-m", 152 | "pip", 153 | "install", 154 | "--upgrade", 155 | "--no-input", 156 | "--no-warn-conflicts", 157 | "--require-virtualenv", 158 | "--no-cache-dir", 159 | "--upgrade-strategy", 160 | "eager", 161 | *requirements, 162 | ], 163 | env=get_git_env(), 164 | stdout=subprocess.PIPE, 165 | universal_newlines=True, 166 | ) 167 | while True: 168 | line = proc.stdout.readline() 169 | if not line: 170 | break 171 | log.info(line.strip("\n")) 172 | if line.startswith("Successfully installed"): 173 | break 174 | 175 | if DEV_PYLAV: 176 | log.info("Installing editable PyLav") 177 | proc2 = subprocess.Popen( 178 | [ 179 | sys.executable, 180 | "-m", 181 | "pip", 182 | "install", 183 | "--upgrade", 184 | "--no-input", 185 | "--no-warn-conflicts", 186 | "--require-virtualenv", 187 | "--no-cache-dir", 188 | "--upgrade-strategy", 189 | "eager", 190 | "--editable", 191 | ".[all]", 192 | ], 193 | cwd=DEV_PYLAV, 194 | env=get_git_env(), 195 | stdout=subprocess.PIPE, 196 | universal_newlines=True, 197 | ) 198 | while True: 199 | line = proc2.stdout.readline() 200 | if not line: 201 | break 202 | log.info(line.strip("\n")) 203 | if line.startswith("Successfully installed"): 204 | break 205 | log.info("Requirements installed") 206 | return proc, proc2 207 | 208 | 209 | def generate_updated_downloader_setting( 210 | cogs: Dict[str, pathlib.Path], commit_hash: str 211 | ) -> Dict[str, Dict[str, Union[str, bool]]]: 212 | return { 213 | cog.name: { 214 | "repo_name": "pylav", 215 | "module_name": cog.name, 216 | "commit": commit_hash, 217 | "pinned": True, 218 | } 219 | for cog in cogs.values() 220 | } 221 | 222 | 223 | def get_existing_commit() -> str: 224 | if PyLavHashFile.exists(): 225 | with PyLavHashFile.open("r", encoding="utf-8") as f: 226 | return f.read() 227 | return "" 228 | 229 | 230 | def update_existing_commit(commit_hash: str) -> None: 231 | with PyLavHashFile.open("w", encoding="utf-8") as f: 232 | f.write(commit_hash) 233 | 234 | 235 | if __name__ == "__main__": 236 | if (PCX_DISCORDBOT_TAG := os.getenv("PCX_DISCORDBOT_TAG")) is None or "pylav" not in PCX_DISCORDBOT_TAG: 237 | # This script was called outside a docker container or the docker container is not a pylav image 238 | log.info("Skipping PyLav setup and update") 239 | sys.exit(0) 240 | for folder in (DATA_FOLDER, DownloaderLibFolder, RepoManagerRepoFolder, CogManagerCogFolder): 241 | if not folder.exists(): 242 | folder.mkdir(parents=True, mode=0o776) 243 | if not DEV_PYLAV_COGS: 244 | current_commit = clone_or_update_pylav_repo() 245 | existing_commit = get_existing_commit() 246 | else: 247 | current_commit = 1 248 | existing_commit = 0 249 | cogs_mapping = get_pylav_cogs() 250 | if current_commit == existing_commit: 251 | log.info("PyLav is up to date") 252 | sys.exit(0) 253 | else: 254 | install_or_update_pylav_cogs(cogs_mapping, symlink=bool(DEV_PYLAV_COGS)) 255 | process, process2 = install_requirements(cogs_mapping) 256 | try: 257 | log.info("Current PyLav-Cogs Commit: %s", current_commit) 258 | downloader_data = generate_updated_downloader_setting(cogs_mapping, current_commit) 259 | if IS_JSON: 260 | log.info("Updating Downloader Data: %s", downloader_data) 261 | create_or_update_downloader_setting(downloader_data) 262 | create_or_update_repo_manager_setting() 263 | if not DEV_PYLAV_COGS: 264 | update_existing_commit(current_commit) 265 | if process is not None: 266 | log.info("Waiting for requirements to finish installing") 267 | process.wait() 268 | if process2 is not None: 269 | log.info("Waiting for PyLav to finish installing") 270 | process2.wait() 271 | log.info("PyLav setup and update finished") 272 | except Exception as e: 273 | log.info("PyLav setup and update failed: %s", e, exc_info=e) 274 | finally: 275 | if process is not None: 276 | process.kill() 277 | process.terminate() 278 | if process2 is not None: 279 | process2.kill() 280 | process2.terminate() 281 | sys.exit(0) 282 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Red-DiscordBot V3 2 | The newest Red-DiscordBot in a convenient multi-arch container 3 | 4 | [![Docker Pulls](https://img.shields.io/docker/pulls/phasecorex/red-discordbot)](https://hub.docker.com/r/phasecorex/red-discordbot) 5 | [![Build Status](https://github.com/PhasecoreX/docker-red-discordbot/workflows/build/badge.svg)](https://github.com/PhasecoreX/docker-red-discordbot/actions?query=workflow%3Abuild) 6 | [![Chat Support](https://img.shields.io/discord/608057344487849989)](https://discord.gg/QzdPp2b) 7 | [![BuyMeACoffee](https://img.shields.io/badge/buy%20me%20a%20coffee-donate-orange)](https://buymeacoff.ee/phasecorex) 8 | [![PayPal](https://img.shields.io/badge/paypal-donate-blue)](https://paypal.me/pcx) 9 | 10 | ## Why This Image? 11 | 12 | There are many reasons that this image is better (or as good as) the others out there: 13 | 14 | - **Doesn't run as root**: You can specify exactly which user you want the bot to run and create files as. 15 | - **Easy to set up**: Just run one docker command and your new bot is ready to join your server. 16 | - **Always up-to-date**: The bot will always update itself to the latest PyPi release on every (re)start. 17 | - **Runs on most servers**: Can run on a normal x86-64 server, as well as arm(64) devices (Raspberry Pi). 18 | - **Update notifications**: Integrates with [UpdateNotify](https://github.com/PhasecoreX/PCXCogs) to notify you when there is a Red-DiscordBot or Docker image update ready. 19 | - **It's pretty small**: Image size has been reduced as much as possible, only including the bare minimum to run Red-DiscordBot as well as a vast majority of 3rd party cogs. 20 | 21 | ## Quick Start 22 | 23 | The basic run command looks like this: 24 | 25 | ``` 26 | docker run -v /local/folder/for/persistence:/data -e TOKEN=bot_token -e PREFIX=. phasecorex/red-discordbot 27 | ``` 28 | 29 | At minimum, you will need to replace the `/local/folder/for/persistence` as well as the `bot_token`. Red-DiscordBot will start up with the specified token and prefix, and after updating, it will show the invite URL. Use this to add the bot to your server. 30 | 31 | Here is an explanation of the command: 32 | 33 | - `-v /local/folder/for/persistence:/data`: Folder to persist Red-DiscordBot data. You could also use a named volume. 34 | - `-e TOKEN=bot_token`: The bot token you want Red-DiscordBot to use. 35 | - `-e PREFIX=.`: The prefix you want Red-DiscordBot to use. You can specify more than one prefix by additionally using the environment variables `PREFIX2`, `PREFIX3`, `PREFIX4`, and `PREFIX5`. 36 | 37 | Note: For the first run (with a new `/data` mount), the container might take a little bit longer to start while the Red-DiscordBot software is updated. Subsequent (re)starts will be pretty fast. 38 | 39 | Optional environment variables to make your life easier: 40 | 41 | - `-e TZ=America/Detroit`: Specify a timezone. By default, this is UTC. 42 | - `-e PUID=1000`: Specify the user Red-DiscordBot will run as. All files it creates will be owned by this user on the host. By default, this is 1000. 43 | - `-e PGID=1000`: Can also be specified if you want a specific group. By default, this is whatever PUID is set to (which by default, is 1000). 44 | 45 | Once you like how it's working, you can add these: 46 | 47 | - `--name red-discordbot`: A nice name for the docker container, for easy management. 48 | - `-d`: Run container in the background. The name set above comes in handy for managing it. 49 | 50 | You can also remove the `OWNER`, `TOKEN`, and `PREFIX`es after the initial run, as they are saved to the bots config. This allows for you to use the `[p]set prefix` command, and makes subsequent runs as simple as: 51 | 52 | ``` 53 | docker run -v /local/folder/for/persistence:/data phasecorex/red-discordbot 54 | ``` 55 | 56 | Enjoy! 57 | 58 | ### One Time Configurations 59 | 60 | A few of the environment variables can be used to configure Red-DiscordBot, but are persisted to the bots internal configuration. Thus, once they are used once, you are free to remove them from your Docker run command or Docker compose file. These are the environment variables: 61 | 62 | - `OWNER`: To set a new owner of the bot 63 | - `TOKEN`: To set a new token for the bot 64 | - `PREFIX` (as well as `PREFIX2`-`PREFIX5`): To set new prefixes for the bot 65 | 66 | If you see any of the following messages, you know that the setting were applied successfully, and you're free to remove the environment variable from your setup: 67 | 68 | ``` 69 | Setting bot owner... 70 | Setting bot token... 71 | Setting bot prefix(es)... 72 | ``` 73 | 74 | You can of course just leave the environment variables in place, but if you want a faster startup, you can remove the environment variables. 75 | 76 | ### Docker Compose 77 | 78 | As with any Docker run command, you can also specify it as a docker-compose.yml file for easier management. Here is an example: 79 | 80 | ```yaml 81 | version: "3.2" 82 | services: 83 | redbot: 84 | container_name: redbot 85 | image: phasecorex/red-discordbot 86 | restart: unless-stopped 87 | volumes: 88 | - ./redbot:/data 89 | environment: 90 | - TOKEN=your_bot_token_goes_here 91 | - PREFIX=. 92 | - TZ=America/Detroit 93 | - PUID=1000 94 | ``` 95 | 96 | And again, subsequent runs you can omit the `OWNER`, `TOKEN`, and `PREFIX`es from the docker-compose.yml file. 97 | 98 | ### Unraid 99 | 100 | This container can also be found in the Unraid Community Apps store. Search for and use "red-discordbot" made by [Selfhosters Unraid Discord Repository](https://unraid.net/community/apps?q=Selfhosters+Unraid+Discord+Repository&r=0#r). This is the one that I know works and that I support. 101 | 102 | ### Updates 103 | 104 | If you find out that Red-DiscordBot was updated, simply issue the `[p]restart` command. Red-DiscordBot will gracefully shut down, update itself, and then start back up. 105 | 106 | Consider using the [UpdateNotify](https://github.com/PhasecoreX/PCXCogs) cog I created to get notifications when Red-DiscordBot (or this Docker image) updates! 107 | 108 | #### Portainer Update Note 109 | 110 | If you are using Portainer to run this image and want to use my UpdateNotify cog, make sure you deploy using Portainers "Stacks" functionality, not from the "Containers" tab. If you deploy from the containers tab (pressing the "Add Container" button), the UpdateNotify cog will always tell you that there is an update, even when there isn't. More information can be found [here](https://github.com/PhasecoreX/docker-red-discordbot/issues/115). 111 | 112 | ## More Advanced Stuff 113 | 114 | ### Niceness 115 | 116 | By default, Red-DiscordBot (and the Lavalink audio server) will run at the niceness that Docker itself is running at (usually zero). If you would like to change that, simply define the `NICENESS` environment variable: 117 | 118 | - `NICENESS=10` 119 | 120 | Niceness has a range of -20 (highest priority, least nice to other processes) to 19 (lowest priority, very nice to other processes). Setting this to a value less than the default (higher priority) will require that you start the container with `--cap-add=SYS_NICE`. Setting it above the default will not need that capability set. If you are on a lower powered device or shared VPS that allows it, this option may help with audio stuttering when set to a lower (negative) value. 121 | 122 | Another potential solution to audio stuttering is to run the container in host networking mode. Docker does a bunch of network stack emulation for containers which, on a slow server, could affect realtime processes like audio. 123 | 124 | ### Dashboard (or other RPC software) 125 | 126 | Any software that needs to communicate to Red-DiscordBot via RPC can only do so when the container is running in host networking mode. Since the RPC port only listens on localhost (for security purposes), it would normally only be listening inside its own container. Setting the container to host networking mode allows for other software (running on the host) to connect successfully. 127 | 128 | ### redbot-setup 129 | 130 | `redbot-setup` can be run manually, in case you want to set up the bot yourself or to convert it's datastore. It can only be run in interactive mode, like so: 131 | 132 | ``` 133 | docker run -it --rm -v /local/folder/for/persistence:/data phasecorex/red-discordbot redbot-setup [OPTIONS] COMMAND [ARGS]... 134 | ``` 135 | 136 | By default, Red-DiscordBot will use the JSON datastore. If you would like to use a different datastore (Postgres for example), specify it in the `STORAGE_TYPE` environment variable: 137 | 138 | ``` 139 | docker run -it --rm -v /local/folder/for/persistence:/data -e STORAGE_TYPE=postgres phasecorex/red-discordbot redbot-setup [OPTIONS] COMMAND [ARGS]... 140 | ``` 141 | 142 | You can [check the official Red-DiscordBot documentation](https://docs.discord.red/en/latest/install_linux_mac.html#installing-red) to find out what datastores are available. The example on the page looks like this: 143 | 144 | ``` 145 | python -m pip install -U Red-DiscordBot[postgres] 146 | ^^^^^^^^ 147 | Set STORAGE_TYPE to this value 148 | ``` 149 | 150 | You can also do this on your first run if you want to set up the bot to use a non-JSON datastore right off the bat. Do note that you MUST use the instance name of `docker` for things to work properly. 151 | 152 | ### Migrating From a Non-Docker Environment 153 | 154 | Migrating to this container should be fairly easy. Simply copy your `cogs` and `core` folder into the `/data` folder that is to be mounted. 155 | 156 | If you were using a non-JSON datastore, you will need to copy your `config.json` file (usually found in `~/.config/Red-DiscordBot/config.json`) into the `/data` folder as well. You will then need update the file contents to look something like this: 157 | ``` 158 | { 159 | "docker": { <-- must be "docker" 160 | "DATA_PATH": "/data", <-- must be "/data" 161 | "COG_PATH_APPEND": "cogs", <-- must be "cogs" 162 | "CORE_PATH_APPEND": "core", <-- must be "core" 163 | "STORAGE_TYPE": "POSTGRES", <-- everything here and below you configured for your non-JSON datastore, so leave it alone 164 | "STORAGE_DETAILS": {} 165 | } 166 | } 167 | ``` 168 | The important part is that you make sure your instance name is "docker". This can either be done by using the `redbot --edit` command (from the un-migrated redbot) to rename the instance to "docker", or you can just modify the config.json file (like above) and manually name it. 169 | 170 | ### Version Freeze 171 | 172 | By default, Red-DiscordBot will check for updates on each (re)start of the container. If for some reason you want to have Red-DiscordBot stay at a certain version, you can use the `REDBOT_VERSION` environment variable to specify this. The format is the same as a [version specifier](https://www.python.org/dev/peps/pep-0440/#version-specifiers) for a pip package: 173 | 174 | - `REDBOT_VERSION="==3.5.0"`: Version Matching. Must be version 3.5.0 175 | - `REDBOT_VERSION="~=3.5.0"`: Compatible release. Same as >= 3.5.0, == 3.5.* 176 | 177 | ### Extra Arguments 178 | 179 | The environment variable `EXTRA_ARGS` can be used to append extra arguments to the bots startup command. This can be used for a plethora of things, such as: 180 | 181 | - `--no-cogs`: Starts Red with no cogs loaded, only core 182 | - `--dry-run`: Makes Red quit with code 0 just before the login. This is useful for testing the boot process. 183 | - `--debug`: Sets the loggers level as debug 184 | - And many other, more powerful arguments. 185 | 186 | When running directly from the terminal, specify multiple arguments at once by surrounding them all with double quotes: 187 | 188 | - `-e EXTRA_ARGS="--no-cogs --dry-run --debug"` 189 | 190 | If using a compose file, do not use quotes: 191 | 192 | ``` 193 | environment: 194 | TZ: America/Detroit 195 | PUID: 1000 196 | PREFIX: . 197 | EXTRA_ARGS: --no-cogs --dry-run --debug 198 | ``` 199 | or 200 | ``` 201 | environment: 202 | - TZ=America/Detroit 203 | - PUID=1000 204 | - PREFIX=. 205 | - EXTRA_ARGS=--no-cogs --dry-run --debug 206 | ``` 207 | 208 | The typical user will not need to use this environment variable. 209 | 210 | ### Custom Red-DiscordBot Package 211 | 212 | Intended for developers or users who know what they're doing, the `CUSTOM_REDBOT_PACKAGE` environment variable allows for specifying exactly what package pip should install. Specifying this environment variable will also ignore the `STORAGE_TYPE` and `REDBOT_VERSION` variables, as it's assumed you will provide any of that information in this environment variable. This can be useful for testing the bleeding edge Red-DiscordBot updates from GitHub: 213 | 214 | - `CUSTOM_REDBOT_PACKAGE=git+https://github.com/Cog-Creators/Red-DiscordBot.git` 215 | - `CUSTOM_REDBOT_PACKAGE=git+https://github.com/Cog-Creators/Red-DiscordBot.git@7d30e3de14264b86b5d18bac619ad476473d4467` 216 | 217 | The typical user SHOULD NOT use this. If you do use this environment variable, little to no support will be provided, as I assume you know what you are doing. If you want to switch back to a regular Red-DiscordBot install, you will need remove this environment variable, and you most likely will need to delete the `venv` folder inside the `/data` folder. If you don't, it may see that your custom version is newer than the PyPi official release, and it will not downgrade automatically. 218 | 219 | ## Extending This Image 220 | 221 | This image will run Red-DiscordBot as a non-root user. This is great, until you want to install any cogs that depend on external libraries or pip packages. To get around this, the image will run Red-DiscordBot in a python virtual environment. You can see this in the folder `/data/venv`. This allows for Red-DiscordBot to install any package it wants as the non-root user. This also allows for Red-DiscordBot to always be up-to-date when it first launches. 222 | 223 | Some pip packages will require external libraries, so some of the popular ones (the ones I need for my bot) are included in the `extra`/`extra-audio` tag. If you find that Red-DiscordBot cannot install a popular cog, you can either let me know for including the package in this tag, or you can extend this image, running `apt-get install -y --no-install-recommends` to install your dependencies: 224 | 225 | ```dockerfile 226 | FROM phasecorex/red-discordbot 227 | 228 | RUN apt-get update; \ 229 | apt-get install -y --no-install-recommends \ 230 | your \ 231 | extra \ 232 | packages \ 233 | here \ 234 | ; \ 235 | rm -rf /var/lib/apt/lists/*; 236 | ``` 237 | 238 | No need to define anything else, as the VOLUME and CMD will be the defaults. 239 | 240 | ## Image Tags 241 | 242 | ### core (Alias: noaudio) 243 | 244 | This tag contains the bare minimum to run Red-DiscordBot (no Java, so no Audio cog support). 245 | 246 | ### core-audio (Aliases: latest, audio) 247 | 248 | The default version. It's the same as core, but with Java included so that you can use the Audio cog. 249 | 250 | ### extra 251 | 252 | Same as core, but it has added packages that at least make these cogs work: 253 | 254 | - CrabRave 255 | - NotSoBot 256 | - ReTrigger (OCR feature) 257 | 258 | But remember, no Java, so no Audio cog support. 259 | 260 | ### extra-audio (Alias: full) 261 | 262 | Same as extra, but with Java included so that you can use the Audio cog. 263 | 264 | Basically, pick if you want bare minimum (core) or extra 3rd party cog support (extra), then add the "-audio" to the tag if you want the Audio cog to work. 265 | 266 | 267 | ### core-pylav (Alias: pylav, latest-pylav) 268 | Same as core, but it adds the [PyLav cogs](https://github.com/PyLav/Red-Cogs) to the bot for users using the JSON driver. 269 | 270 | > **Note** 271 | > If you are not using the JSON config driver with Red, PyLav Cogs can be loaded after running `[p]addpath /data/pylav/cogs` 272 | > If you use the JSON config driver, this image will automatically install the PyLav repo and cogs for you. 273 | > This image will always keep the PyLav dependencies and cog up to date on every restart. 274 | 275 | Make sure to read [pylav.yaml Setup (Docker)](https://github.com/PyLav/PyLav/blob/master/SETUP.md#pylavyaml-setup-docker) and [Docker Compose](https://github.com/PyLav/PyLav/blob/master/SETUP.md#with-docker) to see the mountable volumes, and environment variables. 276 | 277 | > **Warning** 278 | > PyLav requires a PostgresSQL Database to store its data, this is completely independent to Red's Postgres config driver. 279 | > PyLav requires adittional configuration not covered here, make sure to follow the instructions in its SETUP documentation. 280 | 281 | 282 | ### extra-pylav (Alias: full-pylav) 283 | Same as extra, but it adds the [PyLav cogs](https://github.com/PyLav/Red-Cogs) to the bot for users using the JSON driver. 284 | 285 | > **Note** 286 | > If you are not using the JSON config driver with Red, PyLav Cogs can be loaded after running `[p]addpath /data/pylav/cogs` 287 | > If you use the JSON config driver, this image will automatically install the PyLav repo and cogs for you. 288 | > This image will always keep the PyLav dependencies and cog up to date on every restart. 289 | 290 | Make sure to read [pylav.yaml Setup (Docker)](https://github.com/PyLav/PyLav/blob/master/SETUP.md#pylavyaml-setup-docker) and [Docker Compose](https://github.com/PyLav/PyLav/blob/master/SETUP.md#with-docker) to see the mountable volumes, and environment variables. 291 | 292 | > **Warning** 293 | > PyLav requires a PostgresSQL Database to store its data, this is completely independent to Red's Postgres config driver. 294 | > PyLav requires adittional configuration not covered here, make sure to follow the instructions in its SETUP documentation. 295 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------