### Install BitComet DEB package

Source: https://wiki.bitcomet.com/bitcomet-installation-guide-for-linux

Use the apt package manager to install the downloaded BitComet DEB file.

```bash
sudo apt install ./BitComet-2.12.0-x86_64.deb
```

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

### Launch BitComet modes

Source: https://wiki.bitcomet.com/bitcomet-installation-guide-for-linux

Commands to start the BitComet GUI or the console mode with Web UI.

```bash
BitComet
```

```bash
bitcometd
```

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

### Run Docker Compose

Source: https://wiki.bitcomet.com/bitcomet-installation-guide-for-linux

Command to start the BitComet container defined in the docker-compose.yml file.

```bash
docker-compose -f docker-compose.yml up
```

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

### Configure Ubuntu 24.04+ APT Sources

Source: https://wiki.bitcomet.com/bitcomet-installation-guide-for-linux

Steps to add jammy sources to enable installation of legacy libwebkit2gtk libraries on newer Ubuntu versions.

```bash
sudo nano /etc/apt/sources.list.d/ubuntu.sources
# add "jammy" to the end of line "Suites: xxx xxx xxx"
# add "jammy-security" to the end of line "Suites: xxx-security"
# save and quit
sudo apt update
sudo apt install libwebkit2gtk-4.0-37
# revert apt sources if necessary
```

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

### Run BitComet via Docker CLI

Source: https://wiki.bitcomet.com/bitcomet-installation-guide-for-linux

Command to create and start a BitComet container with specific environment variables and volume mounts.

```bash
docker run -d   
--name=bitcomet   
-e BITCOMET_WEBUI_PORT=8080   
-e BITCOMET_BT_PORT=6082   
-e WEBUI_USERNAME=test   
-e WEBUI_PASSWORD=test   
-p 6080:8080   
-p 6882:6882   
-p 6882:6882/udp   
-v /docker/appdata/BitComet:/root/.config/BitComet:rw   
-v ~/Downloads:/root/Downloads:rw   
--restart unless-stopped   
wxhere/bitcomet-webui:latest
```

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

### GET /panel/option_set

Source: https://wiki.bitcomet.com/ajax-interface-for-remote-download

Updates specific BitComet configuration settings.

```APIDOC
## GET /panel/option_set

### Description
Updates a specific configuration option for BitComet.

### Method
GET

### Endpoint
/panel/option_set

### Parameters
#### Query Parameters
- **key** (string) - Required - The configuration key to update (e.g., down_rate_max, up_rate_max)
- **value** (string) - Required - The value to set for the specified key
```

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

### Register VLC Player Protocol via Batch

Source: https://wiki.bitcomet.com/webui-invoking-the-local-video-player

Use this script to register the vlc:// protocol. It automatically detects the VLC installation path from the registry and configures the command handler.

```batch
@echo off setlocal enabledelayedexpansion 
:: Check if the script is running with Administrator privileges fltmc >nul 2>&1 || ( echo ERROR: This script requires Administrator privileges! echo Please right-click and select "Run as administrator". pause exit /b 1 )
:: Find VLC installation directory for /f "tokens=1,2* delims=:" %%a in ( 'reg query "HKLM\SOFTWARE\VideoLAN\VLC" /v "" 2^>nul ^| findstr "(Default)"' ) do ( for /f "tokens=1,2,3" %%l in ("%%a") do ( set "player_disk=%%n" ) set "player_exe=!player_disk!:%%b" )
:: Verify vlc.exe exists if not exist "!player_exe!" ( echo VLC executable not found: !player_exe! pause exit /b 1 ) else ( echo Found VLC executable path: !player_exe! )
:: Start registering registry entries
:: Create vlc root key with default value reg add "HKCR\vlc" /ve /t REG_SZ /d "URL:VLC Protocol" /f >nul
:: Create URL Protocol entry (empty value) reg add "HKCR\vlc" /v "URL Protocol" /t REG_SZ /d "" /f >nul
:: Create shell\open\command entry with properly quoted executable path :: powershell -Command "$url = '%1' -replace '^vlc:_(http|https)_ ', '$1://' ; & "C:\Program Files\VideoLAN\VLC\vlc.exe" "$url"" reg add "HKCR\vlc\shell\open\command" /ve /t REG_SZ /d "powershell -Command "$url = '%%1' -replace '^vlc:_(http^|https)_ ', '$1://' ; ^& \"!player_exe!\" \"$url\""" /f >nul
:: Verify registration result if %errorlevel% equ 0 ( echo VLC protocol registered successfully! ) else ( echo Failed to write to registry. Please run this script as Administrator. pause exit /b 1 )
endlocal pause
```

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

### GET /panel/tasklist_action

Source: https://wiki.bitcomet.com/ajax-interface-for-remote-download

