Skip to content
This repository was archived by the owner on May 20, 2021. It is now read-only.
This repository was archived by the owner on May 20, 2021. It is now read-only.

Add documentation for Env files #193

@mind-overflow

Description

@mind-overflow

It took me a good two hours to figure this out.

When using docker, editing the .env file in the root directory is not sufficient.
For example, if you decide to use a database password that is different than changeme123, you need to also update it in:

  • docker/auth.env
  • docker/syncing-server-js.env

Also, there are multiple secret keys all around env files, which I have absolutely no clue about how they are connected together, and thus, where they should be the same and where they should be different. There is no documentation about those.
A few examples:

  • SECRET_KEY_BASE
  • PSEUDO_KEY_PARAMS_KEY
  • AUTH_JWT_SECRET
  • JWT_SECRET
  • USER_SERVER_AUTH_KEY

I know what a JWT is, and I can imagine what the "secret key base" is, but how am I supposed to understand what every one of those keys is used for, and where am I supposed to use it?

For the moment, I only had the audacity to change my db password, but I'm pretty sure leaving all those ones as change-me-! is not a great idea.

This is probably also an issue if you want to change the default port. Currently it's running on port 3000, but I saw that port in various files, including the docker-compose.yml one and many others. I won't even try changing it. Please, add some documentation.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions