Català-Valencià – Catalan中文 – Chinese (Simplified)中文 – Chinese (Traditional)Česky – CzechDansk – DanishNederlands – DutchEnglish – EnglishSuomi – FinnishFrançais – FrenchDeutsch – Germanעברית – Hebrewहिंदी – HindiMagyar – HungarianBahasa Indonesia – IndonesianItaliano – Italian日本語 – Japanese한국어 – KoreanМакедонски – Macedonianमराठी – MarathiNorsk – NorwegianPolski – PolishPortuguês – PortuguesePortuguês – Portuguese (Brazil)Русский – RussianSlovenčina – SlovakSlovenščina – SlovenianEspañol – SpanishSvenska – SwedishTürkçe – TurkishУкраїнська – UkrainianOëzbekcha – Uzbek

kapsikkum-unmanic – Blame information for rev 1

Rev	Author	Line No.	Line
1	office	1	Unmanic - Library Optimiser
		2	===========================
		3
		4	
		5
		6	<a href='https://ko-fi.com/I2I21F8E1' target='_blank'><img height='26' style='border:0px;height:26px;' src='https://cdn.ko-fi.com/cdn/kofi1.png?v=2' border='0' alt='Buy Me a Coffee at ko-fi.com' /></a>
		7
		8	[](https://github.com/unmanic/unmanic/releases)
		9	[](https://github.com/unmanic/unmanic/issues?q=is%3Aopen+is%3Aissue)
		10	[](https://github.com/unmanic/unmanic/issues?q=is%3Aissue+is%3Aclosed)
		11	[](https://github.com/unmanic/unmanic/pulls?q=is%3Aopen+is%3Apr)
		12	[](https://github.com/unmanic/unmanic/pulls?q=is%3Apr+is%3Aclosed)
		13
		14	[](https://hub.docker.com/r/josh5/unmanic)
		15	[](https://hub.docker.com/r/josh5/unmanic)
		16	[](https://hub.docker.com/r/josh5/unmanic)
		17
		18
		19
		20
		21	[](https://github.com/unmanic/unmanic/actions?query=workflow%3A%22Python+Lint+%26+Run+Unit+Tests%22+branch%3Amaster)
		22	[](https://github.com/unmanic/unmanic/actions?query=workflow%3A%22Build+All+Packages+CI%22+branch%3Amaster)
		23
		24	[]()
		25	---
		26
		27	Unmanic is a simple tool for optimising your file library. You can use it to convert your files into a single, uniform format, manage file movements based on timestamps, or execute custom commands against a file based on its file size.
		28
		29	Simply configure Unmanic pointing it at your library and let it automatically manage that library for you.
		30
		31	Unmanic provides you with the following main functions:
		32
		33	- A scheduler built in to scan your whole library for files that do not conform to your configured file presets. Files found requiring processing are then queued.
		34	- A file/directory monitor. When a file is modified, or a new file is added in your library, Unmanic is able to again test that against your configured file presets. Like the first function, if this file requires processing, it is added to a queue for processing.
		35	- A handler to manage running multiple file manipulation tasks at a time.
		36	- A Web UI to easily configure, manage and monitor the progress of your library optimisation.
		37
		38	You choose how you want your library to be.
		39
		40	Some examples of how you may use Unmanic:
		41
		42	- Trans-code video or audio files into a uniform format using FFmpeg.
		43	- Identify (and remove if desired) commercials in DVR recordings shortly after they have completed being recorded.
		44	- Move files from one location to another after a configured period of time.
		45	- Automatically execute FileBot rename files in your library as they are added.
		46	- Compress files older than a specified age.
		47	- Run any custom command against files matching a certain extension or above a configured file size.
		48
		49	The Docker container is currently based `linuxserver.io` Ubuntu focal image.
		50
		51	### Table Of Contents
		52
		53	[Dependencies](#dependencies)
		54
		55	[Screen-shots](#screen-shots)
		56	* [Dashboard](#dashboard)
		57	* [File metrics](#file-metrics)
		58	* [Installed plugins](#installed-plugins)
		59
		60	[Install and Run](#install-and-run)
		61
		62	[License and Contribution](#license-and-contribution)
		63
		64
		65	## Dependencies
		66
		67	- Python 3.x ([Install](https://www.python.org/downloads/))
		68	- To install requirements run 'python3 -m pip install -r requirements.txt' from the project root
		69
		70	Unmanic can be used for running many commands. You will need to ensure that the required dependencies for those commands are installed.
		71
		72	## Screen-shots
		73
		74	#### Dashboard:
		75	
		76	#### File metrics:
		77	
		78	#### Installed plugins:
		79	
		80
		81	## Install and Run
		82
		83	For up-to-date installation instructions, follow the [Unmanic documentation](https://docs.unmanic.app/docs/)
		84
		85	To run from source:
		86
		87	1) Install the Python dependencies listed above then run:
		88	2) Run:
		89	```
		90	# Ensure the submodules are checked out
		91	git submodule update --init --recursive
		92
		93	# Build and install the project into your home directory
		94	python3 ./setup.py install --user
		95
		96	# Run Unmanic
		97	unmanic
		98	```
		99
		100	## License and Contribution
		101
		102	This projected is licensed under th GPL version 3.
		103
		104	Copyright (C) Josh Sunnex - All Rights Reserved
		105
		106	Permission is hereby granted, free of charge, to any person obtaining a copy
		107	of this software and associated documentation files (the "Software"), to deal
		108	in the Software without restriction, including without limitation the rights
		109	to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
		110	copies of the Software, and to permit persons to whom the Software is
		111	furnished to do so, subject to the following conditions:
		112
		113	The above copyright notice and this permission notice shall be included in all
		114	copies or substantial portions of the Software.
		115
		116	This project contains libraries imported from external authors.
		117	Please refer to the source of these libraries for more information on their respective licenses.
		118
		119	See [CONTRIBUTING.md](docs/CONTRIBUTING.md) to learn how to contribute to Unmanic.

Powered by WebSVN 2.7.0 and Apache Subversion 1.14.5     ✓ XHTML & CSS