standardnotes
Add documentation for Env files
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.envdocker/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_BASEPSEUDO_KEY_PARAMS_KEYAUTH_JWT_SECRETJWT_SECRETUSER_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.
@mind-overflow we are in the process of replacing Ruby based Syncing Server into a TS/JS based one. Withing the following days/weeks we should do the switch and put in a documentation that will make it easy to self-host our new setup.
Sorry for the current inconvenience and we hope you bare with us as we make this huge step forward :)
@mind-overflow we are in the process of replacing Ruby based Syncing Server into a TS/JS based one. Withing the following days/weeks we should do the switch and put in a documentation that will make it easy to self-host our new setup.
Sorry for the current inconvenience and we hope you bare with us as we make this huge step forward :)
@karolsojko This sounds awesome. Of course, I totally understand the inconvenience, and I look forward to the new version. I have also opened another issue about reverse proxies - do you believe it won't be a problem anymore, given the drastic changes to the codebase? (#194)
I'm a new user and the first self-hosting impact was not a spectacular one (due to the current transitioning state of the project), but I totally understand the particularity of this moment, and I will wait for the next update before trying again.
I would have appreciated a little banner in the readme thought, warning users about the upcoming changes 😂.
I would have appreciated a little banner in the readme thought, warning users about the upcoming changes 😂.
Sorry to hear that. I've made a PR based on your suggestion. Thanks for the feedback!
(@karolsojko will answer the question about reverse proxies 🙂)
