Docs improvments - typos, style edition, Mysql/postgreSQL homogeneity#2313
Open
coiseiw wants to merge 1 commit into
Open
Docs improvments - typos, style edition, Mysql/postgreSQL homogeneity#2313coiseiw wants to merge 1 commit into
coiseiw wants to merge 1 commit into
Conversation
coiseiw
commented
Jul 7, 2026
coiseiw
commented
Collaborator
- Remove internal draft notes that were published on the docs site
- Change the UI port: web UI on 4200, backend/API/legacy UI on 8080
- Split the offline installation into MySQL and PostgreSQL subsections and clarify docker-compose.yml naming
- Align the FAQ upgrade answer with the update guide;
- drop tips.md (duplicate of a FAQ entry)
- mkdocs.yml: fix broken edit links, move fonts in the right place, remove unused Redoc leftovers;
- add worked Wordlist/Rule bulk example
…e install - Remove internal draft notes that were published on the docs site (agents, tasks, hashlist, crackers_binary, settings, user-settings) - Document verified behavior: cracking position, Download Report (legacy UI only), agent binary fields and update tracks - Restore the import-from-server upload method (reintroduced in the new frontend) in files.md and hashlist.md - Fix the UI port story: web UI on 4200, backend/API/legacy UI on 8080 - Split the offline installation into MySQL and PostgreSQL subsections and clarify docker-compose.yml naming and the 8081 download server - Align the FAQ upgrade answer with the update guide; drop tips.md (verbatim duplicate of a FAQ entry) - mkdocs.yml: fix broken edit links, apply intended fonts, remove unused Redoc leftovers; add worked Wordlist/Rule bulk example - Copy-edit pass over all pages; turn TODO notes into a staged worklist Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
s3inlc
requested changes
Jul 9, 2026
|
|
||
| 1. Connect to the Hashtopolis server: ```http://<server-ip-address>:8080``` and log in. Navigate to the page *Agents > Show Agents* and click on the button *'+ New Agent'*. | ||
| 2. On that page you can click on "..." and choose to download the agent binary or copy the URL of the agent binary and download the agent using wget/curl: | ||
| 1. Connect to the Hashtopolis web UI: ```http://<server-ip-address>:4200``` and log in. Navigate to the page *Agents > Show Agents* and click on the button *'+ New Agent'*. |
Member
There was a problem hiding this comment.
In the menu on the new frontend it's named Agents Overview instead of Show Agents
|
|
||
| - **Agent**: A Hashtopolis client instance that performs password cracking using its available/associated hardware resources (e.g., GPUs and CPUs). | ||
| - **Hashlist**: A collection of hashes stored in the database. Hashlists are most commonly in TEXT, yet other formats like HCCAPX, or BINARY are also supported. | ||
| - **Hashlist**: A collection of hashes stored in the database. Hashlists are most commonly in TEXT, yet other formats like HCCAPX or BINARY are also supported. |
Member
There was a problem hiding this comment.
Support for HCCAPX and BINARY is deprecated and (I think) cannot even be used anymore in the new frontend and will be removed soon. So I would either state this here, or remove the other format part.
| - **Generate Wordlist**: This action generates a file listing all the recovered passwords from this hashlist. The file is automatically stored in the *wordlist* section of the *Files* section. The generated file can be easily retrieved as it is assigned the latest file ID. The filename is *Wordlist_[Hashlist_ID]_[dd.mm.yyyy]_[hh.mm.ss].txt*. | ||
|
|
||
| - **Export Hashes for pre-crack**: This action generates a file listing all the recovered passwords from this hashlist associated with the corresponding hash value in the format *[hash]:[plaintext]*. The file is automatically stored in the *wordlist* section of the *Files* section. The generated file can be easily retrieved as it got assigned to the latest file ID. The filename is *Pre-cracked_[Hashlist_ID]_[dd-mm-yyyy]_[hh-mm-ss].txt*. | ||
| - **Export Hashes for pre-crack**: This action generates a file listing all the recovered passwords from this hashlist associated with the corresponding hash value in the format *[hash]:[plaintext]*. The file is automatically stored in the *wordlist* section of the *Files* section. The generated file can be easily retrieved as it is assigned the latest file ID. The filename is *Pre-cracked_[Hashlist_ID]_[dd-mm-yyyy]_[hh-mm-ss].txt*. |
Member
There was a problem hiding this comment.
It's called Export Cracks now instead of Export Hashes for pre-crack (in the actions menu, and for consistency we will change it on the hashlist detail page as well). Also it gets put into the other section of files.
| - **Export Hashes for pre-crack**: This action generates a file listing all the recovered passwords from this hashlist associated with the corresponding hash value in the format *[hash]:[plaintext]*. The file is automatically stored in the *wordlist* section of the *Files* section. The generated file can be easily retrieved as it is assigned the latest file ID. The filename is *Pre-cracked_[Hashlist_ID]_[dd-mm-yyyy]_[hh-mm-ss].txt*. | ||
|
|
||
| - **Export Left Hashes**: This action generates a file listing all the hashes for which no password have been recovered at the moment of the file creation. The file is automatically stored in the *wordlist* section of the *Files* section. The generated file can be easily retrieved as it got assigned to the latest file ID. The filename is *Leftlist_[Hashlist_ID]_[dd-mm-yyyy]_[hh-mm-ss].txt*. | ||
| - **Export Left Hashes**: This action generates a file listing all the hashes for which no password has been recovered at the moment of the file creation. The file is automatically stored in the *wordlist* section of the *Files* section. The generated file can be easily retrieved as it is assigned the latest file ID. The filename is *Leftlist_[Hashlist_ID]_[dd-mm-yyyy]_[hh-mm-ss].txt*. |
Member
There was a problem hiding this comment.
It gets put into the other section of files.
| - **Export Left Hashes**: This action generates a file listing all the hashes for which no password has been recovered at the moment of the file creation. The file is automatically stored in the *wordlist* section of the *Files* section. The generated file can be easily retrieved as it is assigned the latest file ID. The filename is *Leftlist_[Hashlist_ID]_[dd-mm-yyyy]_[hh-mm-ss].txt*. | ||
|
|
||
| - **Import pre-cracked Hashes**: This action opens a new page in which the user can upload pre-cracked hashes for the related hashlist. A pre-crack is supposed to be a hash contained in the hashlist associated with a plaintext in the format *[hash]\(:[salt]\):[plaintext]*. Such data can be imported in different ways: *"Paste, Upload, Import, URL download"* such as the option to import the hashes during a hashlist creation. In case of salted password, the field separator must be indicated, ':' being the default one. When validating by pressing the *Pre-crack hashes* button, the back-end will check if the imported data contains hash values from the targeted hashlist and integrate the plaintext value accordingly. If the option *Overwrite already cracked hashes* is selected, existing recovered passwords will be overwritten by the new imported ones in case of conflict. The front-end is then reporting to the user how many hashes have been considered as well as how many entries have been updated. | ||
| - **Import pre-cracked Hashes**: This action opens a new page in which the user can upload pre-cracked hashes for the related hashlist. A pre-crack is supposed to be a hash contained in the hashlist associated with a plaintext in the format *[hash]\(:[salt]\):[plaintext]*. Such data can be imported in different ways — *"Paste, Upload, Import, URL download"* — similar to the options available during a hashlist creation. In case of salted passwords, the field separator must be indicated, ':' being the default one. When validating by pressing the *Pre-crack hashes* button, the back-end will check if the imported data contains hash values from the targeted hashlist and integrate the plaintext values accordingly. If the option *Overwrite already cracked hashes* is selected, existing recovered passwords will be overwritten by the newly imported ones in case of conflict. The front-end then reports to the user how many hashes have been considered as well as how many entries have been updated. |
Member
There was a problem hiding this comment.
It's called Import Cracks now instead of Import pre-cracked hashes (in the actions menu, and for consistency we will change it on the hashlist detail page as well).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.