Skip to content

Rework entrypoint to deprecate some variables #72

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Adam-Ant wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

Rework entrypoint to deprecate some variables #72

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
705af60
Initial pass of reworked entrypoint
Adam-Ant Apr 30, 2024
64053cf
Rework the deprecated logic
Adam-Ant Apr 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,9 @@ LABEL maintainer="Spritsail <[email protected]>" \

COPY --from=builder /output/ /

# Temporary to allow soft deprecation.
ENV NO_TXADMIN="DONTANSWERTHEPHONETOLESTERCREST"

WORKDIR /config
EXPOSE 30120

Expand Down
84 changes: 56 additions & 28 deletions entrypoint
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,42 +4,70 @@ if [ -n "$DEBUG" ]; then
set -x
fi

if ! find . -mindepth 1 | read -r; then
>&2 echo "Creating default configs..."
cp -r /opt/cfx-server-data/* /config
RCON_PASS="${RCON_PASSWORD-$(tr -dc 'a-zA-Z0-9' < /dev/urandom | head -c 16)}"
sed -i "s/{RCON_PASS}/${RCON_PASS}/g" /config/server.cfg;
>&2 echo "----------------------------------------------"
>&2 echo "RCON password is set to: ${RCON_PASS}"
>&2 echo "----------------------------------------------"
fi

if [ -z "$NO_ONESYNC" ]; then
ONESYNC_ARGS="+set onesync on +set onesync_population true"
fi

# Empty config args defaults to loading txAdmin
CONFIG_ARGS=
if [ -z "${NO_DEFAULT_CONFIG}" ]; then
CONFIG_ARGS="$CONFIG_ARGS $ONESYNC_ARGS +exec /config/server.cfg"
fi

# English is hard
if [ -z "${NO_LICENSE_KEY}${NO_LICENCE_KEY}" ]; then
if [ -z "${LICENSE_KEY}" ] && [ -n "${LICENCE_KEY}" ]; then
LICENSE_KEY="${LICENCE_KEY}"
# Temporary magic string during the transition - this way old configs still trigger the old (no txadmin by default) behaviour.
# This is set in the Docker file so it can be overridden - here for reference.
# NO_TXADMIN = "DONTANSWERTHEPHONETOLESTERCREST"

# If NO_TXADMIN is defined, configure the server as standalone.
if [ -n "${NO_TXADMIN}" ]; then
if ! find . -mindepth 1 | read -r; then
>&2 echo "Creating default configs..."
cp -r /opt/cfx-server-data/* /config
RCON_PASS="${RCON_PASSWORD-$(tr -dc 'a-zA-Z0-9' < /dev/urandom | head -c 16)}"
sed -i "s/{RCON_PASS}/${RCON_PASS}/g" /config/server.cfg;
>&2 echo "----------------------------------------------"
>&2 echo "RCON password is set to: ${RCON_PASS}"
>&2 echo "----------------------------------------------"
fi

if [ -z "${NO_DEFAULT_CONFIG}"] && [ -z "${LICENSE_KEY}" ]; then
>&2 printf "License key not found in environment, please create one at https://keymaster.fivem.net!\n"
exit 1
# If all these are true (& NO_TXADMIN above), CONFIG_ARGS will be empty, and txAdmin would start.
if [ -n "${NO_DEFAULT_CONFIG}" ] && [ -z "${$*}"]; then
if [ "${NO_TXADMIN}" != "DONTANSWERTHEPHONETOLESTERCREST" ]; then # Remove this if block when we remove the magic string - silly edge case!
>&2 printf "NO_DEFAULT_CONFIG specified, but no config args given. Server would load txAdmin anyway."
exit 1
fi
fi

if [ -z "${CONFIG_ARGS}" ] && [ -n "${LICENSE_KEY}" ] && [ -n "${NO_DEFAULT_CONFIG}" ]; then
>&2 printf "txadmin does not use the \$LICENSE_KEY environment variable.\nPlease remove it and set it through the txadmin web UI\n\n"
exit 1
# Set some default options.
if [ -z "${NO_DEFAULT_CONFIG}" ]; then
Copy link
Member

@frebib frebib Apr 30, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If NO_TXADMIN is set explicitly by the user, we shouldn't do this

CONFIG_ARGS="$CONFIG_ARGS $ONESYNC_ARGS +exec /config/server.cfg"
fi

CONFIG_ARGS="$CONFIG_ARGS +set sv_licenseKey ${LICENSE_KEY}"
# If it's set to the magic value, we can assume it's the deprecated logic. Do all the old things!
if [ "${NO_TXADMIN}" = "DONTANSWERTHEPHONETOLESTERCREST" ]; then
>&2 echo "------------------------------------------------------"
>&2 echo "WARNING - Default options will soon change to enabling"
>&2 echo "txAdmin by default. Set \$NO_TXADMIN to disable this."
>&2 echo "------------------------------------------------------"

# I pronounce everything below this point.. Deprecated!
if [ -z "$NO_ONESYNC" ]; then
ONESYNC_ARGS="+set onesync on +set onesync_population true"
>2& "Automaticly defined Onesync is deprecated. Please ensure 'onesync on' is set in your server.cfg"
fi

# English is hard
if [ -z "${NO_LICENSE_KEY}${NO_LICENCE_KEY}" ]; then
if [ -z "${LICENSE_KEY}" ] && [ -n "${LICENCE_KEY}" ]; then
LICENSE_KEY="${LICENCE_KEY}"
fi

if [ -z "${NO_DEFAULT_CONFIG}"] && [ -z "${LICENSE_KEY}" ]; then
>&2 printf "License key not found in environment, please create one at https://keymaster.fivem.net!\n"
exit 1
fi

if [ -z "${CONFIG_ARGS}" ] && [ -n "${LICENSE_KEY}" ] && [ -n "${NO_DEFAULT_CONFIG}" ]; then
>&2 printf "txAdmin does not use the \$LICENSE_KEY environment variable.\nPlease remove it and set it through the txadmin web UI\n\n"
exit 1
fi

CONFIG_ARGS="$CONFIG_ARGS +set sv_licenseKey ${LICENSE_KEY}"
fi
fi
fi

exec /opt/cfx-server/ld-musl-x86_64.so.1 \
Expand Down