Performs bulk actions on the task list.

```APIDOC
## GET /panel/tasklist_action

### Description
Executes a bulk action on the task list, such as starting, stopping, or suspending tasks.

### Method
GET

### Endpoint
/panel/tasklist_action

### Parameters
#### Query Parameters
- **id** (string) - Required - The action identifier (e.g., start_all_download, start_all_seeding, stop_all, suspend_all)
```

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

### BitComet --url

Source: https://wiki.bitcomet.com/bitcomet-command-line

Initiates a download task from a provided URL.

```APIDOC
## BitComet --url

### Description
Downloads a file from a provided HTTP, HTTPS, FTP, or BC link.

### Parameters
- **--url** (string) - Required - The URL to download.
- **--silent** (flag) - Optional - Start task in silent mode without confirmation.
- **--paused** (flag) - Optional - Start task as paused (requires --silent).
- **--tray** (flag) - Optional - Minimize to system tray at start.
```

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

### GET /panel/task_list_xml

Source: https://wiki.bitcomet.com/ajax-interface-for-remote-download

Retrieves the current list of tasks in XML format.

```APIDOC
## GET /panel/task_list_xml

### Description
Retrieves the current list of tasks from BitComet in XML format.

### Method
GET

### Endpoint
/panel/task_list_xml
```

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

### Troubleshoot Missing Libraries

Source: https://wiki.bitcomet.com/bitcomet-installation-guide-for-linux

Commands to navigate directories and attempt to run the application when dependencies are missing.

```bash
cd <my directory>
```

```bash
./BitComet.AppImage
```

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

### GET /announce

Source: https://wiki.bitcomet.com/inside-bitcomet

The primary request sent from a BitComet client to a tracker to announce status and receive peer information.

```APIDOC
## GET /announce

### Description
Sends client status updates to the tracker and requests a list of available peers for a specific torrent.

### Method
GET

### Parameters
#### Query Parameters
- **info_hash** (string) - Required - 20-byte SHA1 hash of the info key from the Metainfo file.
- **peer_id** (string) - Required - 20-byte unique ID for the client.
- **port** (integer) - Required - The port number the client is listening on.
- **uploaded** (integer) - Required - Total bytes uploaded in base ten ASCII.
- **downloaded** (integer) - Required - Total bytes downloaded in base ten ASCII.
- **left** (integer) - Required - Bytes remaining to download in base ten ASCII.
- **no_peer_id** (boolean) - Optional - Indicates if the client accepts a response without peer_id.
- **compact** (boolean) - Optional - Indicates if the client accepts a compact peer list (6 bytes per peer).
- **event** (string) - Optional - Event type: 'started', 'stopped', or 'completed'.
- **numwant** (integer) - Optional - Number of peers requested.
- **key** (string) - Optional - Additional identification for identity verification.
- **localip** (string) - Optional - Internal IP address for subnet connectivity.
- **hide** (boolean) - Optional - If set to 1, requests the tracker not to share the client's IP with others.

### Response
#### Success Response (200)
- **interval** (integer) - Seconds to wait between regular requests.
- **peers** (string/list) - List of peers or compact string of peer data.
- **failure reason** (string) - Optional - Error message if the request failed.
- **tracker_alias_url** (list) - Optional - List of alias trackers.
```

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

### BitComet --make

Source: https://wiki.bitcomet.com/bitcomet-command-line

Creates a new torrent file from a specified source directory or file.

```APIDOC
## BitComet --make

### Description
Creates a new .torrent file from a source directory or file.

### Parameters
- **SOURCE** (string) - Required - Absolute path to the source directory or file.
- **--output** (string) - Optional - Absolute path for the generated .torrent file.
- **--silent** (flag) - Optional - Start task in silent mode without confirmation.
- **--tray** (flag) - Optional - Minimize to system tray at start.
```

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

### VNC Connection Details

Source: https://wiki.bitcomet.com/bitcomet-installation-guide-for-linux

Credentials and port information for connecting to the BitComet Docker GUI via VNC.

```text
port: 5900
username: sandbox
password: 123456
```

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

### BitComet <TORRENT_FILE>

Source: https://wiki.bitcomet.com/bitcomet-command-line

Opens an existing torrent file to initiate a download task.

```APIDOC
## BitComet <TORRENT_FILE>

### Description
Opens a .torrent file and adds it to the BitComet download queue.

### Parameters
- **TORRENT_FILE** (string) - Required - Path of the .torrent file.
- **--output** (string) - Optional - Absolute path of the download directory.
- **--silent** (flag) - Optional - Start task in silent mode without confirmation.
- **--paused** (flag) - Optional - Start task as paused (requires --silent).
- **--tray** (flag) - Optional - Minimize to system tray at start.
```