linkarr - GitLite

KO | EN

gitlite — search

#python #react #typescript #golang #linux #nodejs #macos #awesome #kubernetes #vue #ios #mcp #openai #open-source

linkarr

(★ 109)

Organize your media library with ease - without moving or duplicating your files!

파일 탐색기

최종 버전 다운로드 (.zip)

- - build-and-deploy.yml
- developing.md
- logo.png
- todo.md
- - __init__.py
  - config.py
  - config.schema.json
  - helpers.py
  - main.py
  - models.py
  - watch.py
- test_base_parser.py
- test_movie_parser.py
- test_tv_parser.py
.gitignore
config.example.json
Dockerfile
LICENSE.md
README.md
requirements.dev.txt
requirements.txt

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/itsmejoeeey/linkarr

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd linkarr

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Docker

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Docker Desktop 컨테이너를 빌드하고 실행하려면 필요합니다. 설치 후 실행해서 백그라운드에 켜두세요.

docker run -d \

빌드된 이미지를 실제 컨테이너로 실행합니다.

✅ 터미널에 docker compose ps 를 입력해 컨테이너들이 Up 상태인지 확인하세요. README에 포트 번호가 적혀있다면 브라우저에서 http://localhost:포트번호 로 접속해보세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

3. Python

쉬움

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Python 3 설치 시 'Add Python to PATH' 옵션을 꼭 체크하세요 (Windows).

python -m venv venv

파이썬 스크립트(또는 모듈)를 실행합니다.

pip install -r requirements.txt

requirements.txt 등에 명시된 파이썬 라이브러리를 설치합니다.

python -m linkarr.main ../config.json

파이썬 스크립트(또는 모듈)를 실행합니다.

✅ 에러 메시지 없이 실행되고 터미널에 안내 문구가 출력되면 정상입니다.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<img width="128px" src="./docs/logo.png" alt="Linkarr"></img>

# Linkarr - Media Organizer

Organize your media library with ease - **without moving or duplicating your files!**

- 📦 **No file moving/copying:** Monitors for changes, and then organizes your media with symlinks only.
- 🧲 **Perfect for seeding/usenet:** Works with files managed by torrent or usenet clients.
- 🎬 **Jellyfin ready:** Import organized folders directly into your media server.
- 🐳 **Easy Docker deployment:** Run anywhere, just map your folders.

<br />

_Example:_

|   | 📂 **Before (Source Folder)** | 📂 **After (Organized Folder)** |
|---|-----------------------------|-------------------------------|
| TV | `/media/TV/`<br>└─ 📂`Show.Name.S01/`<br>&nbsp;&nbsp;&nbsp;&nbsp;├── `Show.Name.S01E01.1080p.mkv`<br>&nbsp;&nbsp;&nbsp;&nbsp;└── `Show.Name.S01E02.1080p.mkv`<br>└─📂 `Show.Name.S02/`<br>&nbsp;&nbsp;&nbsp;&nbsp;├── `Show.Name.S02E01.1080p.mkv`<br>&nbsp;&nbsp;&nbsp;&nbsp;└── `Show.Name.S02E02.1080p.mkv`<br>└── `Another.Show.Name.S04E07.1080p.mkv` | `/organized/TV/`<br>└─🗂️ `Show Name/`<br>&nbsp;&nbsp;&nbsp;&nbsp;└─📂 `Season 01/`<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;├─🔗 `Show.Name.S01E01.1080p.mkv`<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;└─🔗 `Show.Name.S01E02.1080p.mkv` <br>&nbsp;&nbsp;&nbsp;&nbsp;└─📂 `Season 02/`<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;├─🔗 `Show.Name.S02E01.1080p.mkv`<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;└─🔗 `Show.Name.S02E02.1080p.mkv` <br>└─🗂️ `Another Show Name/`<br>&nbsp;&nbsp;&nbsp;&nbsp;└─📂 `Season 04/`<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;└─🔗 `Show.Name.S04E07.1080p.mkv`  |
| Movies | `/media/Movies/`<br>└─📂 `Movie.Title.2023.1080p/`<br>&nbsp;&nbsp;&nbsp;&nbsp;└── `Movie.Title.2023.1080p.mkv`<br>└── `Another.Movie.Title.2024.1080p.mkv` | `/organized/Movies/`<br>└─📂 `Movie Title (2023)/`<br>&nbsp;&nbsp;&nbsp;&nbsp;└─🔗 `Movie.Title.2023.1080p.mkv` <br>└─📂 `Another Movie Title (2024)/`<br>&nbsp;&nbsp;&nbsp;&nbsp;└─🔗 `Another.Movie.Title.2024.1080p.mkv` |

---

## Getting started
### 🚀 Docker Usage (Recommended)

[![Docker Hub](https://dockerico.blankenship.io/image/itsmejoeeey/linkarr)](https://hub.docker.com/r/itsmejoeeey/linkarr)

You will need [Docker](https://docs.docker.com/get-docker/) installed on your system.

> **Important:** You must map your source and destination folders to the **same paths inside the container as on your host system**. This ensures symlinks work correctly.

```bash
docker run -d \
  -v /path/to/source:/path/to/source \
  -v /path/to/organized:/path/to/organized \
  -v $(pwd)/config.json:/config/config.json \
  itsmejoeeey/linkarr:latest
```

Or with Docker Compose:

```yaml
services:
  my-linkarr:
    image: itsmejoeeey/linkarr:latest
    container_name: linkarr
    # Pass in your config file below, by specifying the path on your host machine
    volumes:
      - /path/to/source:/path/to/source
      - /path/to/organized:/path/to/organized
      - ./config.json:/config/config.json
    restart: unless-stopped
```

> See [Configuration](#) for details on configuring.

- Make sure to provide a valid `config.json`.
   - Replace `/path/to/source` and `/path/to/organized` with your actual media paths.

### Running manually

1. Install dependencies:
   ```bash
   python -m venv venv
   source venv/bin/activate
   pip install -r requirements.txt
   ```

2. Copy and edit the example config:
   ```bash
   cp config.example.json config.json
   # Edit config.json to match your source/destination folders and preferences
   ```

3. Run the organizer:
   ```bash
   cd src
   python -m linkarr.main ../config.json
   ```

## Configuration

See [`config.example.json`](/config.example.json) and [`src/linkarr/config.schema.json`](/src/linkarr/config.schema.json) for configuration options.

## Development

See [here for further information.](/docs/developing.md)