Komga

https://komga.org/docs/
Admin
Komga is a media server for organizing and streaming comics, mangas, BDs, magazines, and eBooks with...
Tokens:99,383
Snippets:890
Trust Score:8.4
Update:2 months ago
Show doc for...
Tokens:
Raw
### CURL Request Example

Source: https://komga.org/docs/openapi/get-book-web-pub-manifest-epub

Example command to fetch the manifest using curl.

```bash
curl -L 'https://demo.komga.org/api/v1/books/:bookId/manifest/epub' \
-H 'Accept: application/json' \
-H 'Authorization: Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+'
```

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

### CURL request example

Source: https://komga.org/docs/openapi/get-libraries

Example command to fetch libraries using basic authentication.

```bash
curl -L 'https://demo.komga.org/api/v1/libraries' \
-H 'Accept: application/json' \
-H 'Authorization: Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+'
```

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

### CURL Request Example

Source: https://komga.org/docs/openapi/get-directory-listing

Example of how to call the filesystem endpoint using curl.

```bash
curl -L 'https://demo.komga.org/api/v1/filesystem' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+' \
-d '{
  "path": "string",
  "showFiles": true
}'
```

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

### CURL Request Example

Source: https://komga.org/docs/openapi/get-unknown-page-hash-thumbnail

Example command to fetch the thumbnail using basic authentication.

```bash
curl -L 'https://demo.komga.org/api/v1/page-hashes/unknown/:pageHash/thumbnail' \
-H 'Authorization: Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+'
```

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

### Install Komga from Helm repository

Source: https://komga.org/docs/installation/thirdparty/helm

Adds the HelmForge repository and installs the Komga chart.

```bash
helm repo add helmforge https://repo.helmforge.dev  

helm repo update  

helm install komga helmforge/komga  
```

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

### CURL Request Example

Source: https://komga.org/docs/openapi/get-book-epub-resource

Example command to fetch an Epub resource using curl.

```bash
curl -L 'https://demo.komga.org/api/v1/books/:bookId/resource/:resource' \
-H 'Accept: */*'
```

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

### CURL request example

Source: https://komga.org/docs/openapi/get-book-progression

Example command to perform the GET request using cURL with basic authentication.

```bash
curl -L 'https://demo.komga.org/api/v1/books/:bookId/progression' \
-H 'Accept: application/json' \
-H 'Authorization: Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+'
```

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

### CURL Request Example

Source: https://komga.org/docs/openapi/get-books-on-deck

Example command to fetch books on deck using basic authentication.

```bash
curl -L 'https://demo.komga.org/api/v1/books/ondeck' \
-H 'Accept: application/json' \
-H 'Authorization: Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+'
```

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

### cURL request example

Source: https://komga.org/docs/openapi/update-book-progression

Example command to update book progression using cURL.

```bash
curl -L -X PUT 'https://demo.komga.org/api/v1/books/:bookId/progression' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+' \
-d '{
  "device": {
    "id": "string",
    "name": "string"
  },
  "locator": {
    "href": "string",
    "koboSpan": "string",
    "locations": {
      "fragments": [
        "string"
      ],
      "position": 0,
      "progression": 0,
      "totalProgression": 0
    },
    "text": {
      "after": "string",
      "before": "string",
      "highlight": "string"
    },
    "title": "string",
    "type": "string"
  },
  "modified": "2024-07-29T15:51:28.071Z"
}'
```

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

### CURL Request Example

Source: https://komga.org/docs/openapi/get-read-list-thumbnail-by-id

Example command to fetch a readlist thumbnail using basic authentication.

```bash
curl -L 'https://demo.komga.org/api/v1/readlists/:id/thumbnails/:thumbnailId' \
-H 'Authorization: Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+'
```

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

### CURL request example

Source: https://komga.org/docs/openapi/get-book-by-id

Example command to fetch book details using basic authentication.

```bash
curl -L 'https://demo.komga.org/api/v1/books/:bookId' \
-H 'Accept: application/json' \
-H 'Authorization: Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+'
```

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

### Install Komga via OCI

Source: https://komga.org/docs/installation/thirdparty/helm

Installs the Komga chart directly from the OCI registry.

```bash
helm install komga oci://ghcr.io/helmforgedev/helm/komga  
```

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

### CURL request example

Source: https://komga.org/docs/openapi/get-book-tags

Example command to fetch book tags using basic authentication.

```bash
curl -L 'https://demo.komga.org/api/v1/tags/book' \
-H 'Accept: application/json' \
-H 'Authorization: Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+'
```

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

### CURL Request Example

Source: https://komga.org/docs/openapi/get-authentication-activity-for-current-user

Example command to fetch authentication activity using cURL.

```bash
curl -L 'https://demo.komga.org/api/v2/users/me/authentication-activity?size=20' \
-H 'Accept: application/json' \
-H 'Authorization: Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+'
```

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

### Get Server Information via cURL

Source: https://komga.org/docs/openapi/get-actuator-info

Example request using cURL with basic authentication headers.

```bash
curl -L 'https://demo.komga.org/actuator/info' \
-H 'Accept: application/json' \
-H 'Authorization: Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+'
```

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

