Add a section in contributing guide describing owner user creation and reset #16006
Conversation
|
|
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
There was a problem hiding this comment.
cubic reviewed 1 file and found no issues. Review PR in cubic.dev.
CONTRIBUTING.md
Outdated
| If for any reason the credentials are lost before setting up password recovery, you can either remove the database file or run the following SQL command to reset the owner user: | ||
|
|
||
| ``` | ||
| update settings SET value='false' where key='userManagement.isInstanceOwnerSetUp'; |
There was a problem hiding this comment.
We would recommend using the server command over directly editing the database: https://docs.n8n.io/hosting/cli-commands/#user-management
There was a problem hiding this comment.
Replaced sql with ./packages/cli/bin/n8n user-management:reset
| @@ -169,6 +169,21 @@ To start n8n with tunnel: | |||
| ./packages/cli/bin/n8n start --tunnel | |||
| ``` | |||
|
|
|||
| ## First run | |||
|
|
|||
| The first time you run n8n locally you will be prompted to create an owner user. | |||
There was a problem hiding this comment.
Is this information really needed? it is the same as normally running n8n so this shouldn't be a surprise.
There was a problem hiding this comment.
It's definitely not a suprise during first run. It still adds some context for users that do need to reset the credentials (e.g. people that tried running n8n locally once or twice and return back to it a couple of weeks later). So, I'd say let's keep it but I am perfectly fine with removing it.
n8n-assistant
bot
added
community
|
Hey @iocanel, Thanks for the PR, We have created "GHC-2341" as the internal reference to get this reviewed. One of us will be in touch if there are any changes needed, in most cases this is normally within a couple of weeks but it depends on the current workload of the team. |
|
Hey @iocanel, Thanks for the PR, We have created "GHC-2342" as the internal reference to get this reviewed. One of us will be in touch if there are any changes needed, in most cases this is normally within a couple of weeks but it depends on the current workload of the team. |
iocanel
force-pushed
the
contributing-improvements
branch
from
2de44e0 to
071b346
Compare
|
@iocanel I will run this past the docs team and see what they think. |
Summary
The pull request introduces a section in the CONTRIBUTING.md that explain the process of owner user creation and reset.
Related Linear tickets, Github issues, and Community forum posts
Review / Merge checklist
release/backport(if the PR is an urgent fix that needs to be backported)