# Setup & Configuration

We need to install the service through Portainer and configure any necessary settings.

# Preparation

There are some things we need to do in preparation to install this service.

## Volumes

<details id="bkmrk-media-folders-radarr"><summary>Persistent Data</summary>

This is where the service will store its own application data and ensures we can quickly update the service image.

<p class="callout warning">Ensure your user has permissions to access the folder.</p>

</details><details id="bkmrk-media-folders-this-s"><summary>Media Folders</summary>

This service will need access to the folders where you store your media files.

<p class="callout warning">Ensure your user has permissions to access the folder.</p>

</details><details id="bkmrk-download-folder-rada"><summary>Download Folders</summary>

This service will need access to the folder where you torrent or usenet folder store their completed downloads.

<p class="callout warning">Ensure your user has permissions to access the folder.</p>

</details>## Environment

<details id="bkmrk-tz-this-is-the-curre"><summary>TZ</summary>

This is the current time zone formatted using the [tz database.](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)

<p class="callout info">*For example:* America/Vancouver</p>

</details><details id="bkmrk-gid-%C2%A0"><summary>PUID</summary>

This is the numeric ID of the user account on Debian. If you are unsure, open a terminal and run:

```bash
id -u
```

</details><details id="bkmrk-pgid-this-is-the-num"><summary>PGID</summary>

This is the numeric ID of the user account's group on Debian. If you are unsure, open a terminal and run:

```bash
id -g
```

</details>## API Keys

<p class="callout warning">API Keys are used for authenticating access to and communication with another service. These should be treated as if they are a secure password.</p>

<details id="bkmrk-comicvine-api-this-s"><summary>HardCover API</summary>

This services uses API services to retrieve its required metadata. These API keys are free, but need to be manually requested through the [HardCover website](https://docs.hardcover.app/api/getting-started/).

<p class="callout warning">You will need to create an account with your personal e-mail address.</p>

</details><details id="bkmrk-google-books-api-thi"><summary>Google Books API</summary>

This services uses API services to retrieve its required metadata. These API keys are free, but need to be manually requested through the [Google Books website](https://developers.google.com/books/docs/v1/using).

<p class="callout warning">You will need to create an account with your personal e-mail address.</p>

</details><details id="bkmrk-librarythings-develo"><summary>LibraryThings Developer Key</summary>

This services uses API services to retrieve its required metadata. These API keys are free, but need to be manually requested through the [LibraryThings website](https://www.librarything.com/developer).

<p class="callout warning">You will need to create an account with your personal e-mail address.</p>

</details><details id="bkmrk-comicvine-api-this-s-1"><summary>ComicVine API</summary>

This services uses the ComicVine API to retrieve its required metadata. These API keys are free, but need to be manually requested through the [ComicVine API](https://comicvine.gamespot.com/api/) website.

<p class="callout warning">You will need to create an account with your personal e-mail address.</p>

</details>

# Installation

The service can be installed through the Portainer web interface.

<p class="callout info">Learn about [creating a new stack](https://hub.subspace.services/books/portainer/page/creating-a-new-stack "Creating a New Stack").</p>

## Docker Compose

Use the following code to install the service:

```yaml
---
services:
  lazylibrarian:
    image: lscr.io/linuxserver/lazylibrarian:latest
    container_name: lazylibrarian
    network_mode: bridge
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=America/Vancouver
      - DOCKER_MODS=linuxserver/mods:universal-calibre|linuxserver/mods:lazylibrarian-ffmpeg
    volumes:
      # Persistent Data
      - /srv/lazylibrarian:/config

      # Download Folders
      - /mnt/downloads:/downloads

      # Media Folders
      - /mnt/books:/books
    ports:
      - 5299:5299
    restart: unless-stopped
```

# Updating

<p class="callout success">Re-Deploy the Stack</p>

This service has been optimized for running in Docker thanks to [LinuxServer.io](https://linuxserver.io).

This allows you to [re-deploy the stack through Portainer](https://hub.subspace.services/books/portainer/page/updating-a-stack "Updating a Stack") to download the latest updates.