send2ereader

The service manages file lifecycles using a combination of timers and manual deletions:

1. Key Expiration: When a key is generated, a timer is set for expireDelay (30 seconds). If no activity occurs, the key is removed from memory. If the session persists, the key can live up to maxExpireDuration (1 hour).
2. File Cleanup: When a new file is uploaded to an existing key, the previous file associated with that key is deleted from the uploads/ directory.
3. Manual Deletion: Calling DELETE /file/:key immediately clears the file association for that key.
4. Automatic Cleanup: If a conversion process (like kindlegen) fails, the service attempts to delete the temporary input and output files.

You can run send2ereader in a containerized environment using Docker and Docker Compose. Ensure you have cloned the repository so that the Dockerfile, docker-compose.yaml, and package.json are in your current working directory.

1. Build the image: docker compose build
2. Start the container in detached mode: docker compose up -d
3. Access the service at http://localhost:3001

git clone https://github.com/daniel-j/send2ereader.git
cd send2ereader
docker compose build
docker compose up -d

To run send2ereader directly on your operating system, ensure you have Node.js (version 16 or 20) installed and that the following external dependencies are installed and available in your system's PATH:

• Kepubify: For Kobo ebook processing.
• KindleGen: For Kindle ebook processing.
• pdfCropMargins: For PDF processing.

Follow these steps:

1. Install dependencies: npm install
2. Start the service: npm start
3. Access the service at http://localhost:3001

You can deploy send2ereader using Docker Compose. The configuration defines a service named send2ereader that builds from the local directory using the provided Dockerfile.

Configuration Details

• Restart Policy: The container is configured with restart: unless-stopped, meaning it will automatically restart after a shutdown unless you manually stop the container.
• Port Mapping: The service binds an external port to the internal container port. The default mapping is 3001:3001. If you need to change the access port, only modify the external port (the first number in the pair).

Format: <External Port>:<Internal Port>

services:
  send2ereader:
    build:
      context: .
      dockerfile: ./Dockerfile
    container_name: send2ereader
    restart: unless-stopped
    ports:
      - 3001:3001

Retrieve the current state of a session key. This is useful for verifying if a file has been successfully processed and uploaded.

Returns:

• alive: Timestamp of last activity.
• file: Object containing name (if a file is present).
• urls: Array of URLs associated with this session.

# Example: Checking status
curl http://localhost:3001/status/ABCD

To download a file, you must provide the session key as a query parameter. The filename in the URL path must match the filename stored in the session.

Note: The User-Agent used for the download must match the User-Agent used during the upload/generation phase.

# Example: Downloading a file
# If the file name is 'mybook.epub' and key is 'ABCD'
curl "http://localhost:3001/mybook.epub?key=ABCD"

To start a session, call the /generate endpoint. The server generates a unique 4-character key (using characters 23456789ACDEFGHJKLMNPRSTUVWXYZ) and sets a key cookie. The key is valid for 30 seconds for the initial upload phase, but the session can last up to 1 hour if activity continues.

# Example using curl to get a key
curl -X POST http://localhost:3001/generate