Hashtopolis

https://docs.hashtopolis.org
Admin
Hashtopolis is an open-source platform for distributing and managing password cracking tasks across...
Tokens:43,854
Snippets:324
Trust Score:6.4
Update:1 week ago
Show doc for...
Tokens:
Raw
### Agent startup prompt and API URL input

Source: https://docs.hashtopolis.org/installation_guidelines/basic_install

Shows the agent startup output and the prompt to enter the URL to the API of your Hashtopolis installation. The example uses http://localhost:8080/api/server.php.

```text
Starting client 's3-python-0.7.2.4'...
Please enter the url to the API of your Hashtopolis installation:
http://localhost:8080/api/server.php
```

--------------------------------

### Start local webserver with docker compose up --detach

Source: https://docs.hashtopolis.org/installation_guidelines/advanced_install

Starts the local webserver along with the regular Hashtopolis instance. After starting, place your binary ZIP files in the ./data folder and use the download URL format http://<hashtopolis-ip>:8081/<filename>.zip when registering a new binary in the UI.

```bash
docker compose up --detach
```

--------------------------------

### Download env.mysql.example

Source: https://docs.hashtopolis.org/installation_guidelines/update

Downloads the MySQL variant of the env file for the migration. This is required because pre-Docker installations use MySQL.

```bash
wget https://raw.githubusercontent.com/hashtopolis/server/master/env.mysql.example -O .env

```

--------------------------------

### Start the Hashtopolis agent

Source: https://docs.hashtopolis.org/installation_guidelines/basic_install

Starts the agent by running the downloaded hashtopolis.zip file with Python. The agent will prompt for the server API URL.

```bash
python hashtopolis.zip
```

--------------------------------

### Install required Python packages

Source: https://docs.hashtopolis.org/installation_guidelines/basic_install

Installs the requests and psutil packages, which are dependencies of the Hashtopolis agent. Run this after activating the virtual environment.

```bash
pip install requests psutil
```

--------------------------------

### Download docker-compose and env files for PostgreSQL offline installation

Source: https://docs.hashtopolis.org/installation_guidelines/advanced_install

Downloads the docker-compose.postgres.yml and env.postgres.example files from the Hashtopolis server repository, saving them as docker-compose.yml and .env respectively.

```bash
wget https://raw.githubusercontent.com/hashtopolis/server/master/docker-compose.postgres.yml -O docker-compose.yml
wget https://raw.githubusercontent.com/hashtopolis/server/master/env.postgres.example -O .env

```

--------------------------------

### Download docker-compose and env files for MySQL offline installation

Source: https://docs.hashtopolis.org/installation_guidelines/advanced_install

Downloads the docker-compose.mysql.yml and env.mysql.example files from the Hashtopolis server repository, saving them as docker-compose.yml and .env respectively.

```bash
wget https://raw.githubusercontent.com/hashtopolis/server/master/docker-compose.mysql.yml -O docker-compose.yml
wget https://raw.githubusercontent.com/hashtopolis/server/master/env.mysql.example -O .env

```

--------------------------------

### Start containers in foreground with docker compose up

Source: https://docs.hashtopolis.org/installation_guidelines/docker

Runs all containers in the foreground, showing logging output for debugging. Must be executed in the folder containing docker-compose.yml.

```bash
docker compose up

```

--------------------------------

### Start containers in background with docker compose up --detach

Source: https://docs.hashtopolis.org/installation_guidelines/docker

Starts all containers in the background, detaching from the terminal.

```bash
docker compose up --detach

```

--------------------------------

### Download MySQL docker-compose and env files

Source: https://docs.hashtopolis.org/installation_guidelines/basic_install

Downloads the MySQL docker-compose file as docker-compose.yml and the environment example as .env. Use this option if you choose MySQL as the database.

```bash
wget https://raw.githubusercontent.com/hashtopolis/server/master/docker-compose.mysql.yml -O docker-compose.yml
wget https://raw.githubusercontent.com/hashtopolis/server/master/env.mysql.example -O .env
```

--------------------------------

### Example PEPPER value from conf.php

Source: https://docs.hashtopolis.org/installation_guidelines/update

Shows the format of the PEPPER array in the old _inc/conf.php_ file. Copy this value to the new config.json.

```php
[...]
$PEPPER = [..., ..., ..., ...];
[...]

```

--------------------------------

### Download PostgreSQL docker-compose and env files

Source: https://docs.hashtopolis.org/installation_guidelines/basic_install

Downloads the PostgreSQL docker-compose file as docker-compose.yml and the environment example as .env. Use this option if you choose PostgreSQL as the database.

```bash
wget https://raw.githubusercontent.com/hashtopolis/server/master/docker-compose.postgres.yml -O docker-compose.yml wget https://raw.githubusercontent.com/hashtopolis/server/master/env.postgres.example -O .env
```

--------------------------------

### Example Output: ocean-night-theme CSS

