Skip to content

Commit 363fd27

Browse files
committed
Include nav in mkdocs + fix typo in user_manual
1 parent 62cfe2f commit 363fd27

File tree

2 files changed

+22
-0
lines changed

2 files changed

+22
-0
lines changed

doc/user_manual.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Basic Workflow
2+
23
Basic workflow highlighting the main point. The goal is that with such workflow a new user is able to run a task on a new hashlist with files or with masks.
4+
35
- New Hashlist
46
- New Files, wordlist/rules/others
57
- New Task
@@ -13,7 +15,10 @@ Refer to the Hashcat documentation for detailed information on supported hash ty
1315
### Create a hashlist
1416
In the Hashtopolis web interface, navigate to *Lists > New Hashlist*. You will get the following window:
1517

18+
![screenshot_hashlist](https://upload.wikimedia.org/wikipedia/commons/8/80/Comingsoon.png?20120228065200)
19+
1620
Here is how to fill in the different fields:
21+
1722
1. **Name**: Provide a descriptive name for your hashlist.
1823
2. **Hash Type**: Select the appropriate hash type from the dropdown menu. Suggestions will appear as you enter text.
1924
3. **Hashlist Format**: Choose the format for your hashlist:
@@ -32,8 +37,10 @@ Here is how to fill in the different fields:
3237

3338
## Files: Rules, Wordlist and other
3439
When creating a password recovery task in Hashtopolis, you may need to upload additional files to the server, depending on the type of attack you want to perform. These files fall into three main categories:
40+
3541
1. **Rules**
3642
Rules files contain sets of instructions for dynamically modifying entries in a wordlist during an attack. By applying rules, you can generate variations of passwords without the need for additional wordlist files. For example, rules can:
43+
3744
- Append numbers or special characters.
3845
- Replace or capitalize specific characters.
3946
- Reverse words or combine entries.
@@ -48,6 +55,7 @@ When creating a password recovery task in Hashtopolis, you may need to upload ad
4855
Files can be uploaded to the Hashtopolis server from the Files page. To begin, select the appropriate file category by clicking on one of the tabs: Rules, Wordlists, or Other. The following figure illustrates the selection of the Rules category.
4956

5057
Once a category is selected, files can be added to the server using one of the following methods:
58+
5159
- **Upload from your computer** – Directly upload files stored on your local machine.
5260
- **Import from an import directory** – Use files that have been preloaded into the server’s import directory.
5361
- **Download from a URL** – Provide a URL to fetch files from an external source.
@@ -62,10 +70,12 @@ Detailed instructions for each upload method are provided in the following subse
6270

6371
### Import a new file
6472
When dealing with large files, such as wordlists, rules, or hashlists, you may encounter issues uploading them via the v1 of the Hashtopolis User Interface.. Common errors include exceeding the maximum upload size or experiencing a connection timeout. To bypass these limitations, you can use the import functionality of Hashtopolis.
73+
6574
- **Copy the file to the import folder**: Place the file in the designated import directory on the Hashtopolis server. If you are using the default Docker Compose setup, you can achieve this with the following command:
6675
```
6776
docker cp <dict> hashtopolis-backend:/usr/local/share/hashtopolis/import/
6877
```
78+
6979
- **Import the file**:
7080

7181
1. **Associated Access Group**: Define the access group that will have permissions to access the file(s) you are uploading.

mkdocs.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,18 @@ site_name: Hashtopolis
22
site_url: https://docs.hashtopolis.org
33
repo_url: https://github.com/hashtopolis/server
44
docs_dir: doc
5+
nav:
6+
- index.md
7+
- install.md
8+
- user_manual.md
9+
- advanced.md
10+
- changelog.md
11+
nav:
12+
- index.md
13+
- install.md
14+
- user_manual.md
15+
- advanced.md
16+
- changelog.md
517
theme:
618
name: material
719
logo: assets/images/logo.png

0 commit comments

Comments
 (0)