Corrected License; Added Env Configs; (Renegade-Master#13)

* Corrected License; Added Env Configs;

- .github/workflows/docker-build.yml
- LICENSE
- docker/zomboid-dedicated-server.Dockerfile
- src/install_server.scmd
- src/run_server.sh
  - Clarified source License. License unchanged from GPL v3.

- README.md
- docker-compose.yaml
  - Clarified source License. License unchanged from GPL v3.
  - Added info for new `chown` related config options.

.github/workflows/docker-build.yml

@@ -1,3 +1,21 @@
+#
+#   Project Zomboid Dedicated Server using SteamCMD Docker Image.
+#   Copyright (C) 2021-2022 Renegade-Master [[email protected]]
+#
+#   This program is free software: you can redistribute it and/or modify
+#   it under the terms of the GNU General Public License as published by
+#   the Free Software Foundation, either version 3 of the License, or
+#   (at your option) any later version.
+#
+#   This program is distributed in the hope that it will be useful,
+#   but WITHOUT ANY WARRANTY; without even the implied warranty of
+#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#   GNU General Public License for more details.
+#
+#   You should have received a copy of the GNU General Public License
+#   along with this program.  If not, see <https://www.gnu.org/licenses/>.
+#
+
 name: Build and Test Server Image
 
 on:

LICENSE

@@ -1,6 +1,9 @@
                     GNU GENERAL PUBLIC LICENSE
                        Version 3, 29 June 2007
 
+ Project Zomboid Dedicated Server using SteamCMD Docker Image.
+ Copyright (C) 2021-2022 Renegade-Master [[email protected]]
+
  Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
  Everyone is permitted to copy and distribute verbatim copies
  of this license document, but changing it is not allowed.
@@ -631,8 +634,8 @@ to attach them to the start of each source file to most effectively
 state the exclusion of warranty; and each file should have at least
 the "copyright" line and a pointer to where the full notice is found.
 
-    <one line to give the program's name and a brief idea of what it does.>
-    Copyright (C) <year>  <name of author>
+    Project Zomboid Dedicated Server using SteamCMD Docker Image.
+    Copyright (C) 2021-2022 Renegade-Master [[email protected]]
 
     This program is free software: you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
@@ -652,7 +655,9 @@ Also add information on how to contact you by electronic and paper mail.
   If the program does terminal interaction, make it output a short
 notice like this when it starts in an interactive mode:
 
-    <program>  Copyright (C) <year>  <name of author>
+    Project Zomboid Dedicated Server using SteamCMD Docker Image.
+    Copyright (C) 2021-2022 Renegade-Master [[email protected]]
+
     This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
     This is free software, and you are welcome to redistribute it
     under certain conditions; type `show c' for details.

README.md

@@ -52,15 +52,15 @@ recommended.
 | `MAX_RAM`             | Maximum amount of RAM to be used                                         | ([0-9]+)m         | 4096m         |
 | `MOD_NAMES`           | Workshop Mod Names (e.g. ClaimNonResidential;MoreDescriptionForTraits)   | mod1;mod2;mod     |               |
 | `MOD_WORKSHOP_IDS`    | Workshop Mod IDs (e.g. 2160432461;2685168362)                            | xxxxxx;xxxxx;     |               |
+| `NO_CHOWN_CONFIG_DIR` | Disables automatic filesystem permissions management on config directory | (true|false) | false         |
+| `NO_CHOWN_GAME_DIR`   | Disables automatic filesystem permissions management on game directory   | (true|false) | false         |
 | `PAUSE_ON_EMPTY`      | Pause the Server when no Players are connected                           | (true|false) | true          |
 | `PUBLIC_SERVER`       | Is the server displayed Publicly                                         | (true|false) | true          |
 | `QUERY_PORT`          | Port for other players to connect to                                     | 1000 - 65535      | 16261         |
 | `SERVER_NAME`         | Publicly visible Server Name                                             | [a-zA-Z0-9]+      | ZomboidServer |
 | `SERVER_PASSWORD`     | Server password                                                          | [a-zA-Z0-9]+      |               |
 | `STEAM_VAC`           | Use Steam VAC anti-cheat                                                 | (true|false) | true          |
 | `USE_STEAM`           | Create a Steam Server, or a Non-Steam Server                             | (true|false) | true          |
-| `NO_CHOWN_GAME_DIR`   | Disables automatic filesystem permissions management on game directory   | (true|false) | false          |
-| `NO_CHOWN_CONFIG_DIR` | Disables automatic filesystem permissions management on config directory | (true|false) | false          |
 
 ### Docker
 
@@ -105,6 +105,8 @@ The following are instructions for running the server using the Docker image.
        [--env=MAX_RAM=<value>] \
        [--env=MOD_NAMES=<value>] \
        [--env=MOD_WORKSHOP_IDS=<value>] \
+       [--env=NO_CHOWN_CONFIG_DIR=<value>] \
+       [--env=NO_CHOWN_GAME_DIR=<value>] \
        [--env=PAUSE_ON_EMPTY=<value>] \
        [--env=PUBLIC_SERVER=<value>] \
        [--env=QUERY_PORT=<value>] \

docker-compose.yaml

@@ -1,4 +1,22 @@
-version: "3.6"
+#
+#  Project Zomboid Dedicated Server using SteamCMD Docker Image.
+#  Copyright (C) 2021-2022 Renegade-Master [[email protected]]
+#
+#  This program is free software: you can redistribute it and/or modify
+#  it under the terms of the GNU General Public License as published by
+#  the Free Software Foundation, either version 3 of the License, or
+#  (at your option) any later version.
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License
+#  along with this program.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+version: "3.8"
 
 services:
   zomboid-server:
@@ -21,6 +39,8 @@ services:
       - "MAX_RAM=4096m"
       - "MOD_NAMES="
       - "MOD_WORKSHOP_IDS="
+      - "NO_CHOWN_CONFIG_DIR=false"
+      - "NO_CHOWN_GAME_DIR=false"
       - "PAUSE_ON_EMPTY=true"
       - "PUBLIC_SERVER=true"
       - "QUERY_PORT=16261"

docker/zomboid-dedicated-server.Dockerfile

@@ -1,3 +1,19 @@
+#   Project Zomboid Dedicated Server using SteamCMD Docker Image.
+#   Copyright (C) 2021-2022 Renegade-Master [[email protected]]
+#
+#   This program is free software: you can redistribute it and/or modify
+#   it under the terms of the GNU General Public License as published by
+#   the Free Software Foundation, either version 3 of the License, or
+#   (at your option) any later version.
+#
+#   This program is distributed in the hope that it will be useful,
+#   but WITHOUT ANY WARRANTY; without even the implied warranty of
+#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#   GNU General Public License for more details.
+#
+#   You should have received a copy of the GNU General Public License
+#   along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
 #######################################################################
 #   Author: Renegade-Master
 #   Description: Base image for running a Dedicated Project Zomboid
@@ -15,7 +31,7 @@ ARG GROUP_ID
 
 # Add metadata labels
 LABEL com.renegademaster.zomboid-dedicated-server.authors="Renegade-Master" \
-    com.renegademaster.zomboid-dedicated-server.contributors="JohnEarle" \
+    com.renegademaster.zomboid-dedicated-server.contributors="JohnEarle, ramielrowe" \
     com.renegademaster.zomboid-dedicated-server.source-repository="https://github.com/Renegade-Master/zomboid-dedicated-server" \
     com.renegademaster.zomboid-dedicated-server.image-repository="https://hub.docker.com/renegademaster/zomboid-dedicated-server"
 

src/install_server.scmd

@@ -1,5 +1,8 @@
 ///////////////////////////////////////////////////////////////////////
-// SteamCMD installation script for Project Zomboid Dedicated Server
+// Author: Renegade-Master
+// Description: SteamCMD installation script for Project Zomboid
+//   Dedicated Server
+// License: GNU General Public License v3.0 (see LICENSE)
 ///////////////////////////////////////////////////////////////////////
 
 // Do not shutdown on a failed command

src/run_server.sh

@@ -1,13 +1,32 @@
 #!/usr/bin/env bash
+
+#
+#  Project Zomboid Dedicated Server using SteamCMD Docker Image.
+#  Copyright (C) 2021-2022 Renegade-Master [[email protected]]
+#
+#  This program is free software: you can redistribute it and/or modify
+#  it under the terms of the GNU General Public License as published by
+#  the Free Software Foundation, either version 3 of the License, or
+#  (at your option) any later version.
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License
+#  along with this program.  If not, see <https://www.gnu.org/licenses/>.
+#
+
 #######################################################################
 #   Author: Renegade-Master
-#   Contributors: JohnEarle
+#   Contributors: JohnEarle, ramielrowe
 #   Description: Install, update, and start a Dedicated Project Zomboid
 #       instance.
 #######################################################################
 
 # Set to `-x` for Debug logging
-set +x
+set +x -o pipefail
 
 # Start the Server
 function start_server() {