### CURL Request Example

Source: https://komga.org/docs/openapi/get-book-page-thumbnail-by-number

Example command to fetch a book page thumbnail using basic authentication.

```bash
curl -L 'https://demo.komga.org/api/v1/books/:bookId/pages/:pageNumber/thumbnail' \
-H 'Authorization: Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+'
```

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

### Install Komga via Scoop

Source: https://komga.org/docs/installation/thirdparty/scoop

Adds the extras bucket and installs the Komga package.

```powershell
scoop bucket add extras
scoop install komga
```

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

### CURL Request Example

Source: https://komga.org/docs/openapi/get-read-list-thumbnails

Example command to fetch readlist thumbnails using curl.

```bash
curl -L 'https://demo.komga.org/api/v1/readlists/:id/thumbnails' \
-H 'Accept: application/json' \
-H 'Authorization: Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+'
```

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

### CURL Request Example

Source: https://komga.org/docs/openapi/update-library-by-id-deprecated

Example command to update a library using cURL.

```bash
curl -L -X PUT 'https://demo.komga.org/api/v1/libraries/:libraryId' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+' \
-d '{
  "analyzeDimensions": true,
  "convertToCbz": true,
  "emptyTrashAfterScan": true,
  "hashFiles": true,
  "hashKoreader": true,
  "hashPages": true,
  "importBarcodeIsbn": true,
  "importComicInfoBook": true,
  "importComicInfoCollection": true,
  "importComicInfoReadList": true,
  "importComicInfoSeries": true,
  "importComicInfoSeriesAppendVolume": true,
  "importEpubBook": true,
  "importEpubSeries": true,
  "importLocalArtwork": true,
  "importMylarSeries": true,
  "name": "string",
  "oneshotsDirectory": "string",
  "repairExtensions": true,
  "root": "string",
  "scanCbx": true,
  "scanDirectoryExclusions": [
    "string"
  ],
  "scanEpub": true,
  "scanForceModifiedTime": true,
  "scanInterval": "DISABLED",
  "scanOnStartup": true,
  "scanPdf": true,
  "seriesCover": "FIRST"
}'
```

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

### Response Schema Examples

Source: https://komga.org/docs/openapi/get-book-page-raw-by-number

Example response formats for successful and failed requests.

```json
"string"
```

```json
{
  "violations": [
    {
      "fieldName": "string",
      "message": "string"
    }
  ]
}
```

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

### CURL Request Example

Source: https://komga.org/docs/openapi/get-series-deprecated

Example command to retrieve series using basic authentication.

```bash
curl -L 'https://demo.komga.org/api/v1/series' \
-H 'Accept: application/json' \
-H 'Authorization: Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+'
```

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

### CURL Request Example

Source: https://komga.org/docs/openapi/get-authors-names

Example command to fetch author names using basic authentication.

```bash
curl -L 'https://demo.komga.org/api/v1/authors/names' \
-H 'Accept: application/json' \
-H 'Authorization: Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+'
```

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

### Run Komga

Source: https://komga.org/docs/installation/thirdparty/aur

Execute the Komga binary after installation.

```bash
komga
```

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

### cURL Request Example

Source: https://komga.org/docs/openapi/create-or-update-known-page-hash

Example of how to perform the PUT request using cURL.

```bash
curl -L -X PUT 'https://demo.komga.org/api/v1/page-hashes' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+' \
-d '{
  "action": "DELETE_AUTO",
  "hash": "string",
  "size": 0
}'
```

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

### CURL Request Example

Source: https://komga.org/docs/openapi/get-books

Example command to list books using cURL with Basic Auth.

```bash
curl -L 'https://demo.komga.org/api/v1/books/list' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+' \
-d '{
  "condition": {
    "anyOf": [
      null
    ]
  },
  "fullTextSearch": "string"
}'
```

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

### cURL Request Example

Source: https://komga.org/docs/openapi/create-api-key-for-current-user

Example command to create an API key using cURL.

```bash
curl -L 'https://demo.komga.org/api/v2/users/me/api-keys' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+' \
-d '{
  "comment": "string"
}'
```

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

### Create and Start Komga Container

Source: https://komga.org/docs/installation/docker

Commands to create a new Komga container with volume mounts and start it.

```bash
docker create \
  --name=komga \
  --user 1000:1000 \
  -p 25600:25600 \
  --mount type=bind,source=/path/to/config,target=/config \
  --mount type=bind,source=/path/to/data,target=/data \
  --restart unless-stopped \
  gotson/komga
```

```bash
docker start komga
```

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

### CURL Request Example

Source: https://komga.org/docs/openapi/get-mihon-read-progress-by-read-list-id

Example command to fetch read progress using cURL.

```bash
curl -L 'https://demo.komga.org/api/v1/readlists/:id/read-progress/tachiyomi' \
-H 'Accept: application/json' \
-H 'Authorization: Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+'
```

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

### CURL request example

Source: https://komga.org/docs/openapi/get-read-lists

Example command to fetch readlists using curl with basic authentication.

