mirror of
https://github.com/karakeep-app/karakeep.git
synced 2025-12-12 20:35:52 +01:00
docs: replace hoarder with karakeep in CONTRIBUTING.md and FAQ (#1256)
* chore: replace hoarder in contributing * chore: replace hoarder with karakeep in faq
This commit is contained in:
@@ -1,4 +1,4 @@
|
||||
# Contributing to Hoarder
|
||||
# Contributing to Karakeep
|
||||
|
||||
First off, thank you for considering contributing to our project! This document outlines our contribution process and guidelines to make it easy for you to help improve this project.
|
||||
|
||||
@@ -39,8 +39,8 @@ Before starting to work on an issue:
|
||||
|
||||
* Prefer working on `status/approved` issues to make sure they get prioritized for the review
|
||||
* Comment on the issue to let others know you're working on it
|
||||
* Read the [development documentation](https://docs.hoarder.app/Development/setup) to get started
|
||||
* If you need help, you can find us in the #development channel in the [Hoarder Discord](https://discord.com/invite/NrgeYywsFh).
|
||||
* Read the [development documentation](https://docs.karakeep.app/Development/setup) to get started
|
||||
* If you need help, you can find us in the #development channel in the [Karakeep Discord](https://discord.com/invite/NrgeYywsFh).
|
||||
* Once you're done, open a PR and wait for review. Try to include a screenshot of the change in the PR description.
|
||||
|
||||
Please note that we're all volunteers. We'll aim to review your PR within a week from when they are opened.
|
||||
|
||||
@@ -24,7 +24,7 @@ To reset the password:
|
||||
* Acquire some kind of tools that helps you to connect to the database:
|
||||
* `sqlite3` on Linux: run `apt-get install sqlite3` (depending on your package manager)
|
||||
* e.g. `dbeaver` on Windows
|
||||
* Shut down hoarder
|
||||
* Shut down Karakeep
|
||||
* Connect to the `db.db` database, which is located in the `data` directory you have mounted to your docker container:
|
||||
* by e.g. running `sqlite3 db.db` (in your `data` directory)
|
||||
* or going through e.g. the `dbeaver` UI to locate the file in the data directory and connecting to it
|
||||
@@ -32,7 +32,7 @@ To reset the password:
|
||||
* `update user set password='$2a$10$5u40XUq/cD/TmLdCOyZ82ePENE6hpkbodJhsp7.e/BgZssUO5DDTa' where email='<YOUR_EMAIL_HERE>';`
|
||||
* (don't forget to put your email address into the command)
|
||||
* The new password for your user is now `adminadmin`.
|
||||
* Start hoarder again
|
||||
* Start Karakeep again
|
||||
* Log in with your email address and the password `adminadmin` and change the password to whatever you want in the `User Settings`
|
||||
|
||||
### Adding another administrator
|
||||
|
||||
Reference in New Issue
Block a user