{"id":13596771,"url":"https://github.com/slydetector/simply-nzedb","last_synced_at":"2025-04-09T20:31:23.094Z","repository":{"id":82482929,"uuid":"73591416","full_name":"slydetector/simply-nzedb","owner":"slydetector","description":"The simplest way to get nZEDb up and running with docker","archived":false,"fork":false,"pushed_at":"2018-11-19T21:24:29.000Z","size":102,"stargazers_count":69,"open_issues_count":11,"forks_count":24,"subscribers_count":7,"default_branch":"master","last_synced_at":"2024-11-06T20:44:21.875Z","etag":null,"topics":["docker","linux","mysql","nzb","nzedb","self-hosted","usenet"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/slydetector.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2016-11-13T02:40:27.000Z","updated_at":"2024-02-13T02:01:55.000Z","dependencies_parsed_at":null,"dependency_job_id":"23e9d51a-938b-4df8-a407-c40368e78685","html_url":"https://github.com/slydetector/simply-nzedb","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slydetector%2Fsimply-nzedb","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slydetector%2Fsimply-nzedb/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slydetector%2Fsimply-nzedb/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slydetector%2Fsimply-nzedb/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/slydetector","download_url":"https://codeload.github.com/slydetector/simply-nzedb/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248107332,"owners_count":21048902,"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":["docker","linux","mysql","nzb","nzedb","self-hosted","usenet"],"created_at":"2024-08-01T16:02:46.897Z","updated_at":"2025-04-09T20:31:22.550Z","avatar_url":"https://github.com/slydetector.png","language":"Shell","funding_links":[],"categories":["Shell"],"sub_categories":[],"readme":"[![Build Status](https://travis-ci.org/slydetector/simply-nzedb.svg?branch=master)](https://travis-ci.org/slydetector/simply-nzedb)\n[![](https://img.shields.io/docker/pulls/slydetector/simply-nzedb.svg)](https://hub.docker.com/r/slydetector/simply-nzedb 'DockerHub')\n[![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/simply-nzedb/Lobby)\n\n# Simply nZEDb\n\nSet up your own nZEDb usenet indexer in no time at all. \nThis is a docker based installation based on the super-slim alpine linux distro.\n\n## Requirements\n- Linux (64-bit x86 based distro - Debian, Ubuntu, whatever) or macOS 10+\n- [docker 1.11+](https://docs.docker.com/engine/installation/)\n- git\n- [make](http://stackoverflow.com/questions/11934997/how-to-install-make-in-ubuntu)\n- python 2.7\n- [virtualenv](https://virtualenv.pypa.io/en/stable/installation/)\n\n## Installation\n### Step 1 - Command line setup\n\n**ProTip:** Setup docker to run [without having to use sudo](http://askubuntu.com/questions/477551/how-can-i-use-docker-without-sudo) unless you like typing in your password again and again.\n\n```sh\n$ git clone https://github.com/slydetector/simply-nzedb.git nzedb\n$ cd nzedb\n\n# Create a python virtualenv for docker-compose\n$ make venv\n\n# Create a copy of the *single* config file\n$ cp etc/simply_nzedb.conf.example etc/simply_nzedb.conf\n\n# Update config file with usenet, irc, socks, etc settings\n$ vim etc/simply_nzedb.conf\n\n# Setup the ./data dir which contains nzedb config, nzbs, mysql data, log files, etc\n$ bin/setup_data_dir\n\n# Start up nzedb to do initial setup\n$ [sudo] make start \n```\n\n### Step 2 - Automated web setup\n```sh\n# This will run through the web setup for you using settings from simply_nzedb.conf.\n# Logs are in web_setup.log\n$ bin/web_setup\n```\n\n### Step 3 - Sane defaults\n```sh\n# Update settings db table with locations of various executables like ffmpeg, mediainfo, etc\n# and subscribe to alt.binaries.teevee for verification\n$ [sudo] bin/apply_defaults\n\n# Restart to pick up changes\n$ [sudo] make start\n```\n\n### Step 4 - Verification\n```sh\n# Attach to tmux and verify things are working by\n# next'ing through the windows.\n#\n# Cheat sheet for getting around in tmux:\n#\n# Key         Action\n# --------------------------------------\n# Ctrl-a n    Next window\n# Ctrl-a c    Create new window\n# Ctrl-a d    Detach from tmux\n# \n$ [sudo] make attach\n```\nGo to ```http://\u003chostname\u003e:8800/browse?t=5000``` and you should see some TV releases soon.\n\nCongratulations, you've just accomplished the hardest part of running nZEDb, setting it up!\n\n## Commands\nRun ``make`` to see what else you can do.\n\n```\n$ make \nWelcome to simply-nzedb!\n\nCore commands:\n\n  attach - attach to nzedb's tmux session\n  backup - backup database. nzedb must be running\n  help - print this help\n  logs - print container logs\n  mysql - mysql client\n  mysqltuner - run mysql tuner\n  pull - pull the latest version\n  restore - restore last database backup. nzedb must be running\n  shell - shell into the nzedb container\n  start - start nzedb (restarts if it is already running)\n  status - shows running containers\n  stop - stops nzedb\n\nDeveloper commands:\n\n  build - build docker images locally instead of downloading from docker hub\n  test - run acceptance tests\n```\n\n## Upgrading to a newer version of nZEDb\nSee [UPGRADE.md](https://github.com/slydetector/simply-nzedb/blob/master/UPGRADE.md) for version specific upgrade instructions.\n\n- Run ```make backup``` or you'll probably regret things if things go horribly wrong\n- Run ```git pull``` to update to the latest docker files\n- Run ```make pull``` to pull the latest docker images\n- Run ```make start``` to restart nZEDb. The database schema is updated if necessary when starting up.\n\nIf after an upgrade, ```make attach``` fails, it is usually an indication that the database is getting updated or running migration steps. Use ```make logs | less -R``` to check on the progress and try again in a few minutes.\n\n## Customizing MySQL\nYou can customize mysql settings by creating ```data/etc_mysql_conf.d/nzedb.cnf```. e.g.\n```\n[mysqld]\nkey_buffer_size = 2G\ninnodb_buffer_pool_size = 8G\ngroup_concat_max_len = 32768\n```\n\n## TODO\n- PreDB auto-population\n\n## Acknowledgements\n- Based on work from [alp-nzedb](https://github.com/MichaelLindsey/alp-nzedb)\n- Hats off to the guys moving [nZEDb](https://nzedb.github.io/) forward.\n\n## Help!\nTry the [Gitter chat room](https://gitter.im/simply-nzedb/Lobby)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fslydetector%2Fsimply-nzedb","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fslydetector%2Fsimply-nzedb","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fslydetector%2Fsimply-nzedb/lists"}