docs: Adds documentation and updates motd.txt one last time (#16)

* t

* t

* c

* c

* Update hlds.txt

* Update Dockerfile

* Update Dockerfile

* Update hlds.txt

* Update hlds.txt

* Update publish.yml

* Update publish.yml

* Update publish.yml

* Update validate.yml

* Update pull-request-label.yml

* Update pull-request-label.yml

* fix: resolve publishing issues

* Delete pull-request-label.yml

* Update beta.yml

* Update beta.yml

* Update beta.yml

* Update Dockerfile

* Update Dockerfile

* feat: push to beta

* docs: add contribution guides

* Update Dockerfile

* build(deps): bump docker/build-push-action from 5 to 6 (#15)

Bumps [docker/build-push-action](https://github.com/docker/build-push-action) from 5 to 6.
- [Release notes](https://github.com/docker/build-push-action/releases)
- [Commits](docker/build-push-action@v5...v6)

---
updated-dependencies:
- dependency-name: docker/build-push-action
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* docs: add code of conduct and SECURITY.md

* docs: update to the correct link and use http versus https

* Update README.md

---------

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

.github/workflows/beta.yml

@@ -42,7 +42,7 @@ jobs:
           sed -i "s/\${GAME:-valve}/\${GAME:-${{ matrix.game }}}/g" entrypoint.sh
 
       - name: Build and Push Docker Image to DockerHub 🐳
-        uses: docker/build-push-action@v5
+        uses: docker/build-push-action@v6
         env:
           GAME: ${{ matrix.game }}
         with:
@@ -56,7 +56,7 @@ jobs:
         run: echo "::set-output name=repo_owner::$(echo ${{ github.repository_owner }} | awk '{print tolower($0)}')"
 
       - name: Build and Push Docker Image to GitHub Container Registry 🐳
-        uses: docker/build-push-action@v5
+        uses: docker/build-push-action@v6
         env:
           GAME: ${{ matrix.game }}
         with:

.github/workflows/publish.yml

@@ -61,7 +61,7 @@ jobs:
           sed -i "s/\${GAME:-valve}/\${GAME:-${{ matrix.game }}}/g" entrypoint.sh
 
       - name: Build and Push Docker Image to DockerHub 🐳
-        uses: docker/build-push-action@v5
+        uses: docker/build-push-action@v6
         env:
           GAME: ${{ matrix.game }}
         with:
@@ -77,7 +77,7 @@ jobs:
         run: echo "::set-output name=repo_owner::$(echo ${{ github.repository_owner }} | awk '{print tolower($0)}')"
 
       - name: Build and Push Docker Image to GitHub Container Registry 🐳
-        uses: docker/build-push-action@v5
+        uses: docker/build-push-action@v6
         env:
           GAME: ${{ matrix.game }}
         with:

.github/workflows/validate.yml

@@ -17,7 +17,7 @@ jobs:
         uses: docker/setup-buildx-action@v3
 
       - name: Build Docker Image 🐳
-        uses: docker/build-push-action@v5
+        uses: docker/build-push-action@v6
         env:
           GAME: cstrike
         with:

CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+https://jives.dev.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

@@ -0,0 +1,22 @@
+# Contributing ✨
+
+I appreciate your interest in contributing to this project. Please review the general process and scope before starting a contribution.
+
+## Scope 🔍
+
+The four main requirements for this project are:
+
+1. Start a Half-Life dedicated server easily with Docker.
+2. Have the ability for users to install custom plugins, maps and server configurations by providing a way to manipulate the server directory. Commonly used server plugins are intentionally not provided as a default, which is considered a user concern.
+3. Have the ability to run servers for custom mods.
+4. Only support legal usage of Steam and Valve's titles. **It will not, and never will, support the ability to circumvent any licensing or other restrictions Valve imposes.** The project maintainers will report any shady behaviour to Valve and GitHub.
+
+## Process ✈️
+
+1. File an issue on the [Issues board](https://github.com/JamesIves/hlds-docker/issues), or create a discussion on the [Discussions board](https://github.com/JamesIves/hlds-docker/discussions).
+2. Once discussed and agreed upon, clone the project.
+3. Make your changes.
+4. Validate your changes; at the very least, please build the image and start a server.
+5. Submit a pull request to the `beta` branch.
+6. Once reviewed, your changes will be made available on DockerHub via the `-beta` tag, for example `jives/hlds:cstrike-beta`.
+7. After some more tests, changes will be made sent to the `main` branch where the production images will be published.

Dockerfile

@@ -32,6 +32,7 @@ RUN curl -v -sL media.steampowered.com/client/installer/steamcmd_linux.tar.gz |
     file /opt/steam/linux32/steamcmd && \
     ./steamcmd.sh +runscript /opt/steam/hlds.txt
 
+# Writes the steam_appid.txt file to the hlds directory with the title id for Half-Life.
 RUN mkdir -p $HOME/.steam \
     && ln -s /opt/steam/linux32 $HOME/.steam/sdk32 \
     && echo 70 > /opt/steam/hlds/steam_appid.txt

README.md

@@ -1,4 +1,4 @@
-# Half-Life Dedicated Server With Docker 🐋
+# Half-Life Dedicated Server With Docker 🐋 📦
 
 <img align="right" width="120" height="auto"  src="./.github/docs/crowbar.png" alt="Crowbar">
 

SECURITY.md

@@ -0,0 +1,5 @@
+# Security Policy
+
+## Reporting a Vulnerability
+
+Please report any [security related concerns as an issue here](https://github.com/JamesIves/hlds-docker/security/advisories/new).

config/motd.txt

@@ -12,6 +12,9 @@
         margin-left: 8px;
         margin-top: 0px;
       }
+      img {
+        margin-top: 8px;
+      }
       a {
         text-decoration: underline;
       }
@@ -33,5 +36,6 @@
   <body>
     <p>Welcome to the server!</p>
     <p>This server was built with <a href="https://github.com/JamesIves/hlds-docker">hlds-docker on GitHub</a></p>
+    <img src="http://jives.dev/icon.png" alt="Jives" />
   </body>
 </html>

config/server.cfg

@@ -1,5 +1,2 @@
-// Defines the default configuration for the server
-// This file is executed automatically when the server starts
-// Docs: https://developer.valvesoftware.com/
-
-hostname "Half-Life Dedicated Server"
+hostname "Half-Life Dedicated Server"
+sv_contact "https://github.com/JamesIves/hlds-docker/issues"