Skip to content

redwoodstory/LitKeeper

Repository files navigation

LitKeeper

This is a simple web app to save stories from Literotica to ePub. In my own workflow, I download stories to a local server running Calibre-Web-Automated, which renders the stories available to other devices through its OPDS functionality.

This app includes the following features:

  • Renders a simple web page prompting the user for a Literotica URL to download
  • Retrieves story, converts to ePub, and saves to a predefined location (defined in Docker Compose file)
  • Bundles story category and tags into metadata
  • Generates a cover image showing the story title and author name
  • Identifies if the story is part of a series and bundles subquent stories into a single ePub
  • Provides an API to download stories directly from iOS shortcuts (see example below)
  • (Optional) Sends Telegram notifications when the story is downloaded
  • (Optional) Provides somewhat extensive logging (helpful for debugging but can be disabled in Docker Compose file)

Installation

  1. Create a docker-compose.yml file:
services:
  litkeeper:
    image: ghcr.io/redwoodstory/litkeeper:latest
    restart: unless-stopped
    ports:
      - "5000:5000"
    volumes:
      - ./epubs:/litkeeper/app/data/epubs
      - ./logs:/litkeeper/app/data/logs
    environment:
      # Optional logging controls
      - ENABLE_ACTION_LOG=true    # Set to false to disable action logging
      - ENABLE_ERROR_LOG=true     # Set to false to disable error logging
      - ENABLE_URL_LOG=true       # Set to false to disable URL logging
      
      # Optional Telegram notification configuration
      - TELEGRAM_BOT_TOKEN=      # Your bot token from @BotFather
      - TELEGRAM_CHAT_ID=        # Your chat ID (can be channel, group, or user ID)
  1. Run the following command docker compose up -d

  2. Navigate to http://<server-ip>:5000

API Configuration

To use the API, send a GET request in the following format:

GET <server-url>/api/download?url=<literotica-story-url>&wait=false

iOS Shortcuts

To trigger a download using iOS Shortcuts, using the folowing format:

  1. Receive [URLs and Apps] input from [Share Sheet]
  2. Get URLs from [Shortcut Input]
  3. URL: /api/download?url=&wait=false
  4. Get contents of [URL]

iOS Shortcut Screenshot

About

Containerized web app to save Literotica stories as epub files

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages