Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/BrenekH/encodarr
Self-hosted web app for encoding files to a target format using distributed computing.
https://github.com/BrenekH/encodarr
automation docker encoding ffmpeg go golang golang-application homeserver media react transcoding typescript video
Last synced: 7 days ago
JSON representation
Self-hosted web app for encoding files to a target format using distributed computing.
- Host: GitHub
- URL: https://github.com/BrenekH/encodarr
- Owner: BrenekH
- License: mpl-2.0
- Created: 2020-06-13T03:01:32.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-06-19T21:58:52.000Z (5 months ago)
- Last Synced: 2024-08-02T15:47:24.520Z (3 months ago)
- Topics: automation, docker, encoding, ffmpeg, go, golang, golang-application, homeserver, media, react, transcoding, typescript, video
- Language: Go
- Homepage:
- Size: 6.02 MB
- Stars: 59
- Watchers: 2
- Forks: 6
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
## What is Encodarr?
Encodarr is a self-hosted web application that encodes video files to a target format using distributed computing to spread the workload across many machines.
## Why use Encodarr?
### Easy to Setup
Encodarr bypasses the need to share media across the network by instead transmitting the file to be operated on to the Runners.
This means that Encodarr is much easier to setup than other solutions.
### Cross-platform
Both the Controller and Runner can be cross-compiled for any system [supported by the Go toolchain](https://gist.github.com/asukakenji/f15ba7e588ac42795f421b48b8aede63) including Raspberry Pis and M1 Macs.
## Dependencies
The container images come with the dependencies installed, so if you go that route, all you need is [Docker](https://docs.docker.com/get-docker/).
If you are not using containers, you will need [mediainfo](https://mediaarea.net/en/MediaInfo/Download) and [FFmpeg](https://ffmpeg.org/download.html) in the [PATH](https://en.wikipedia.org/wiki/PATH_(variable)) variable.
## Installing
Container images are available from Docker Hub([Controller](https://hub.docker.com/r/brenekh/encodarr-controller), [Runner](https://hub.docker.com/repository/docker/brenekh/encodarr-runner)) and the GitHub Container Registry([Controller](https://github.com/users/BrenekH/packages/container/package/encodarr-controller), [Runner](https://github.com/users/BrenekH/packages/container/package/encodarr-runner)).
Pre-built executables are available via the [Releases](https://github.com/BrenekH/encodarr/releases/latest) page.
## Usage
### Docker/Docker Compose
The latest Controller version can be run using the following `docker run` command:
```bash
docker run -d \
--name Encodarr-Controller \
-e TZ=Europe/London \
-v :/config:rw \
-v :/media:rw \
-p 8123:8123 \
--restart unless-stopped \
--user 1000:1000 \
brenekh/encodarr-controller:latest
```
or if you prefer Docker Compose:
```yml
version: "2.2"
services:
encodarr-controller:
image: brenekh/encodarr-controller:latest
container_name: Encodarr-Controller
environment:
- TZ=Europe/London
volumes:
- :/config:rw
- :/media:rw
ports:
- 8123:8123
restart: unless-stopped
user: "1000:1000"
```
The latest Runner version is similar.
Docker run:
```bash
docker run -d \
--name Encodarr-Runner \
-v :/config:rw \
-e TZ=Europe/London
-e "ENCODARR_RUNNER_NAME=Runner 1" \
-e ENCODARR_RUNNER_CONTROLLER_IP= \
-e ENCODARR_RUNNER_CONTROLLER_PORT=8123 \
--restart unless-stopped \
brenekh/encodarr-runner:latest
```
Docker Compose:
```yml
version: "2.2"
services:
encodarr-runner:
image: brenekh/encodarr-runner:latest
container_name: Encodarr-Runner
volumes:
- :/config:rw
environment:
- TZ=Europe/London
- ENCODARR_RUNNER_NAME=Runner 1
- ENCODARR_RUNNER_CONTROLLER_IP=
- ENCODARR_RUNNER_CONTROLLER_PORT=8123
restart: unless-stopped
```
The Controller `path to media` and the corresponding mount inside the container can be anything you want and you can have as many as you want.
For example, `/mnt/disk/tv:/tv:rw` and `/mnt/disk/movies:/movies:rw`.
In addition, the paths to data that are mounted to `/config` in the container should be separate folders, ideally with full paths\(`/home/user/docker` instead of `~/docker`\).
### Startup Configuration
Startup values configured either through environment variables, or command line arguments.
All of the command line variants expect a value after a space (`--port 8123`).
#### Controller
`ENCODARR_PORT`, `--port` sets the port for the HTTP web server.
For containers, it is recommended to modify the external port (`8124:8123`) instead of setting this value.
(default: `8123`)
`ENCODARR_CONFIG_DIR`, `--config-dir` sets the directory that the configuration files are saved to.
This includes the log file.
In a container, this is pre-set to `/config`.
(default: `/encodarr/controller/config`)
#### Runner
`ENCODARR_CONFIG_DIR`, `--config-dir` sets the directory that the configuration files are saved to.
This includes the log file.
In a container, this is pre-set to `/config`.
(default: `/encodarr/runner-
`ENCODARR_TEMP_DIR`, `--temp-dir` sets the directory that the media files are saved to when they are being worked on.
If you want to protect your flash memory(SSDs and SD Cards) from excessive reads and writes, you can set this to be on another storage medium.
(default: ``)
`ENCODARR_LOG_LEVEL`, `--log-level` sets the level of output from the logging system to both the log file and the terminal output.
Possible values are: `trace`, `debug`, `info`, `warn` (or `warning`, they are identical), `error`, `critical`.
(default: `info`)
`ENCODARR_RUNNER_NAME`, `--name` sets the name to be shown in the Web UI when referring to this runner.
(default: `-`)
`ENCODARR_RUNNER_CONTROLLER_IP`, `--controller-ip` sets the IP for connecting to the Controller.
(default: `localhost`)
`ENCODARR_RUNNER_CONTROLLER_PORT`, `--controller-port` sets the port for connecting to the Controller.
(default: `8123`)
## Contributing
> I am currently looking for someone to verify the Mac OS binaries.
> They theoretically should just work, but I can't test it because I don't have access to a Mac.
> If you do verify please let me know in the [Discussions](https://github.com/BrenekH/encodarr/discussions) page, but if they don't please open a [new issue](https://github.com/BrenekH/encodarr/issues/new/choose).
If you want to contribute to this project, head over to [CONTRIBUTING.md](CONTRIBUTING.md) to get started.
## Code of Conduct
This project holds all maintainers, contributors, and participants to the standards outlined by the Contributor Covenant, a copy of which can be found in [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md).
## Future Plans
* Instead of configuring with dropdowns and checkboxes, use a plugin system
* Massive frontend overhaul
* Scheduled working times