Installation - sureshfizzy/CineSync GitHub Wiki

Installation Guide

Requirements

Python 3.x
Git
TMDb API Key

Docker Installation

Pull Docker Image

# Pull the latest CineSync image
docker pull sureshfizzy/cinesync

Docker Compose Installation (Recommended)

Create docker-compose.yml

Create a docker-compose.yml file with the following configuration:

services:
  cinesync:
    image: sureshfizzy/cinesync:latest
    container_name: cinesync
    restart: unless-stopped
    environment:
      - PUID=1000
      - PGID=1000
    volumes:
      - /home:/home  # Mount home directory to provide access to home files
      - /mnt:/mnt  # Mount /mnt for access to external storage
      - ./db:/app/db  # Mount local db folder to persist database files
      - ./.env:/app/.env

To prevent permission issues, update the PUID (Personal User ID) and GUID (Group ID) based on your system configuration. You can find these values by running the id command in your terminal. Make sure to adjust the configuration accordingly to match the correct PUID and GUID for your environment.

Run Docker Compose

# Pull the latest image
docker compose pull cinesync

# Start the container in detached mode
docker compose up -d cinesync

# View logs
docker compose logs -f cinesync

Additional Docker Management Commands

# Stop the container
docker compose down cinesync

# Update to the latest version
docker compose pull cinesync
docker compose up -d cinesync

# Check container status
docker compose ps cinesync

Supported Architectures

amd64 (x86_64)
arm64 (aarch64)

Notes

Ensure you have Docker and Docker Compose installed
Mount directories with appropriate read/write permissions
Keep your .env file properly configured

For Linux:

Here's an enhanced version of the instructions:

Clone the Repository: Clone the CineSync repository from GitHub and navigate to the cloned directory:
```
git clone https://github.com/sureshfizzy/CineSync.git && cd CineSync
```
Update Paths in .env: Open the .env file located inside the CineSync folder. Update the following paths:
- SOURCE_DIR: Specify the path for the Source directory.
- DESTINATION_DIR: Set the ultimate destination directory where you want to save the symbolic links.
- TMDB_API_KEY: Enter your TMDb API key to access TMDb services.
Note: Ensure that the paths are correctly updated to reflect your system's configuration.
Execute CineSync: After updating the paths, execute the main script:
- For Linux:
```
python3 CineSync.py
```
- For Windows:
```
python CineSync.py
```
This will launch the CineSync interface, allowing you to perform various library management tasks, including full library scans, real-time monitoring, and more.

By following these steps and updating the necessary paths, you'll be able to successfully use CineSync to manage your debrid library.

For Windows:

Install Python: Install Python from the official website: Python.org. Make sure to add Python to your system PATH during installation.
Install Git Bash: Install Git Bash from Git for Windows. During installation, enable the symbolic links checkbox.

Git Bash

Enabling symbolic links is important for certain operations, so ensure that the checkbox for symbolic links is checked during installation.

Edit .bashrc (Windows): Open Git Bash as an administrator and edit the .bashrc file. You can use the nano editor to open the file by running the following command:
```
nano /etc/bash.bashrc
```
Add the following line at the bottom of the file:
```
export MSYS=winsymlinks:nativestrict
```
Save the changes by pressing Ctrl + O, then press Enter to confirm. Exit the editor by pressing Ctrl + X.

Important: Ensure that the export MSYS=winsymlinks:nativestrict line is added to the .bashrc file. This configuration is essential to ensure that symbolic links are handled correctly on Windows when using Git Bash. Without this setting, CineSync may copy files instead of creating symbolic links, leading to undesired behavior.
Enable Windows Developer Mode:

Enabling Developer Mode grants your system additional privileges necessary for certain operations, helping to prevent permission-related errors during development.

To avoid "Operation not permitted" errors during symlink process, it's essential to enable Windows Developer Mode. Follow these steps:
- Open Settings.
- Go to Update & Security.
- Click on For developers.
- Enable the Developer mode option.
- Restart the PC

Clone the Repository:

git clone https://github.com/sureshfizzy/CineSync.git

Update Paths in .env: Open the .env file located inside the CineSync folder. Update the following paths:
- SOURCE_DIR: Specify the path for the Source directory.
- DESTINATION_DIR: Set the ultimate destination directory where you want to save the symbolic links.
- TMDB_API_KEY: Enter your TMDb API key to access TMDb services.
Note: Ensure that the paths are correctly updated to reflect your system's configuration.
Run the Script:
- For Linux:
```
python3 CineSync.py
```
- For Windows:
```
python CineSync.py
```

Additionally, you can also directly run the Python script on Git Bash.