Configuration Reference

This guide provides detailed information about configuring Acestream Scraper.

Contents

• Application Settings
• Environment Variables
• Channel Status Checking
• Port Mapping
• Volumes
• ZeroNet Configuration
• Running Behind a Reverse Proxy
• Security Considerations
• Healthchecks

Application Settings

Acestream Scraper can be configured through the setup wizard or directly by editing configuration files.

Setup Wizard

When first accessing the application at http://localhost:8000, you'll be guided through the setup process if no configuration exists:

1. Configure Base URL format
2. Set Acestream Engine URL
3. Add source URLs to scrape
4. Set rescrape interval

Manual Configuration

Create or edit config/config.json:

{
    "urls": [
        "https://example.com/url1",
        "https://example.com/url2"
    ],
    "base_url": "http://localhost:6878/ace/getstream?id=",
    "ace_engine_url": "http://localhost:6878",
    "rescrape_interval": 24
}

Key Settings

• urls: Array of URLs to scrape for Acestream channels
• base_url: Base URL format for playlist generation
  • acestream:// - For players with Acestream protocol support
  • http://localhost:6878/ace/getstream?id= - For local HTTP streaming
  • http://server-ip:acexy_port/ace/getstream?id= - For using built-in Acexy proxy
• ace_engine_url: URL of your Acestream Engine instance
• rescrape_interval: Hours between automatic rescans of URLs

Environment Variables

Core Application

Variable	Description	Default	Notes
FLASK_PORT	Port the Flask application runs on	8000	Can be changed if port 8000 is in use
FLASK_ENV	Flask environment mode	production	Use development for debugging

Acestream Configuration

Variable	Description	Default	Notes
ENABLE_ACESTREAM_ENGINE	Enable built-in Acestream Engine	Matches ENABLE_ACEXY	Set to true to run Acestream in the container
ACESTREAM_HTTP_PORT	Port for Acestream engine	6878	Internal Acestream Engine HTTP port
ACESTREAM_HTTP_HOST	Host for Acestream engine	Uses ACEXY_HOST	Address to access Acestream Engine
ALLOW_REMOTE_ACCESS	Allow remote connections to Acestream	no	Set to yes to allow external connections

Acexy Configuration

Variable	Description	Default	Notes
ENABLE_ACEXY	Enable Acexy proxy	false	Set to true to enable enhanced Acestream proxy
ACEXY_LISTEN_ADDR	Address for Acexy to listen on	:8080	Format is [host]:port or just :port
ACEXY_HOST	Hostname of Acestream Engine	localhost	Hostname or IP where Acestream Engine runs
ACEXY_PORT	Port of Acestream Engine	6878	Port where Acestream Engine is accessible
ACEXY_NO_RESPONSE_TIMEOUT	Timeout for Acestream responses	15s	Format: 15s, 1m, etc.
ACEXY_BUFFER_SIZE	Buffer size for data transfers	5MiB	Format: 5MiB, 10MiB, etc.

Why Both Acexy and Acestream Engine?

Acestream Scraper includes both Acexy and Acestream Engine for improved multi-client handling:

1. Connection Management: When multiple clients access the same stream, each needs a unique process ID (PID)
2. Automatic PID Handling: Acexy automatically adds the required pid=id parameter to stream requests
3. Error Isolation: With proper PID management, one client disconnecting won't affect others
4. Simplified URLs: End users don't need to worry about adding PID parameters manually
5. Performance: Acexy includes buffering mechanisms to improve streaming performance

Without Acexy, you'd need to manually append &pid={unique_id} to each stream URL to properly handle multiple connections. When a stream ends for one client, without this parameter, it might terminate the stream for all users. Acexy transparently manages these connections, making the system more robust for multi-user environments.

ZeroNet and Other Settings

Variable	Description	Default	Notes
ENABLE_TOR	Enable TOR for ZeroNet connections	false	Set to true to use TOR with ZeroNet
TZ	Timezone for the container	Europe/Madrid	Use any valid TZ identifier
DOCKER_ENVIRONMENT	Mark as running in Docker	true	Used for internal path configuration

Channel Status Checking

The application verifies if channels are available:

1. Ensure you have Acestream Engine running (built-in if ENABLE_ACESTREAM_ENGINE=true)
2. Configure ace_engine_url to point to your Acestream Engine instance
3. Use the "Check Status" buttons in the UI to verify channel availability

Status Tracking

• The application maintains history of status checks
• Status is color-coded in the interface (green = online, red = offline)
• Error messages are displayed when a channel cannot be accessed

Port Mapping

When using Docker, map these ports as needed:

Port	Service	Notes
8000	Main web interface	Configurable via FLASK_PORT
8080	Acexy web interface	Only if Acexy is enabled
6878	Acestream HTTP API	Configurable via ACESTREAM_HTTP_PORT
43110	ZeroNet web interface	Only if ZeroNet is enabled
43111	ZeroNet transport port	Only if ZeroNet is enabled
26552	Additional ZeroNet peer port	Only if ZeroNet is enabled
8621	Acestream P2P port	For Acestream peer connections

Volumes

When using Docker, mount these volumes:

Container Path	Purpose	Notes
/app/config	Configuration files	Contains config.json and database
/app/ZeroNet/data	ZeroNet data directory	Only required if using ZeroNet

Example mount:

docker run -v "${PWD}/config:/app/config" -v "${PWD}/zeronet_data:/app/ZeroNet/data" ...

ZeroNet Configuration

The application looks for a zeronet.conf file in the /app/config directory.

Default Configuration

If no configuration file exists, this default is created:

[global]
ui_ip = *
ui_host =
 0.0.0.0
 localhost
ui_port = 43110

Custom Configuration

Create your own config/zeronet.conf:

[global]
ui_ip = *
ui_host =
 127.0.0.1
 your.domain.com
 localhost
ui_port = 43110

Running Behind a Reverse Proxy

The application includes proper headers handling for running behind a reverse proxy:

• Automatic handling of SSL/TLS termination
• Correct handling of X-Forwarded-Proto and X-Forwarded-Host headers
• Works with nginx, Apache, Traefik or other reverse proxies

Nginx Example

server {
    listen 80;
    server_name acestream.example.com;

    location / {
        proxy_pass http://localhost:8000;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
    }
}

Security Considerations

• Add your domain(s) to ui_host in ZeroNet config for public access
• Always include localhost in ui_host for local access
• Set ALLOW_REMOTE_ACCESS=no to restrict Acestream access to localhost only
• Consider using a reverse proxy with SSL/TLS for secure access
• Be aware of copyright and legal considerations when sharing playlists

Healthchecks

The container includes comprehensive health checks:

• Main application health check at /health endpoint
• Acexy health check (if enabled)
• Acestream Engine health check (if enabled)
• Automatic monitoring of internal services
• Graceful handling of service dependencies

Docker Health Check

The Docker container is configured with a health check that verifies all services are running correctly:

healthcheck:
  test: ["CMD", "/app/healthcheck.sh"]
  interval: 30s
  timeout: 10s
  retries: 3
  start_period: 60s

You can check the health status with: docker inspect --format='{{.State.Health.Status}}' acestream-scraper