```bash
curl -L 'https://demo.komga.org/api/v1/readlists' \
-H 'Accept: application/json' \
-H 'Authorization: Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+'
```

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

### CURL Request Example

Source: https://komga.org/docs/openapi/get-font-family-as-css

Example command to fetch the CSS resource using curl.

```bash
curl -L 'https://demo.komga.org/api/v1/fonts/resource/:fontFamily/css' \
-H 'Accept: application/json'
```

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

### CURL request example

Source: https://komga.org/docs/openapi/get-book-sibling-next-in-read-list

Example command to perform the request using cURL.

```bash
curl -L 'https://demo.komga.org/api/v1/readlists/:id/books/:bookId/next' \
-H 'Accept: application/json' \
-H 'Authorization: Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+'
```

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

### CURL Request Example

Source: https://komga.org/docs/openapi/get-library-by-id

Example command to fetch library details using cURL with basic authentication.

```bash
curl -L 'https://demo.komga.org/api/v1/libraries/:libraryId' \
-H 'Accept: application/json' \
-H 'Authorization: Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+'
```

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

### cURL Request Example

Source: https://komga.org/docs/openapi/mark-book-read-progress

Example command to update read progress using cURL.

```bash
curl -L -X PATCH 'https://demo.komga.org/api/v1/books/:bookId/read-progress' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+' \
-d '{
  "completed": true,
  "page": 0
}'
```

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

### CURL Request Example

Source: https://komga.org/docs/openapi/get-book-sibling-next

Example command to perform the request using cURL.

```bash
curl -L 'https://demo.komga.org/api/v1/books/:bookId/next' \
-H 'Accept: application/json' \
-H 'Authorization: Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+'
```

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

### cURL Request Example

Source: https://komga.org/docs/openapi/save-global-setting

Example command to perform the PATCH request to the global settings endpoint.

```bash
curl -L -X PATCH 'https://demo.komga.org/api/v1/client-settings/global' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+' \
-d '{}'
```

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

### Request Body Example

Source: https://komga.org/docs/openapi/save-user-setting

Example structure for the JSON body containing namespaced setting keys.

```json
{

  "application.key1": {  

    "value": "a string value"  

  },  

  "application.key2": {  

    "value": "{\"json\":\"object\"}"  

  }  

}
```

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

### CURL Request Example

Source: https://komga.org/docs/openapi/get-series-updated

Example command to fetch updated series using basic authentication.

```bash
curl -L 'https://demo.komga.org/api/v1/series/updated' \
-H 'Accept: application/json' \
-H 'Authorization: Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+'
```

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

### Request Body Example

Source: https://komga.org/docs/openapi/delete-global-settings

A simple example of the required JSON array for the request body.

```json
[
  "string"
]
```

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

### CURL request example

Source: https://komga.org/docs/openapi/get-collections

Example command to list collections using cURL with basic authentication.

```bash
curl -L 'https://demo.komga.org/api/v1/collections' \
-H 'Accept: application/json' \
-H 'Authorization: Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+'
```

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

### CURL request example

Source: https://komga.org/docs/openapi/get-known-page-hashes

Example command to fetch page hashes using basic authentication.

```bash
curl -L 'https://demo.komga.org/api/v1/page-hashes' \
-H 'Accept: application/json' \
-H 'Authorization: Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+'
```

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

### CURL Request Example

Source: https://komga.org/docs/openapi/get-book-page-raw-by-number

Example command to fetch a raw book page using curl with basic authentication.

```bash
curl -L 'https://demo.komga.org/api/v1/books/:bookId/pages/:pageNumber/raw' \
-H 'Accept: */*' \
-H 'Authorization: Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+'
```

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

### Install JDK via Scoop

Source: https://komga.org/docs/installation/thirdparty/scoop

Required step if a Java Development Kit is not already installed on the system.

```powershell
scoop bucket add java
scoop install java/temurin-lts-jdk
```

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

### cURL Request Example

Source: https://komga.org/docs/openapi/create-collection

Example command to create a collection using cURL with basic authentication.

```bash
curl -L 'https://demo.komga.org/api/v1/collections' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+' \
-d '{
  "name": "string",
  "ordered": true,
  "seriesIds": [
    "string"
  ]
}'
```

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

### CURL Request Example

Source: https://komga.org/docs/openapi/get-books-duplicates

Example command to fetch duplicate books using cURL with Basic authentication.

```bash
curl -L 'https://demo.komga.org/api/v1/books/duplicates' \
-H 'Accept: application/json' \
-H 'Authorization: Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+'
```

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

### CURL request example

Source: https://komga.org/docs/openapi/get-book-positions

Example command to fetch book positions using cURL with basic authentication.

```bash
curl -L 'https://demo.komga.org/api/v1/books/:bookId/positions' \
-H 'Accept: application/json' \
-H 'Authorization: Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+'
```

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

### One-Shots Directory Structure Example

Source: https://komga.org/docs/guides/oneshots

Example directory structure demonstrating how files within a configured _oneshots directory are processed as One-Shot series.

