README.md

AtoMiC-ToolKit

Important Update (June 1, 2018)

It takes significant amount of time and effort to develop AtoMiC ToolKit. With the emergence of Docker and Docker compose, setting up a Docker-based media server is now significantly easier. This repo is no longer maintained. I recommend transitioning over to Docker.

Alternatively, you can check out <a href-DockSTARTer, which is an attempt to do what AtoMiC ToolKit does and more using Docker.

Introduction

AtoMiC ToolKit (Automate your Media Center) is a tool that is developed by htpcBeginner.com and its community to simplify installing and managing apps / software on Ubuntu based HTPC, NAS, or Home Server setup. Essentially the AtoMiC ToolKit automates several processes and makes installing, uninstalling, backing up, restoring, resetting, and maintaining download server apps. It is written in bash.

Support AtoMiC ToolKit Development

We have put in several hundred hours of work into developing AtoMiC ToolKit. If it helped you please consider donating. All donations will be used only for AtoMiC ToolKit development.

BitCoin	PayPal
1FEgpS3WrK51yzJpqrSo3RXcrLDGztqKPy

Compatibility

Compatible with Latest Ubuntu and variants (Kubuntu, Xubuntu, Lubuntu) and Linux Mint. Development will focus mainly on compatibility with current Ubuntu\Debian\Raspbian releases. Testing has been mainly on Linux Mint 18.2 and Raspbian Jessie.

Key Features

Features features of AtoMiC ToolKit include:

• Almost entirely automated
• Very little commandline work
• User and newbie-friendly
• One-stop shop
  • CouchPotato - Install, Uninstall, Reset Password, Update and Backup / Restore
  • Deluge - Install, Uninstall, Update and Backup / Restore
  • Emby - Install, Uninstall, Update and Backup / Restore
  • FileBot - Install, Uninstall, Update
  • Flood - Install, Uninstall, Update
  • Glances - Install, Uninstall, Update
  • Grafana - Install, Uninstall, Update and Backup / Restore
  • Headphones - Install, Uninstall, Reset Password, Update and Backup / Restore
  • HTPC Manager - Install, Uninstall, Update and Backup / Restore
  • Jackett - Install, Uninstall, Update and Backup / Restore
  • Kodi - Install, Uninstall Autoboot enable and Update
  • Lazy Librarian - Install, Uninstall, Reset Password, Update and Backup / Restore
  • Lidarr - Install, Uninstall, Update and Backup / Restore
  • Madsonic - Install, Uninstall, Update and Backup / Restore
  • Medusa - Install, Uninstall, Update and Backup / Restore
  • Muximux - Install, Uninstall, Update
  • Mylar - Install, Uninstall, Reset Password, Update and Backup / Restore
  • NetData - Install, Uninstall, Update
  • NZBGet - Install, Uninstall, Reset Password and Backup / Restore
  • NZBHydra - Install, Uninstall, Update and Backup / Restore
  • Ombi - Install, Uninstall, Update and Backup / Restore
  • Organizr - Install, Uninstall, Update
  • PhpSysInfo - Install, Uninstall, Update
  • Plex - Install, Uninstall, Update and Backup / Restore
  • Tautulli - Install, Uninstall, Update and Backup / Restore
  • Private Internet Access - Install, Uninstall, Update
  • pyLoad - Install, Uninstall, Update and Backup / Restore
  • qBittorrent - Install, Uninstall, Reset Password, Update and Backup / Restore
  • Radarr - Install, Uninstall, Update and Backup / Restore
  • Rclone - Install, Uninstall, Update and Backup / Restore
  • Rclone Browser- Install, Uninstall, Update
  • Resilio-Sync - Install, Uninstall, Update and Backup / Restore
  • rTorrent - Install, Uninstall, Update and Backup / Restore
  • ruTorrent - Install, Uninstall, Update
  • SABnzbd+ - Install, Uninstall, Reset Password, Update and Backup / Restore
  • SickGear - Install, Uninstall, Reset Password, Update and Backup / Restore
  • SickRage - Install, Uninstall, Reset Password, Update and Backup / Restore
  • Sonarr - Install, Uninstall, Update and Backup / Restore
  • Subsonic - Install, Uninstall, Update and Backup / Restore
  • Syncthing - Install, Uninstall, Update and Backup / Restore
  • Transmission WebUI - Install, Uninstall, Reset Password, Update and Backup / Restore
  • ubooquity- Install, Uninstall, Update and Backup / Restore
  • Watcher - Install, Uninstall, Update and Backup / Restore
  • Webmin - Install, Uninstall, Update and Backup / Restore
• Reset forgotten WebUI passwords
• Makes moving apps between different computers easier (see dedicated section below)
• Correctly sets required permissions for trouble free operation
• And best of all its FREE! Please consider donating if toolkit helps you.

Note that AtoMiC ToolKit will be in continuous development. While extensive testing has been done, there may be errors or unexpected behaviors at times. Also, not all features have been implemented yet.

Feature Requests

Please add new features and vote to help steer the direction of AtoMiC-ToolKit. Current requests and voting can be seen below.

Installation and Usage

Clone repository on any Debian or Ubuntu based distro and execute the setup.sh bash script file.

$ sudo apt-get install git
$ sudo git clone https://github.com/htpcBeginner/AtoMiC-ToolKit /opt/AtoMiC-ToolKit
$ cd /opt/AtoMiC-ToolKit
$ sudo bash setup.sh

The setup script will configure AtoMiC ToolKit and after the initial setup will be accessible from anywhere by typing:

sudo atk

Command Line Arguments

The script supports several command line arguments:

$ sudo bash setup.sh -[o]ption (appname)

• -i appname or --install appname - Install an app
• -u appname or --uninstall appname - Uninstall an app
• -b appname or --backup appname - Backup the config file for an app
• -r appname or --restore appname - Restore an app config file from backup
• -m appname or --manualupdate appname - Manually update a specific app
• -p appname or --passwordreset appname - Reset the password to an app
• -a appname or --accessdetails appname - View the access details for an app
• -x appname or --reverseproxy appname - Enable Reverse Proxy for an app
• -t or --updatetoolkit - Update AtoMiC-ToolKit
• -U or --updateall - Update Linux packages

Examples:

$ sudo bash setup.sh -i couchpotato
$ sudo bash setup.sh -U
$ sudo bash --manualupdate sonarr

Video

https://youtu.be/Zji_3cZRcK4

Screenshots

AtoMiC ToolKit Main Menu

AtoMiC ToolKit Submenu Example

AtoMiC ToolKit Script Execution Example

Default Usernames and Passwords

Access details have now been simplified and automated. Access details for each app can be obtained through the ToolKit Menus. It is recommended that you set / update usernames and password for all services.

Backup/restore process

The default location for stored backups is /opt/AtoMiC-ToolKit/backups. If you are transferring to a new machine, you should keep this folder so all the zips are available to restore later. You just need to copy it back, install the application again and restore the backup.

For more information on installation and usage, visit AtoMiC ToolKit page on on htpcBeginner.com.