simjanos-dev / LinguaCafe

LinguaCafe is a self-hosted software that helps language learners read foreign languages.
https://simjanos-dev.github.io/LinguaCafeHome/
GNU General Public License v3.0
888 stars 32 forks source link

Add instructions on how to create .env files on macos, and maybe linux. #312

Open simjanos-dev opened 5 months ago

stereotypy commented 4 months ago

Hi, I would also like to see this. The env files created don't work out of the box and I'm not sure how to tweak them properly.

simjanos-dev commented 4 months ago

This is a note for myself, because someone had trouble creating the file itself with the correct name, regardless of its content.

What do you mean by env files created out of the box? There should be no env files created automatically.

stereotypy commented 4 months ago

Hi, I mean that I copied the sample env file and edited what I thought were the relevant fields and ran into issues. The docker compose relies on a few env fields being set. If you could just make it clear what the bare min env stuff I need to set without running into issues that would be great, it seems like a lot of the fields in the sample app are for features that may not be needed like AWS etc. I wonder if the sample file also had some other things that interfered somehow, there were a few things that were off like the app name being "Laravel".

simjanos-dev commented 4 months ago

You don't need a .env file, except if you have an Apple silicon Mac system, then you need the VERSION variable.

There is a step by step installation section in the readme on the main github page. If you get stuck at a step, or something is not clear I am happy to help.

The docker compose relies on a few env fields being set.

They have default values in the docker-compose.yml file.

stereotypy commented 4 months ago

Ok, when I had tried running it without the .env , something went wrong and complained about an env var not being set. It looks like you have fallbacks for most variables so could it be $MYSQL_ROOT_PASSWORD? In any case I'll have to go back to it and see exactly what happened. Sorry about that, I assumed it was my mistake given the type of error and that the sample env file was included. Should have just posted the error itself

simjanos-dev commented 4 months ago

I think the mysql root password message is just a warning on the terminal log, not an error.

Its okay, Ill try to help if I can.