Skip to content

Commit a086355

Browse files
committed
[skip ci] Password reset instructions added
1 parent 9562a04 commit a086355

File tree

1 file changed

+24
-1
lines changed

1 file changed

+24
-1
lines changed

README.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ export ROCKET_DATABASES='{rockpass = { url = "/location/of/rockpass.sqlite" }}'
132132
rockpass
133133
```
134134

135-
Finally if you want to execute the server witout database (for testing) you
135+
Finally if you want to execute the server without database (for testing) you
136136
can configure `url` as `:memory:`.
137137
```
138138
ROCKET_DATABASES='{rockpass = { url = ":memory:" }}' rockpass
@@ -142,6 +142,29 @@ ROCKET_DATABASES='{rockpass = { url = ":memory:" }}' rockpass
142142

143143
## Known limitations
144144

145+
### Password reset
146+
147+
With the premise in mind of keeping the code simple (remember that it is for
148+
personal use), Rockpass has not implemented any password reset API. But if
149+
any user does not remember their password you can reset it to a default
150+
value. For example, to reset the user _user@example.com_ password.
151+
152+
1. _Connect_ to database.
153+
```sh
154+
sqlite3 /location/of/rockpass.sqlite
155+
```
156+
2. Update password to a default `123456` value.
157+
```sql
158+
UPDATE users SET
159+
password='$2b$10$jJXcsuftQI9PwF8eqZo4/ObfBGbc.nhLBpV49fC4qeLLeh/Uz0YzW'
160+
WHERE email = 'user@example.com';
161+
```
162+
163+
Now you can login with your username `user@example.com` and `123456` as
164+
password. Don't forget to change it after login!
165+
166+
### Delete an user
167+
145168
For now, user deletion cannot be done via API. If you want to delete an user
146169
you can do it with `sqlite` command. For example to delete user
147170
_user@example.com_ and all of his/her passwords settings.

0 commit comments

Comments
 (0)