```text
/data/books/Comics  

├── Space Adventures  

│   ├── Space_Adventures_001.cbz  

│   ├── Space_Adventures_002.cbz  

│   ├── Space_Adventures_003.cbz  

│   └── _oneshots  

│       └── Pluto Adventures.cbz  

├── Super Duck  

│   ├── Super_Duck_001.cbz  

│   ├── Super_Duck_002.cbz  

│   └── Super_Duck_003.cbz  

└── _oneshots  

    ├── A oneshot.cbz  

    ├── Another oneshot.cbz  

    └── Yet another oneshot.cbz
```

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

### cURL Request Example

Source: https://komga.org/docs/openapi/add-library

Example command to add a library using cURL with Basic Authentication.

```bash
curl -L -X POST 'https://komga.org/api/v1/libraries' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+'
```

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

### CURL request example

Source: https://komga.org/docs/openapi/get-series-alphabetical-groups-deprecated

Example command to fetch series alphabetical groups using basic authentication.

```bash
curl -L 'https://komga.org/api/v1/series/alphabetical-groups' \
-H 'Accept: application/json' \
-H 'Authorization: Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+'
```

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

### cURL request example

Source: https://komga.org/docs/openapi/get-page-by-transient-book-id

Example command to retrieve a transient book page using cURL.

```bash
curl -L 'https://demo.komga.org/api/v1/transient-books/:id/pages/:pageNumber' \
-H 'Accept: */*' \
-H 'Authorization: Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+'
```

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

### CURL Request Example

Source: https://komga.org/docs/openapi/get-books-by-read-list-id

Example command to retrieve books from a read list using cURL.

```bash
curl -L 'https://demo.komga.org/api/v1/readlists/:id/books' \
-H 'Accept: application/json' \
-H 'Authorization: Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+'
```

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

### User list response schema example

Source: https://komga.org/docs/openapi/get-users

Example JSON structure returned by a successful request.

```json
[  

  {  

    "ageRestriction": {  

      "age": 0,  

      "restriction": "ALLOW_ONLY"  

    },  

    "email": "string",  

    "id": "string",  

    "labelsAllow": [  

      "string"  

    ],  

    "labelsExclude": [  

      "string"  

    ],  

    "roles": [  

      "string"  

    ],  

    "sharedAllLibraries": true,  

    "sharedLibrariesIds": [  

      "string"  

    ]  

  }  

]
```

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

### CURL request example

Source: https://komga.org/docs/openapi/get-mihon-read-progress-by-series-id

Example command to fetch read progress using cURL with basic authentication.

```bash
curl -L 'https://demo.komga.org/api/v2/series/:seriesId/read-progress/tachiyomi' \
-H 'Accept: application/json' \
-H 'Authorization: Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+'
```

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

### Install Komga via AUR

Source: https://komga.org/docs/installation/thirdparty/aur

Use an AUR helper like yay to install the Komga package.

```bash
yay -S komga
```

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

### Read progress response schema example

Source: https://komga.org/docs/openapi/get-mihon-read-progress-by-series-id

Example JSON response body for a successful request.

```json
{

  "booksCount": 0,

  "booksInProgressCount": 0,

  "booksReadCount": 0,

  "booksUnreadCount": 0,

  "lastReadContinuousNumberSort": 0,

  "maxNumberSort": 0

}
```

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

### Read Progress Response Schema Example

Source: https://komga.org/docs/openapi/get-mihon-read-progress-by-read-list-id

Example JSON response body for a successful request.

```json
{

  "booksCount": 0,

  "booksInProgressCount": 0,

  "booksReadCount": 0,

  "booksUnreadCount": 0,

  "lastReadContinuousIndex": 0

}
```

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

### cURL Request Example

Source: https://komga.org/docs/openapi/get-collection-by-id

Example command to fetch collection details using cURL with basic authentication.

```bash
curl -L 'https://demo.komga.org/api/v1/collections/:id' \
-H 'Accept: application/json' \
-H 'Authorization: Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+'
```

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

### CURL Request Example

Source: https://komga.org/docs/openapi/get-series-by-collection-id

Example command to fetch series by collection ID using basic authentication.

```bash
curl -L 'https://demo.komga.org/api/v1/collections/:id/series' \
-H 'Accept: application/json' \
-H 'Authorization: Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+'
```

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

### Retrieve Claim Status via cURL

Source: https://komga.org/docs/openapi/get-claim-status

Example command to perform the GET request using cURL.

```bash
curl -L 'https://demo.komga.org/api/v1/claim' \
-H 'Accept: application/json'
```

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

### CURL Request Example

Source: https://komga.org/docs/openapi/get-series-latest

Example command to fetch the latest series using cURL with Basic Auth.

```bash
curl -L 'https://demo.komga.org/api/v1/series/latest' \
-H 'Accept: application/json' \
-H 'Authorization: Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+'
```

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

### cURL Request Example

Source: https://komga.org/docs/openapi/get-series-thumbnail-by-id

Example cURL command to retrieve a series thumbnail using basic authentication.

```bash
curl -L 'https://demo.komga.org/api/v1/series/:seriesId/thumbnails/:thumbnailId' \
-H 'Authorization: Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+'
```

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

