{"id":25519846,"url":"https://github.com/sniperwolf/mjdr","last_synced_at":"2025-12-22T20:30:13.834Z","repository":{"id":277195270,"uuid":"931232389","full_name":"sniperwolf/mjdr","owner":"sniperwolf","description":"MJDR (My Jellyfin Docker Runner)","archived":false,"fork":false,"pushed_at":"2025-02-12T17:09:33.000Z","size":55,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-12T17:27:26.500Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sniperwolf.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":"SUPPORT.md","governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-02-11T23:45:28.000Z","updated_at":"2025-02-12T16:12:10.000Z","dependencies_parsed_at":"2025-02-12T17:37:34.013Z","dependency_job_id":null,"html_url":"https://github.com/sniperwolf/mjdr","commit_stats":null,"previous_names":["sniperwolf/mjdr"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sniperwolf%2Fmjdr","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sniperwolf%2Fmjdr/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sniperwolf%2Fmjdr/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sniperwolf%2Fmjdr/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sniperwolf","download_url":"https://codeload.github.com/sniperwolf/mjdr/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239704811,"owners_count":19683540,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-02-19T17:36:22.754Z","updated_at":"2025-12-22T20:30:13.778Z","avatar_url":"https://github.com/sniperwolf.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# MJDR (My Jellyfin Docker Runner)\n\n[![Test and Coverage](https://github.com/sniperwolf/mjdr/actions/workflows/test.yml/badge.svg)](https://github.com/sniperwolf/mjdr/actions/workflows/test.yml)\n[![codecov](https://codecov.io/gh/sniperwolf/mjdr/branch/main/graph/badge.svg)](https://codecov.io/gh/sniperwolf/mjdr)\n\nMJDR is a shell-based tool designed to manage Jellyfin media server in Docker containers. It provides an\neasy-to-use interface for starting, stopping, and managing your Jellyfin instance with proper error handling and system\nchecks.\n\n## Features\n\n- Cross-platform support (Linux, macOS, Windows with WSL/Git Bash)\n- Automatic network detection and configuration\n- System requirements verification\n- Easy backup and restore functionality\n- Debug mode for troubleshooting\n- QR code generation for mobile access\n- Comprehensive error handling\n- ShellCheck compliant code\n\n## Prerequisites\n\n- Docker (20.10.0 or newer)\n- Docker Compose V2\n- Jellyfin Docker image\n- Bash shell (4.0 or newer)\n\n## Installation\n\n1. Clone the repository:\n\n```bash\ngit clone https://github.com/sniperwolf/mjdr.git\ncd mjdr\n```\n\n2. Install dependencies and setup development environment:\n\n```bash\nmake install\n```\n\n3. Create your \".env\" file:\n\n```bash\ncp .env.example .env\n```\n\n4. Edit the \".env\" file with your configuration:\n\n```bash\n\n# Container configuration\n\nCONTAINER_NAME=jd\nJELLYFIN_PORT=8096\nJELLYFIN_HTTPS_PORT=8920\nJELLYFIN_DISCOVERY_PORT=7359\nJELLYFIN_DLNA_PORT=1900\n\n# Path configuration - Unix/MacOS example\n\n#USB_MOUNT_PATH=/Volumes/MediaDrive\n#MEDIA_PATH=/Volumes/MediaDrive/media\n#CONFIG_PATH=/Volumes/MediaDrive/config\n#DOCKER_COMPOSE_FILE=/Users/username/mjdr/jd.yaml\n\n# Path configuration - Windows example\n\nUSB_MOUNT_PATH=D:/MediaDrive\nMEDIA_PATH=D:/MediaDrive/media\nCONFIG_PATH=D:/MediaDrive/config\nDOCKER_COMPOSE_FILE=C:/Users/username/mjdr/jd.yaml\n\n# Network configuration\n\nJELLYFIN_PUBLISHED_URL=http://localhost:8096\n\n# Optional features\n\nENABLE_HTTPS=false\nENABLE_DLNA=true\n\n```\n\n## Usage\n\n### Using Make Commands\n\nThe project includes a Makefile for common operations:\n\n```bash\n# Show available commands\nmake help\n\n# Install dependencies\nmake install\n\n# Run tests\nmake test\n\n# Run specific test suites\nmake test-unit\nmake test-integration\n\n# Run linting (ShellCheck)\nmake lint\n\n# Generate coverage report\nmake coverage\n\n# Start Jellyfin\nmake start\n\n# Stop Jellyfin\nmake stop\n\n# Start in debug mode\nmake debug\n\n# Clean temporary files\nmake clean\n```\n\n### Manual Usage\n\nIf you prefer not to use Make, you can run the scripts directly:\n\n### Starting Jellyfin\n\n```bash\n./start-jellyfin.sh\n# or with debug mode\n./start-jellyfin.sh --debug\n```\n\n### Stopping Jellyfin\n\n```bash\n./stop-jellyfin.sh\n# or with debug mode\n./stop-jellyfin.sh --debug\n```\n\n## Project Structure\n\n```\nmjdr/\n├── libs/                   # Library modules\n│   ├── colors.sh           # Color definitions and basic utilities\n│   ├── docker.sh           # Docker operations\n│   ├── filesystem.sh       # Filesystem operations\n│   ├── network.sh          # Network detection and configuration\n│   ├── os_detect.sh        # OS detection and system checks\n│   └── ui.sh               # User interface functions\n├── tests/                  # Test files\n│   ├── unit/               # Unit tests\n│   ├── integration/        # Integration tests\n│   ├── fixtures/           # Test fixtures\n│   └── helpers/            # Test helpers\n├── start-jellyfin.sh       # Main startup script\n├── stop-jellyfin.sh        # Main shutdown script\n├── jd.yaml                 # Docker Compose configuration\n├── .env                    # Your custom environment configuration\n├── .env.example            # Example environment configuration\n├── Makefile                # Make commands for common operations\n└── README.md               # This file\n```\n\n## Development\n\n### Running Tests\n\nThe project uses BATS (Bash Automated Testing System) for testing:\n\n```bash\n# Install test dependencies\nmake install\n\n# Run all tests\nmake test\n\n# Run specific test suites\nmake test-unit\nmake test-integration\n\n# Generate coverage report\nmake coverage\n```\n\n### Adding New Shell Scripts\n\nWhen adding new shell scripts, remember to make them executable and track the permission in git:\n\n```bash\nchmod +x script.sh\ngit add --chmod=+x script.sh\n```\n\n### Coding Standards\n\n- All shell scripts must pass ShellCheck validation\n- Follow the existing code style and documentation patterns\n- Add comments for complex operations\n- Update documentation when adding new features\n- Write meaningful commit messages\n\n## Contributing\n\nContributions are welcome! Please follow these steps:\n\n1. Fork the repository\n2. Create a feature branch (\"git checkout -b feature/amazing-feature\")\n3. Make your changes\n4. Run tests and linting:\n\n```bash\nmake test\n```\n\n5. Commit your changes (\"git commit -m 'feat: add amazing feature'\")\n6. Push to the branch (\"git push origin feature/amazing-feature\")\n7. Open a Pull Request\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## Acknowledgments\n\n- [Jellyfin](https://jellyfin.org/) for the amazing media server\n- [ShellCheck](https://www.shellcheck.net/) for the static analysis tool\n- [BATS](https://github.com/bats-core/bats-core) for the testing framework\n- All contributors who help improve this project\n\n## Support\n\nIf you encounter any problems or have suggestions, please:\n\n1. Check the debug output using \"--debug\" flag\n2. Check the [Issues](https://github.com/sniperwolf/mjdr/issues) page\n3. Open a new issue if needed\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsniperwolf%2Fmjdr","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsniperwolf%2Fmjdr","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsniperwolf%2Fmjdr/lists"}