Please note that GAZE is currently under active alpha development and as such is likely to be in a broken state.

GAZE banner

Build Status Docker Build Status Documentation Status GitHub Chat on Gitter GPLv3 license

What's GAZE?

It's a true turnkey open-source media center solution. It will deploy, configure and network the following services, making use of Docker's ecosystem:

  • Sonarr, to manage TV series downloads.
  • Radarr, to manage movie downloads.
  • Jackett, to manage torrent trackers.
  • Transmission, a torrent client.
  • Plex, to encode and stream media to devices.

Additionally, to aggregate all of the above in to a single user-friendly service, we also provide:

  • GAZE Control, a command-line tool to manage the full stack.
  • GAZE Web, a web-UI to aggregate all of the above.

Installation

Although GAZE should run on any system with Docker, we test builds on Ubuntu 16.04 LTS and later so suggest it as a known good configuration.

To install the gaze command-line tool and deploy the full media center stack, simply paste the following command into a shell. On completion, you will be presented with all the details you need to access your services:

curl -L https://raw.githubusercontent.com/monokal/GAZE/master/wrapper.sh > /usr/local/bin/gaze && chmod +x /usr/local/bin/gaze && gaze bootstrap

If you get a Permission denied error, try sudo -i then the above command again.

Usage

Web interface

GAZE comes complete with a web-UI which can be accessed via browser at https://localhost:

Further documentation on GAZE Web can be found here.

Command-line interface

To make life easy, the gaze command-line tool can be used to manage the full stack of media center services, including the GAZE web-UI service. Usage can be seen using the following command:

gaze --help

Further documentation on GAZE Control can be found here.

Documentation

Full documentation on the GAZE project is available here.

Support

If you experience any problems, would like to request a new feature or just chat, there are a couple of support channels available:

Development

If you'd like to contribute to the GAZE project, please read the development documentation.

GAZE is released under the GNU General Public License v3.0. Maintainers of the GAZE project do not advocate the illegal sharing of media in any way, and assume no responsibility for improper use of GAZE or any linked software packages. By using GAZE, you agree that you will not share or take any action using GAZE that infringes or violates someone else's rights or otherwise violates the law.

This README.md is overwritten by docs/index.md during the build process, so edit that instead.