### CURL Request Example

Source: https://komga.org/docs/openapi/update-password-for-current-user

Example command to update the password using cURL.

```bash
curl -L -X PATCH 'https://demo.komga.org/api/v2/users/me/password' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+' \
-d '{
  "password": "string"
}'
```

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

### Create and start a Podman container

Source: https://komga.org/docs/installation/thirdparty/podman

Commands to initialize and launch the Komga container manually.

```bash
podman create \
  --name=komga \
  -p 25600:25600 \
  --mount type=bind,source=/path/to/config,target=/config \
  --mount type=bind,source=/path/to/data,target=/data \
  docker.io/gotson/komga:latest
```

```bash
podman start komga
```

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

### CURL Request Example

Source: https://komga.org/docs/openapi/get-series-by-id

Example command to retrieve a series by ID using cURL.

```bash
curl -L 'https://demo.komga.org/api/v1/series/:seriesId' \
-H 'Accept: application/json' \
-H 'Authorization: Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+'
```

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

### Sample application.yml configuration

Source: https://komga.org/docs/installation/configuration

A template for customizing Komga settings. Ensure correct YAML indentation and only include necessary lines.

```yaml

# Only keep lines that are relevant to you!  

# Lines starting with # are comments  

# Make sure indentation is correct (2 spaces at every indentation level), yaml is very sensitive!  

komga:  

  database:  

    # If you're using Docker/Podman, set this to "<KOMGA_CONFIGDIR>/database.sqlite" (default to use: "/config/database.sqlite"; replace "<KOMGA_CONFIGDIR>" with the actual KOMGA_CONFIGDIR value if it's been overridden.)  

    # Otherwise, it will make Komga create your database in an temporary location and you will lose (!) your database when your container gets recreated.  

    file: ${user.home}/.komga/database.sqlite  

  cors.allowed-origins:  

    - http://localhost:8081  

    - http://localhost:8082  

server:  

  port: 25600  

  servlet:  

    session.timeout: 7d # session timeout, here 7 days  

    context-path: /komga  



```

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

### Configure Komga via command line

Source: https://komga.org/docs/installation/configuration

Use application properties prefixed with double dashes when launching the JAR file.

```bash
java -jar komga.jar --server.servlet.context-path="/komga" --server.port=8443
```

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

### List Releases via cURL

Source: https://komga.org/docs/openapi/get-releases

Example command to fetch releases using basic authentication.

```bash
curl -L 'https://demo.komga.org/api/v1/releases' \
-H 'Accept: application/json' \
-H 'Authorization: Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+'
```

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

### Execute Komga commands via JAR, Docker, and Compose

Source: https://komga.org/docs/guides/cli

Examples of how to pass commands to the Komga application using different deployment methods.

```bash
java -jar komga-x.y.z.jar --list-users
```

```bash
docker run ghcr.io/gotson/komga:latest --list-users
```

```yaml
services:  

  komga:  

    image: gotson/komga:latest  

    command: --newpassword=toto --reset=admin@example.org
```

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

### Series Response Schema Example

Source: https://komga.org/docs/openapi/get-series-by-id

Example JSON response structure for a successful series retrieval.

```json
{
  "booksCount": 0,
  "booksInProgressCount": 0,
  "booksMetadata": {
    "authors": [
      {
        "name": "string",
        "role": "string"
      }
    ],
    "created": "2024-07-29T15:51:28.071Z",
    "lastModified": "2024-07-29T15:51:28.071Z",
    "releaseDate": "2024-07-29",
    "summary": "string",
    "summaryNumber": "string",
    "tags": [
      "string"
    ]
  },
  "booksReadCount": 0,
  "booksUnreadCount": 0,
  "created": "2024-07-29T15:51:28.071Z",
  "deleted": true,
  "fileLastModified": "2024-07-29T15:51:28.071Z",
  "id": "string",
  "lastModified": "2024-07-29T15:51:28.071Z",
  "libraryId": "string",
  "metadata": {
    "ageRating": 0,
    "ageRatingLock": true,
    "alternateTitles": [
      {
        "label": "string",
        "title": "string"
      }
    ],
    "alternateTitlesLock": true,
    "created": "2024-07-29T15:51:28.071Z",
    "genres": [
      "string"
    ],
    "genresLock": true,
    "language": "string",
    "languageLock": true,
    "lastModified": "2024-07-29T15:51:28.071Z",
    "links": [
      {
        "label": "string",
        "url": "string"
      }
    ],
    "linksLock": true,
    "publisher": "string",
    "publisherLock": true,
    "readingDirection": "string",
    "readingDirectionLock": true,
    "sharingLabels": [
      "string"
    ],
    "sharingLabelsLock": true,
    "status": "string",
    "statusLock": true,
    "summary": "string",
    "summaryLock": true,
    "tags": [
      "string"
    ],
    "tagsLock": true,
    "title": "string",
    "titleLock": true,
    "titleSort": "string",
    "titleSortLock": true,
    "totalBookCount": 0,
    "totalBookCountLock": true
  },
  "name": "string",
  "oneshot": true,
  "url": "string"
}
```

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