Source: https://docs.hashtopolis.org/installation_guidelines/custom-themes

This is the kind of CSS structure the prompt should generate. It defines all required CSS variables for a dark theme with a blue/cyan palette.

```css
.ocean-night-theme {
  --background: #06131f;
  --muted: #0d1d2c;
  --well: #10263a;
  --card: rgba(255, 255, 255, 0.05);
  --card-hover: rgba(255, 255, 255, 0.09);
  --input: rgba(255, 255, 255, 0.06);
  --sidebar: #081520;

  --foreground: #e6f4ff;
  --muted-foreground: rgba(230, 244, 255, 0.75);
  --subtle-foreground: rgba(230, 244, 255, 0.55);
  --heading-foreground: #ffffff;

  --primary: #4db5ff;
  --primary-hover: #7ac8ff;
  --primary-muted: rgba(77, 181, 255, 0.2);
  --primary-foreground: #04111b;
  --secondary: #7df9ff;

  --border: rgba(77, 181, 255, 0.25);
  --border-strong: rgba(77, 181, 255, 0.45);
  --border-faint: rgba(77, 181, 255, 0.15);

  --surface-faint: rgba(255, 255, 255, 0.03);
  --surface-soft: rgba(255, 255, 255, 0.06);
  --surface-soft-hover: rgba(255, 255, 255, 0.1);

  --cell-hover: rgba(77, 181, 255, 0.16);

  --success: #76e39b;
  --warning: #ffd26a;
  --destructive: #ff7f96;
  --info: #7df9ff;
  --link: #7df9ff;
  --link-hover: #b7fdff;

  --success-bg: color-mix(in oklch, var(--success) 18%, var(--well));
  --destructive-bg: color-mix(in oklch, var(--destructive) 18%, var(--well));
  --info-bg: color-mix(in oklch, var(--info) 18%, var(--well));

  --header: rgba(6, 19, 31, 0.72);
  --shell-frame-image: linear-gradient(135deg, rgba(77, 181, 255, 0.18), rgba(125, 249, 255, 0.08));
  --brand-backdrop: #4db5ff;

  --shadow-sm: none;
  --shadow-md: 0 3px 12px rgba(3, 11, 20, 0.42);
  --shadow-lg: 0 10px 30px rgba(3, 11, 20, 0.58);

  --gradient-accent: linear-gradient(130deg, #4db5ff 0%, #7df9ff 100%);

  color-scheme: dark;
}

```

--------------------------------

### Agent registration with voucher

Source: https://docs.hashtopolis.org/installation_guidelines/basic_install

Shows the agent registration output when providing a voucher token. The example uses the voucher 'peKxylVY' and confirms successful registration and login.

```text
No token found! Please enter a voucher to register your agent:
peKxylVY
Successfully registered!
Collecting agent data...
Login successful!
```

--------------------------------

### Create and activate Python virtual environment

Source: https://docs.hashtopolis.org/installation_guidelines/basic_install

Creates a virtual environment named hashtopolis_env and activates it. This is recommended to avoid conflicts with system-wide packages when installing the required Python packages.

```bash
python3 -m venv hashtopolis_env
source hashtopolis_env/bin/activate
```

--------------------------------

### Load Docker images on offline server for MySQL installation

Source: https://docs.hashtopolis.org/installation_guidelines/advanced_install

After transferring the .tar archives, docker-compose.yml, and .env to the Hashtopolis server, import the images using docker load.

```bash
docker load --input hashtopolis-backend.tar
docker load --input hashtopolis-frontend.tar
docker load --input mysql.tar

```

--------------------------------

### Load Docker images on offline server for PostgreSQL installation

Source: https://docs.hashtopolis.org/installation_guidelines/advanced_install

After transferring the .tar archives, docker-compose.yml, and .env to the Hashtopolis server, import the images using docker load.

```bash
docker load --input hashtopolis-backend.tar
docker load --input hashtopolis-frontend.tar
docker load --input postgres.tar

```

--------------------------------

### Common Hashtopolis error: speed benchmark return code 255

Source: https://docs.hashtopolis.org/faq_tips/faq

This error indicates a misconfiguration in the Hashcat setup. To debug, stop the agent, restart it manually with --debug, look for a line starting with CALL: to see the exact Hashcat command, then navigate to the cracker binary directory.

```text
Error during speed benchmark, return code: 255 Output:

```

--------------------------------

### Copy and edit the environment file for the server

Source: https://docs.hashtopolis.org/installation_guidelines/advanced_install

Copies the env.example file to .env and opens it in the nano editor to modify values as needed before building the backend image.

```bash
cp env.example .env
nano .env

```

--------------------------------

### Check Python version

Source: https://docs.hashtopolis.org/installation_guidelines/basic_install

Verifies that Python 3 is installed on the agent system. Run this command in your terminal to confirm the installation.

```bash
python3 --version
```

--------------------------------

### Create Hashtopolis folder and navigate into it

