Sootio Stremio Addon

The server uses fuse-archive (Google's universal archive mounting tool) to provide transparent access to compressed files without manual extraction. This saves disk space and time.

Key Details:

• Mount Point: Files are served from /mnt/archivefs.
• Supported Formats: RAR (including multi-part), 7z, ZIP, TAR (.tar.gz, .tar.bz2, .tar.xz), ISO, CPIO, and more via libarchive.
• Docker Requirements: You must run the container with the --privileged flag OR use --device /dev/fuse --cap-add SYS_ADMIN to grant FUSE access.

The Python file server validates access using three possible methods. The Node.js server automatically includes the password from your configuration in these formats:

1. HTTP Header: X-API-Key: <password>
2. Query Parameter: ?key=<password> (useful for direct browser or app access)
3. Authorization Header: Authorization: Bearer <password>

Security Note: Because the password is sent in the addon URL, you should use HTTPS in production environments. You can provide different passwords to different users by generating unique addon URLs.

To contribute to or develop Sootio, clone the repository, install dependencies using pnpm, and use the provided scripts to run the development server or tests.

# Clone and install
git clone https://github.com/your-username/sootio-stremio-addon.git
cd sootio-stremio-addon
pnpm install

# Run in development mode
npm run dev

# Run tests (if available)
npm test

If you encounter errors like database disk image is malformed, use the recover-sqlite.sh script.

Recovery process:

1. Creates a backup of the corrupted database.
2. Attempts to checkpoint the WAL (Write-Ahead Log) file.
3. Runs integrity checks.
4. Attempts to rebuild from recoverable data.
5. If recovery fails, it creates a fresh database.

Note: The script automatically restarts the container after recovery. If the database was too corrupted to recover, the cache will be empty and will repopulate as you use the addon.

Environment Variables:

• SOOTIO_CONTAINER: Specify a custom Docker container name (defaults to sootio).

# Recover cache.db (most common)
./scripts/recover-sqlite.sh cache.db

# Recover hash-cache.db
./scripts/recover-sqlite.sh hash-cache.db

# Use custom container name
SOOTIO_CONTAINER=my-sootio ./scripts/recover-sqlite.sh cache.db

The easiest way to serve Usenet files is using the included Python script. It has zero dependencies (uses Python's built-in HTTP server), supports range requests (enabling seeking), and has CORS enabled for remote access.

Basic Usage: Run the script on your SABnzbd machine pointing to your video directory:

python3 usenet_file_server.py /home/sooti/Videos

Command-line options:

• --port <port>: Specify a custom port.
• --bind <address>: Bind to a specific interface. Use 127.0.0.1 for localhost only (more secure) or 0.0.0.0 to allow remote connections.

# Custom port
python3 usenet_file_server.py /home/sooti/Videos --port 9000

# Localhost only (more secure)
python3 usenet_file_server.py /home/sooti/Videos --bind 127.0.0.1

# Allow remote connections
python3 usenet_file_server.py /home/sooti/Videos --bind 0.0.0.0

The Media File Server can be used in two primary ways within Stremio via the Sootio addon.

Home Media Server (HM+)

Use this for your personal media library.

1. Start the file server on port 3003.
2. In Stremio addon configuration, add a service:
   • Provider: Home Media Server
   • Server URL: http://your-server-ip:3003
   • API Key: Your configured API key.
3. Files will appear in Stremio with a ☁️ cloud icon.

Usenet (UN+)

Use this with SABnzbd for automated downloads.

1. Configure SABnzbd to download to your target directory.
2. Start the file server pointing to that directory.
3. In the Stremio addon, configure Usenet with:
   • Newznab URL & API Key
   • SABnzbd URL & API Key
   • File Server URL: http://your-server-ip:3003
4. New downloads will be queued in SABnzbd and streamed as soon as they are complete.

To handle high loads, Sootio supports multi-worker clustering. You can run the application in different modes depending on your environment:

• Single process: Use this for debugging purposes to avoid the complexity of multiple workers.
• Multi-worker (Default): Use npm start to launch with default worker settings.
• Custom worker count: Set the MAX_WORKERS environment variable to specify the number of workers.

# Single process (debugging)
npm run standalone

# Multi-worker with default settings
npm start

# Custom worker count
MAX_WORKERS=16 npm start

You can modify scripts/test-http-streams-status.mjs to change the testing parameters:

1. Change test content: Update the TEST_MOVIE object with a different imdbId, title, and type.
2. Add/remove providers: Modify the PROVIDERS array to include or exclude specific provider functions.
3. Change timeout: Adjust the timeout variable (e.g., 60000 for 60 seconds).

// Example customization in scripts/test-http-streams-status.mjs

const TEST_MOVIE = {
  imdbId: 'tt1375666',  // Inception instead
  title: 'Inception',
  type: 'movie'
};

const PROVIDERS = [
  { name: 'CineDoze', fn: getCineDozeStreams },
];

const timeout = 60000; // 60 seconds