### Readlists response schema example

Source: https://komga.org/docs/openapi/get-read-lists

Example JSON response structure for a successful readlists request.

```json
{

  "content": [

    {

      "bookIds": [

        "string"

      ],

      "createdDate": "2024-07-29T15:51:28.071Z",

      "filtered": true,

      "id": "string",

      "lastModifiedDate": "2024-07-29T15:51:28.071Z",

      "name": "string",

      "ordered": true,

      "summary": "string"

    }

  ],

  "empty": true,

  "first": true,

  "last": true,

  "number": 0,

  "numberOfElements": 0,

  "pageable": {

    "offset": 0,

    "pageNumber": 0,

    "pageSize": 0,

    "paged": true,

    "sort": {

      "empty": true,

      "sorted": true,

      "unsorted": true

    },

    "unpaged": true

  },

  "size": 0,

  "sort": {

    "empty": true,

    "sorted": true,

    "unsorted": true

  },

  "totalElements": 0,

  "totalPages": 0

}
```

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

### CURL Request Example

Source: https://komga.org/docs/openapi/get-series-alphabetical-groups

Example command to list series alphabetical groups using cURL.

```bash
curl -L 'https://demo.komga.org/api/v1/series/list/alphabetical-groups' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+' \
-d '{
  "condition": {
    "anyOf": [
      null
    ]
  },
  "fullTextSearch": "string"
}'
```

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

### Release Response Schema Example

Source: https://komga.org/docs/openapi/get-releases

Example JSON structure returned by the API for a successful request.

```json
[  

  {  

    "description": "string",  

    "latest": true,  

    "preRelease": true,  

    "releaseDate": "2024-07-29T15:51:28.071Z",  

    "url": "string",  

    "version": "string"  

  }  

]
```

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

### Retrieve server settings via cURL

Source: https://komga.org/docs/openapi/get-server-settings

Example command to fetch settings using basic authentication.

```bash
curl -L 'https://demo.komga.org/api/v1/settings' \
-H 'Accept: application/json' \
-H 'Authorization: Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+'
```

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

### Library response schema example

Source: https://komga.org/docs/openapi/get-libraries

Example JSON response body for a successful library retrieval.

```json
[  

  {  

    "analyzeDimensions": true,  

    "convertToCbz": true,  

    "emptyTrashAfterScan": true,  

    "hashFiles": true,  

    "hashKoreader": true,  

    "hashPages": true,  

    "id": "string",  

    "importBarcodeIsbn": true,  

    "importComicInfoBook": true,  

    "importComicInfoCollection": true,  

    "importComicInfoReadList": true,  

    "importComicInfoSeries": true,  

    "importComicInfoSeriesAppendVolume": true,  

    "importEpubBook": true,  

    "importEpubSeries": true,  

    "importLocalArtwork": true,  

    "importMylarSeries": true,  

    "name": "string",  

    "oneshotsDirectory": "string",  

    "repairExtensions": true,  

    "root": "string",  

    "scanCbx": true,  

    "scanDirectoryExclusions": [  

      "string"  

    ],  

    "scanEpub": true,  

    "scanForceModifiedTime": true,  

    "scanInterval": "DISABLED",  

    "scanOnStartup": true,  

    "scanPdf": true,  

    "seriesCover": "FIRST",  

    "unavailable": true  

  }  

]
```

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

### Configure Caddy Reverse Proxy for Komga

Source: https://komga.org/docs/installation/https

Examples for setting up Caddy with or without a base URL configuration.

```Caddyfile
komga.yourdomain.com {  

    reverse_proxy http://your-komga-server:25600  

}  
```

```Caddyfile
yourdomain.com {  

    reverse_proxy /komga/* http://your-komga-server:25600  

}  
```

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

### List users command output

Source: https://komga.org/docs/guides/cli

Example log output when running the --list-users command.

```text
2023-08-02T13:41:45.215+08:00  INFO 1979 --- [           main] o.g.k.i.apprunner.ListUsersRunner        : Here is a list of all users: [admin@example.org, jacky@example.org]
```

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

### Success response schema example

Source: https://komga.org/docs/openapi/get-collections-by-series-id

Example JSON structure returned upon a successful request.

```json
[  

  {  

    "createdDate": "2024-07-29T15:51:28.071Z",  

    "filtered": true,  

    "id": "string",  

    "lastModifiedDate": "2024-07-29T15:51:28.071Z",  

    "name": "string",  

    "ordered": true,  

    "seriesIds": [  

      "string"  

    ]  

  }  

]
```

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

### CURL Request Example

Source: https://komga.org/docs/openapi/get-books-by-series-id

Example command to retrieve books by series ID using cURL.

```bash
curl -L 'https://demo.komga.org/api/v1/series/:seriesId/books' \
-H 'Accept: application/json' \
-H 'Authorization: Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+'
```

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

### Progression response schema example

Source: https://komga.org/docs/openapi/get-book-progression

Example JSON response structure for a successful progression retrieval.