Source: https://docs.hashtopolis.org/installation_guidelines/tls

Creates a folder for persistent Hashtopolis files and changes into it.

```bash
mkdir hashtopolis/
cd hashtopolis/

```

--------------------------------

### Custom nginx.conf for local webserver

Source: https://docs.hashtopolis.org/installation_guidelines/advanced_install

Place this nginx.conf in the same folder as your docker-compose.yml. It configures the webserver to serve files from /var/www/html on port 80. Adapt it to your setup; for SSL/TLS setups, use a separate nginx.conf.

```nginx
events {
    worker_connections 1024;
}

http {
    server {
            listen       80;
            listen  [::]:80;
            server_name  localhost;

            location / {
                root   /var/www/html;
                index  index.html index.htm;
            }
    }
}

```

--------------------------------

### Gmail ssmtp.conf example

Source: https://docs.hashtopolis.org/installation_guidelines/advanced_install

Example ssmtp.conf for using Gmail as the SMTP relay. Requires a Google App Password (not your normal Gmail password) and 2-Step Verification enabled. Uses port 587 with TLS and STARTTLS.

```plaintext
root=youraddress@gmail.com
mailhub=smtp.gmail.com:587
rewriteDomain=gmail.com
UseTLS=Yes
UseSTARTTLS=Yes
AuthUser=youraddress@gmail.com
AuthPass=your_16_char_google_app_password
AuthMethod=LOGIN
FromLineOverride=yes

```

--------------------------------

### systemd service file for Hashtopolis agent auto-start

Source: https://docs.hashtopolis.org/faq_tips/faq

Create this service file at /etc/systemd/system/hashtopolis-agent.service to run the agent on boot. Adjust the User and paths. After creating, run systemctl daemon-reload, systemctl enable hashtopolis-agent, and systemctl start hashtopolis-agent. Ensure config.json is set correctly before enabling.

```ini
[Unit]
Description=Hashtopolis Agent
After=network.target
StartLimitIntervalSec=0

[Service]
Type=simple
Restart=always
RestartSec=10
User=root
ExecStart=/usr/bin/python3 /root/agents/hashtopolis.zip
StandardInput=tty-force
WorkingDirectory=/root/agents/

[Install]
WantedBy=multi-user.target

```

--------------------------------

### Update containers with docker compose down, pull, up

Source: https://docs.hashtopolis.org/installation_guidelines/docker

Updates containers to the latest version by stopping, pulling new images, and starting again.

```bash
docker compose down
docker compose pull
docker compose up

```

--------------------------------

### Activate virtual environment for agent

Source: https://docs.hashtopolis.org/installation_guidelines/basic_install

Activates the previously created Python virtual environment before starting the agent. This is needed if the environment is not already active.

```bash
source hashtopolis_env/bin/activate
```

--------------------------------

### Build the Hashtopolis backend Docker image

Source: https://docs.hashtopolis.org/installation_guidelines/advanced_install

Builds the backend Docker image and tags it as hashtopolis/backend:latest using the target hashtopolis-server-prod.

```bash
docker build . -t hashtopolis/backend:latest --target hashtopolis-server-prod

```

--------------------------------

### Edit .env file with nano

Source: https://docs.hashtopolis.org/installation_guidelines/basic_install

Opens the .env file in the nano text editor to change settings to your liking. This is required before starting the containers.

```bash
nano .env
```

--------------------------------

### Build the Hashtopolis frontend Docker image

Source: https://docs.hashtopolis.org/installation_guidelines/advanced_install

Builds the frontend Docker image and tags it as hashtopolis/frontend:latest using the target hashtopolis-web-ui-prod.

```bash
docker build -t hashtopolis/frontend:latest --target hashtopolis-web-ui-prod .

```

--------------------------------

### Import database backup

Source: https://docs.hashtopolis.org/installation_guidelines/update

Imports the database backup into the hashtopolis database. You will be prompted for the MySQL password.

```bash
mysql -D hashtopolis -p < hashtopolis-backup.sql

```

--------------------------------

### Create database backup with mysqldump

Source: https://docs.hashtopolis.org/installation_guidelines/update

Creates a backup of the existing Hashtopolis database. Replace <database-name> with the actual database name.

```bash
mysqldump <database-name> > hashtopolis-backup.sql

```

--------------------------------

### Create and enter Hashtopolis folder

Source: https://docs.hashtopolis.org/installation_guidelines/basic_install

Creates a new directory named hashtopolis and changes into it. This is the first step before downloading the docker-compose configuration files.

```bash
mkdir hashtopolis
cd hashtopolis
```

--------------------------------

### Clone the Hashtopolis server repository

Source: https://docs.hashtopolis.org/installation_guidelines/advanced_install

Moves one directory back, clones the Hashtopolis server repository, and changes into the server directory. This is the first step to build the backend image.

```bash
cd ..
git clone https://github.com/hashtopolis/server.git
cd server

```
Tokens:
Raw