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 Docker Compose Dev Environment (#580) #584

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

Inventhrice
Copy link
Contributor

This is tackling issue #580, to update the docker compose development documentation to make it more reliable for people to use and set up.

Copy link
Collaborator

@MohamedBassem MohamedBassem left a comment

Choose a reason for hiding this comment

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

Hey, thanks for taking the time and porting back the changes to the repo. I wonder, if you've just used --build from the get go, would it have solved all your problems without the rest of the changes?

Comment on lines -66 to -68
volumes:
meilisearch:
data:
Copy link
Collaborator

Choose a reason for hiding this comment

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

Why though? Sounds easier to not have to mount a manual data dir?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is mostly up to preference, I would much rather prefer having the /data directory to be persistent so that I can modify the sqlite db in case it is needed


- Clone the repo and navigate to the root of the repo.
- Run `cp /docker/.env.sample /docker/.env`
- Make the necessary changes to the .env file (setting the DOCKER_DATA_DIR, NEXTAUTH_SECRET, and MEILI_MASTER_KEY)
Copy link
Collaborator

Choose a reason for hiding this comment

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

You don't really need to set nextauth_secret or even meili key during development. So I wouldn't worry too much about them

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Wouldn't it be a good idea to set it up anyways, just to make sure that any development does not break functionality offered by nextauth or meilisearch?

Copy link
Contributor

Choose a reason for hiding this comment

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

I am too prefer having nextauth and meilisearch being ready while developing

Copy link
Collaborator

Choose a reason for hiding this comment

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

Just to be clear. They will be ready and usable. The requirements of the variables being set are only when deployed to prod.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

oh gotcha because you want that stuff seeded with a random value

If the manual setup is too much hassle for you, you can use a docker based dev environment instead by following the instructions:

- Clone the repo and navigate to the root of the repo.
- Run `cp /docker/.env.sample /docker/.env`
Copy link
Collaborator

Choose a reason for hiding this comment

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

I don't think there's a need for an env file during development to be honest. Hoarder should work just fine without one.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This ties back into the above comment: "Wouldn't it be a good idea to set it up anyways, just to make sure that any development does not break functionality offered by nextauth or meilisearch?"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

coming back to this: wouldnt we need it for NEXTAUTH_URL and MEILISEARCH_URL?

@Inventhrice
Copy link
Contributor Author

@MohamedBassem Let me know if theres anything I can do to push this forward!

@CRYPTO-GENIK
Copy link

The env file interferes with several homelab server distros

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.

4 participants