```json
{
  "device": {
    "id": "string",
    "name": "string"
  },
  "locator": {
    "href": "string",
    "koboSpan": "string",
    "locations": {
      "fragments": [
        "string"
      ],
      "position": 0,
      "progression": 0,
      "totalProgression": 0
    },
    "text": {
      "after": "string",
      "before": "string",
      "highlight": "string"
    },
    "title": "string",
    "type": "string"
  },
  "modified": "2024-07-29T15:51:28.071Z"
}
```

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

### Download Readlist via cURL

Source: https://komga.org/docs/openapi/download-read-list-as-zip

Example command to download a readlist using basic authentication.

```bash
curl -L 'https://demo.komga.org/api/v1/readlists/:id/file' \
-H 'Accept: application/json' \
-H 'Authorization: Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+'
```

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

### CURL Request Example

Source: https://komga.org/docs/openapi/delete-single-match-by-page-hash

Example command to perform the delete match operation using curl.

```bash
curl -L 'https://demo.komga.org/api/v1/page-hashes/:pageHash/delete-match' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+' \
-d '{
  "bookId": "string",
  "fileName": "string",
  "fileSize": 0,
  "mediaType": "string",
  "pageNumber": 0,
  "url": "string"
}'
```

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

### Run Komga JAR

Source: https://komga.org/docs/installation/jar

Standard command to launch the Komga application. Replace the version placeholder with the specific file version.

```bash
java -jar komga-x.y.z.jar
```

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

### POST /api/v1/libraries

Source: https://komga.org/docs/openapi/add-library

Creates a new library in the Komga system. Requires Basic Authentication.

```APIDOC
## POST /api/v1/libraries

### Description
Creates a new library with the specified configuration settings.

### Method
POST

### Endpoint
/api/v1/libraries

### Request Body
- **analyzeDimensions** (boolean) - Required - Whether to analyze image dimensions.
- **convertToCbz** (boolean) - Required - Whether to convert files to CBZ.
- **emptyTrashAfterScan** (boolean) - Required - Whether to empty trash after scanning.
- **hashFiles** (boolean) - Required - Whether to hash files.
- **hashKoreader** (boolean) - Required - Whether to hash for Koreader.
- **hashPages** (boolean) - Required - Whether to hash pages.
- **importBarcodeIsbn** (boolean) - Required - Whether to import ISBN from barcodes.
- **importComicInfoBook** (boolean) - Required - Whether to import ComicInfo for books.
- **importComicInfoCollection** (boolean) - Required - Whether to import ComicInfo for collections.
- **importComicInfoReadList** (boolean) - Required - Whether to import ComicInfo for read lists.
- **importComicInfoSeries** (boolean) - Required - Whether to import ComicInfo for series.
- **importComicInfoSeriesAppendVolume** (boolean) - Required - Whether to append volume from ComicInfo.
- **importEpubBook** (boolean) - Required - Whether to import EPUB books.
- **importEpubSeries** (boolean) - Required - Whether to import EPUB series.
- **importLocalArtwork** (boolean) - Required - Whether to import local artwork.
- **importMylarSeries** (boolean) - Required - Whether to import Mylar series.
- **name** (string) - Required - Name of the library.
- **oneshotsDirectory** (string) - Optional - Directory for oneshots.
- **repairExtensions** (boolean) - Required - Whether to repair file extensions.
- **root** (string) - Required - Root directory path.
- **scanCbx** (boolean) - Required - Whether to scan CBX files.
- **scanDirectoryExclusions** (string[]) - Required - List of directory exclusions.
- **scanEpub** (boolean) - Required - Whether to scan EPUB files.
- **scanForceModifiedTime** (boolean) - Required - Whether to force modified time scan.
- **scanInterval** (string) - Required - Scan interval (DISABLED, HOURLY, EVERY_6H, EVERY_12H, DAILY, WEEKLY).
- **scanOnStartup** (boolean) - Required - Whether to scan on startup.
- **scanPdf** (boolean) - Required - Whether to scan PDF files.
- **seriesCover** (string) - Required - Series cover strategy (FIRST, FIRST_UNREAD_OR_FIRST, FIRST_UNREAD_OR_LAST, LAST).

### Request Example
{
  "name": "My Library",
  "root": "/path/to/library",
  "scanInterval": "DISABLED",
  "seriesCover": "FIRST"
}

### Response
#### Success Response (200)
- **id** (string) - The ID of the created library.

#### Error Response (400)
- **violations** (object[]) - List of validation errors.
```

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

### Download Book File via cURL

Source: https://komga.org/docs/openapi/download-book-file

Example command to download a book file using basic authentication.

```bash
curl -L 'https://demo.komga.org/api/v1/books/:bookId/file' \
-H 'Accept: application/json' \
-H 'Authorization: Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+'
```

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

### Retrieve Global Settings via cURL

Source: https://komga.org/docs/openapi/get-global-settings

Example command to fetch global settings using cURL.

```bash
curl -L 'https://demo.komga.org/api/v1/client-settings/global/list' \
-H 'Accept: application/json'
```

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

### POST /api/v1/libraries

Source: https://komga.org/docs/openapi/add-library

