LibreTV

Use the following docker-compose.yml configuration to manage your LibreTV instance. You can customize the PASSWORD variable in the environment section.

To start the service, run:

docker compose up -d

After starting, access the application at http://localhost:8899.

services:
  libretv:
    image: bestzwei/libretv:latest
    container_name: libretv
    ports:
      - "8899:8080" # Maps internal 8080 to host 8899
    environment:
      - PASSWORD=${PASSWORD:-111111} # Defaults to 111111 if not provided
    restart: unless-stopped

LibreTV requires a Node.js environment to support its backend proxy features. Note that using simple static servers (like python -m http.server) will break video proxy functionality and prevent playback.

Follow these steps to set up development:

1. Copy the example environment file:

   cp .env.example .env

2. Install dependencies:

   npm install

3. Start the development server:

   npm run dev

Access the app at http://localhost:8080. You can change the port by modifying the PORT variable in your .env file.

# Set up .env file
cp .env.example .env

# Install dependencies
npm install

# Start development server
npm run dev

You can run LibreTV as a containerized application using Docker or Docker Compose. By default, the application listens on port 8889 (mapped from internal 8080).

Important: You must set the PASSWORD environment variable to secure your instance.

docker run -d \
  --name libretv \
  --restart unless-stopped \
  -p 8899:8080 \
  -e PASSWORD=your_password \
  bestzwei/libretv:latest

LibreTV supports the standard Apple CMS V10 API format. To add a custom source, navigate to the settings panel in the UI and select Custom Interface (自定义接口).

Required API Format:

• Search Interface: https://example.com/api.php/provide/vod/?ac=videolist&wd={keyword}
• Detail Interface: https://example.com/api.php/provide/vod/?ac=detail&ids={video_id}

When adding the source in the settings panel, use the base URL: https://example.com/api.php/provide/vod

The application manages which video sources are queried using the selectedAPIs array, stored in localStorage.

API Selection

• Built-in APIs: Identified by their unique keys in the API_SITES object.
• Custom APIs: Identified by the prefix custom_ followed by their index in the customAPIs array (e.g., custom_0, custom_1).

Content Filtering

• Yellow Content Filter: Controlled by the yellowFilterEnabled key in localStorage. When true, the search results are filtered against a list of banned keywords (e.g., '伦理片', '福利', '无码').
• Adult API Restriction: If any API marked as adult is selected, the yellowFilterEnabled setting is automatically disabled and the toggle is locked to prevent conflicts.
• Ad Filtering: Controlled by the key defined in PLAYER_CONFIG.adFilteringStorage (defaults to true).

LibreTV uses a template replacement mechanism to inject security credentials into static HTML files.

When the server serves index.html or player.html, it looks for the placeholder {{PASSWORD}} within the file content.

• If PASSWORD is configured in the environment, {{PASSWORD}} is replaced with the SHA-256 hash of that password.
• If PASSWORD is empty, {{PASSWORD}} is replaced with an empty string.

This allows the client-side application to perform authenticated requests (like using the proxy) by knowing the expected hash without the raw password being exposed in the source code.

You can deploy LibreTV using a docker-compose.yml file. The service runs the bestzwei/libretv:latest image and maps the internal port 8080 to the host port 8899 by default.

To customize the deployment, you can use environment variables for the access password and configure a bind mount for persistent data storage.

services:
  libretv:
    image: bestzwei/libretv:latest
    container_name: libretv
    ports:
      - "8899:8080"
    environment:
      - PASSWORD=${PASSWORD:-your_password}
    restart: unless-stopped

volumes:
  libretv_data:
    driver: local
    driver_opts:
      type: none
      o: bind
      device: ${PWD:-.}/data

To ensure data persistence, use a named volume with a bind mount. This maps the internal /app directory to a specific directory on your host machine.

In the provided configuration, the libretv_data volume uses the local driver with bind options to point to a ./data folder in the current working directory.

Configuration details:

• Internal path: /app (do not modify this inside the container)
• Host device path: ${PWD:-.}/data (you can change this to any path you prefer)

services:
  libretv:
    volumes:
      - libretv_data:/app

volumes:
  libretv_data:
    driver: local
    driver_opts:
      type: none
      o: bind
      device: ${PWD:-.}/data

When running LibreTV via Docker, you can set the following environment variable to secure your instance:

• PASSWORD: The access password for the application. If not provided, it defaults to your_password.

The LibreTV container listens on port 8080 internally. In the default docker-compose.yml configuration, this is mapped to host port 8899.

To change the port you use to access the application, modify the ports section:

ports:
  - "<HOST_PORT>:8080"