Skip to content
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.

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

- Update the way env variables are managed #201

Merged
merged 7 commits into from
Jan 29, 2024
Merged

- Update the way env variables are managed #201

merged 7 commits into from
Jan 29, 2024

Conversation

Filipe-Souza
Copy link
Contributor

Context

  • The easer option is to give the user a "config file", in this case a .env.example file and get it to be modified;
  • The goal is avoid the hassle with copy/pasting commands with wrong formatting, different values and different OS;

Choices

  • Environment variables files are a common practice in programming environment, it's easier on users to manage and find what they need, and provide us a source of truth to solve problems;

Test instructions

  1. Follow up the README instructions to how to set-up with docker run and docker-compose;

Checklist before requesting a review

  • I have performed a self-review of my code
  • I've added documentation about this change to the README.

634349

- Now a env-file is present to make setup more clean to execute;
- Added the grace period to the docker run command;
- Updated the docs to reflect this new suggestions;
Copy link
Owner

@thijsvanloef thijsvanloef left a comment

Choose a reason for hiding this comment

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

While I agree that this makes it a lot easier, my thought process is that the majority does not clone this entire repo but instead just pulls the image from docker hub.

I would like to include the .env.example in the repo, but not change the docker-compose.yml examples. But instead create a disclaimer in the "How to deploy - Docker Compose" heading saying that this can also be managed using an .env file

@Filipe-Souza
Copy link
Contributor Author

Makes sense, I'm going to update the PR

Copy link
Owner

@thijsvanloef thijsvanloef left a comment

Choose a reason for hiding this comment

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

looks great, thank you!

@thijsvanloef thijsvanloef merged commit b8ad488 into thijsvanloef:main Jan 29, 2024
4 checks passed
MusclePr pushed a commit to MusclePr/palworld-server-docker that referenced this pull request Jun 19, 2024
…iles

- Update the way env variables are managed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants