Installation and configurations docs

[josecelano]

Move installation and configuration docs to Rust Documentation Comments.

[josecelano]

hi @WarmBeer I do not know where the env var DATABASE_URL is used:

DATABASE_URL=sqlite://storage/database/data.db?mode=rwc

The current installation guide:

cd backend
echo "DATABASE_URL=sqlite://data.db?mode=rwc" > .env

says you have to run that. I think the .env is only used when you used docker.

Is it something that maybe you were using for the database tests and it's not used anymore?

[josecelano]

hi @WarmBeer I do not know where the env var DATABASE_URL is used:

DATABASE_URL=sqlite://storage/database/data.db?mode=rwc

The current installation guide:

cd backend
echo "DATABASE_URL=sqlite://data.db?mode=rwc" > .env

says you have to run that. I think the .env is only used when you used docker.

Is it something that maybe you were using for the database tests and it's not used anymore?

Hey, I've just seen it's used by sqlx.

https://github.com/launchbadge/sqlx

It's a little bit confusing that the same file is used by docker-compose and sqlx but for the time being I'm just going to explain it in the documentation.

[josecelano]

Hi @WarmBeer I think we should move another config option:

[auth]
email_on_signup = "Optional"
min_password_length = 6
max_password_length = 64
secret_key = "MaxVerstappenWC2021"

...

[mail]
email_verification_enabled = false
from = "[email protected]"
reply_to = "[email protected]"
username = ""
password = ""
server = ""
port = 25

I think w should move the email_verification_enabled from [mail] to [auth]`. If you agree I'll open a new issue.