slskd/slskd

Features

• Peer-to-Peer File Sharing - Acts as a distributed server that manages shared directories and facilitates peer-to-peer file transfers.
• Network File Search - Provides the core utility to search the Soulseek network for files matching defined terms.
• Credential Authentication - Authenticates network access to the Soulseek network using registered usernames and passwords.
• Central Coordinator Connections - Provides a utility to specify the address and port for connecting to the Soulseek central coordinator.
• Headless Network Daemons - Functions as a headless background service for network participation, controlled via API or web UI.
• P2P Network API Gateways - Provides a REST API gateway for remotely managing network connections, downloads, and user profiles.
• Network Clients - Implements a network client for searching and sharing files on the Soulseek network.
• Share Enumeration - Enables browsing and listing of files shared by other users across the Soulseek network.
• P2P Shared Directory Configuration - Allows configuration of shared directories with support for absolute paths and exclusion filters.
• Peer-to-Peer Messaging - Implements both private one-on-one messaging and participation in public network chat rooms.
• API Key Authentication - Verifies programmatic API access using long-lived authentication keys.
• JSON Web Tokens - Generates JSON Web Tokens to maintain stateless user sessions for the API and web UI.
• JWT Authentication - Uses JSON Web Tokens to secure the web interface and API following user authentication.
• Token-based Authorization - Authorizes REST API requests using unique keys passed in HTTP headers with IP restrictions.
• Download Priority Queues - Implements a download queue to track transfers and control retries, cancellations, and completions.
• Web Form Authentication - Implements web-based login forms and session tokens to control access to the web interface.
• Scan Caching Systems - Caches file system scan results in memory or on disk to accelerate shared content discovery.
• Privacy-Focused - Uses directory aliases to share files while concealing the actual absolute paths on the host system.
• Event-Driven Scripting - Triggers custom system scripts by passing internal event data as environment variables.
• Webhook Notification Systems - Dispatches outbound JSON POST requests to external endpoints to notify them of specific system events.
• Remote Configuration File Operations - Provides API endpoints to remotely retrieve and update the application's YAML configuration file.
• Multi-Source Configuration - Supports loading configuration from environment variables, YAML files, and command-line arguments with override logic.
• Container Deployment - Ships with containerization support including configurable ports, volume mounts, and user permissions.
• Containerized P2P Clients - Ships as a dockerized implementation with built-in support for volume mapping and environment configuration.
• Headless Execution Modes - Offers a headless execution mode that disables the web interface for API-only control.
• Traffic Priority Groups - Assigns users to groups with specific upload priorities and speed limits.
• Shared File Filtering - Uses regular expressions to exclude specific files from being visible to the network.
• SOCKS5 - Provides a SOCKS5 client to route outgoing network traffic through a proxy server for identity masking.
• Network Listeners - Configures the local IP address and port to listen for incoming peer connections.
• Transfer Concurrency Controls - Caps the total number of concurrent transfers and their global speeds.
• P2P Network Participation - Allows limiting child connections to balance bandwidth and connectivity during network participation.
• Peer Connection Management - Manages the coordination of parent and child nodes to control search request delivery.
• Per-User Transfer Quotas - Restricts the number of files or megabytes a single user can enqueue periodically.
• Container Volume Bindings - Supports mapping host directories to the container to register them as shared folders.
• Automated Blocklist Subscriptions - Automatically fetches and merges external P2P, DAT, or CIDR formatted blocklists.
• IP Blacklisting - Blocks specific users or IP ranges from searching, browsing, or messaging.
• YAML Configuration Files - Manages application settings via YAML files with support for environment variable overrides.
• Concurrent Task Limiters - Limits concurrent search tasks to prevent system overload and manage resource consumption.
• Download Retry Policies - Implements automated download resumption with configurable delays and exponential backoff for failed transfers.
• External Process Triggers - Triggers external system processes or webhooks in response to monitored internal events.
• External Script Execution - Executes external system scripts or webhooks in response to internal events by passing state data.
• User Group Management - Organizes network users into groups to apply specific priority and queue strategies.
• Library Management and Transfer - Modern client-server application for the Soulseek network.

Star history