Creates a new library with the specified configuration.

```APIDOC
## POST /api/v1/libraries

### Description
Creates a new library in the system. Requires ADMIN role.

### Method
POST

### Endpoint
https://demo.komga.org/api/v1/libraries

### Request Body
- **analyzeDimensions** (boolean) - Required - Whether to analyze image dimensions.
- **convertToCbz** (boolean) - Required - Whether to convert files to CBZ.
- **emptyTrashAfterScan** (boolean) - Required - Whether to empty trash after scanning.
- **hashFiles** (boolean) - Required - Whether to hash files.
- **hashKoreader** (boolean) - Required - Whether to hash for Koreader.
- **hashPages** (boolean) - Required - Whether to hash pages.
- **importBarcodeIsbn** (boolean) - Required - Whether to import ISBN from barcodes.
- **importComicInfoBook** (boolean) - Required - Whether to import ComicInfo for books.
- **importComicInfoCollection** (boolean) - Required - Whether to import ComicInfo for collections.
- **importComicInfoReadList** (boolean) - Required - Whether to import ComicInfo for read lists.
- **importComicInfoSeries** (boolean) - Required - Whether to import ComicInfo for series.
- **importComicInfoSeriesAppendVolume** (boolean) - Required - Whether to append volume from ComicInfo.
- **importEpubBook** (boolean) - Required - Whether to import EPUB book metadata.
- **importEpubSeries** (boolean) - Required - Whether to import EPUB series metadata.
- **importLocalArtwork** (boolean) - Required - Whether to import local artwork.
- **importMylarSeries** (boolean) - Required - Whether to import Mylar series metadata.
- **name** (string) - Required - Name of the library (non-empty).
- **oneshotsDirectory** (string) - Optional - Directory for oneshots.
- **repairExtensions** (boolean) - Required - Whether to repair file extensions.
- **root** (string) - Required - Root directory path (non-empty).
- **scanCbx** (boolean) - Required - Whether to scan CBX files.
- **scanDirectoryExclusions** (string[]) - Required - List of directory exclusions.
- **scanEpub** (boolean) - Required - Whether to scan EPUB files.
- **scanForceModifiedTime** (boolean) - Required - Whether to force modified time scan.
- **scanInterval** (string) - Required - Scan interval (DISABLED, HOURLY, EVERY_6H, EVERY_12H, DAILY, WEEKLY).
- **scanOnStartup** (boolean) - Required - Whether to scan on startup.
- **scanPdf** (boolean) - Required - Whether to scan PDF files.
- **seriesCover** (string) - Required - Series cover strategy (FIRST, FIRST_UNREAD_OR_FIRST, FIRST_UNREAD_OR_LAST, LAST).

### Request Example
{
  "analyzeDimensions": true,
  "convertToCbz": true,
  "emptyTrashAfterScan": true,
  "hashFiles": true,
  "hashKoreader": true,
  "hashPages": true,
  "importBarcodeIsbn": true,
  "importComicInfoBook": true,
  "importComicInfoCollection": true,
  "importComicInfoReadList": true,
  "importComicInfoSeries": true,
  "importComicInfoSeriesAppendVolume": true,
  "importEpubBook": true,
  "importEpubSeries": true,
  "importLocalArtwork": true,
  "importMylarSeries": true,
  "name": "string",
  "oneshotsDirectory": "string",
  "repairExtensions": true,
  "root": "string",
  "scanCbx": true,
  "scanDirectoryExclusions": ["string"],
  "scanEpub": true,
  "scanForceModifiedTime": true,
  "scanInterval": "DISABLED",
  "scanOnStartup": true,
  "scanPdf": true,
  "seriesCover": "FIRST"
}
```

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

### Create User CURL Request

Source: https://komga.org/docs/openapi/add-user

Example command to create a user using CURL with basic authentication.

```bash
curl -L -X POST 'https://komga.org/api/v2/users' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+'
```

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

### Positions response schema example

Source: https://komga.org/docs/openapi/get-book-positions

Example JSON structure for a successful response containing book positions.

```json
{
  "positions": [
    {
      "href": "string",
      "koboSpan": "string",
      "locations": {
        "fragments": [
          "string"
        ],
        "position": 0,
        "progression": 0,
        "totalProgression": 0
      },
      "text": {
        "after": "string",
        "before": "string",
        "highlight": "string"
      },
      "title": "string",
      "type": "string"
    }
  ],
  "total": 0
}
```

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

### Retrieve User Settings via cURL

Source: https://komga.org/docs/openapi/get-user-settings

Example command to fetch user settings using basic authentication.

```bash
curl -L 'https://demo.komga.org/api/v1/client-settings/user/list' \
-H 'Accept: application/json' \
-H 'Authorization: Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+'
```

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

### Download book file with cURL

Source: https://komga.org/docs/openapi/download-book-file-1

Example request to download a book file using basic authentication.

```bash
curl -L 'https://demo.komga.org/api/v1/books/:bookId/file/*' \
-H 'Accept: application/json' \
-H 'Authorization: Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+'
```
Tokens:
Raw