{"id":13537699,"url":"https://github.com/nzedb/nzedb","last_synced_at":"2025-05-14T06:13:02.645Z","repository":{"id":46957058,"uuid":"9683876","full_name":"nZEDb/nZEDb","owner":"nZEDb","description":"nZEDb - a fork of nnplus(2011) | NNTP / Usenet / Newsgroup indexer.","archived":false,"fork":false,"pushed_at":"2024-12-02T13:30:18.000Z","size":99307,"stargazers_count":632,"open_issues_count":89,"forks_count":180,"subscribers_count":76,"default_branch":"0.x","last_synced_at":"2025-04-05T18:02:58.646Z","etag":null,"topics":["gplv3","indexer","mariadb","newsgroups","nginx","nntp","nzb","nzedb","php","sphinx","tmux","usenet"],"latest_commit_sha":null,"homepage":"https://nzedb.github.io/","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nZEDb.png","metadata":{"files":{"readme":"README.md","changelog":"Changelog","contributing":".github/CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2013-04-25T23:45:28.000Z","updated_at":"2025-04-02T22:04:24.000Z","dependencies_parsed_at":"2024-09-23T04:00:59.229Z","dependency_job_id":"0f1e8c4a-936e-4f32-b7c0-74424e369cff","html_url":"https://github.com/nZEDb/nZEDb","commit_stats":{"total_commits":12563,"total_committers":97,"mean_commits":"129.51546391752578","dds":0.664650163177585,"last_synced_commit":"8973bc235a3901f00ed2f328fe6b84f81b98aba2"},"previous_names":[],"tags_count":154,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nZEDb%2FnZEDb","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nZEDb%2FnZEDb/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nZEDb%2FnZEDb/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nZEDb%2FnZEDb/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nZEDb","download_url":"https://codeload.github.com/nZEDb/nZEDb/tar.gz/refs/heads/0.x","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248624831,"owners_count":21135507,"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":["gplv3","indexer","mariadb","newsgroups","nginx","nntp","nzb","nzedb","php","sphinx","tmux","usenet"],"created_at":"2024-08-01T09:01:02.375Z","updated_at":"2025-04-12T19:40:10.439Z","avatar_url":"https://github.com/nZEDb.png","language":"PHP","funding_links":[],"categories":["\u003ca id=\"9eee96404f868f372a6cbc6769ccb7f8\"\u003e\u003c/a\u003e新添加的","\u003ca id=\"9eee96404f868f372a6cbc6769ccb7f8\"\u003e\u003c/a\u003e工具"],"sub_categories":["\u003ca id=\"31185b925d5152c7469b963809ceb22d\"\u003e\u003c/a\u003e新添加的"],"readme":"Stable: [![Build Status](https://travis-ci.org/nZEDb/nZEDb.svg?branch=0.x)](https://travis-ci.org/nZEDb/nZEDb)  Testing: [![Build Status](https://travis-ci.org/nZEDb/nZEDb.svg?branch=Latest-testing)](https://travis-ci.org/nZEDb/nZEDb)  Dev: [![Build Status](https://travis-ci.org/nZEDb/nZEDb.svg?branch=dev)](https://travis-ci.org/nZEDb/nZEDb)\n\n# nZEDb is not actively maintained anymore. \n\nnZEDb automatically scans usenet, similar to the way web spiders scan the internet. It does this by collecting usenet headers and temporarily storing them in a database until they can be collated into posts/releases. It provides a web-based front-end providing search, browse, and programmable (API) functionality.\n\nThis project is a fork of the open source usenet indexer newznab plus: https://github.com/anth0/nnplus\n\nnZEDb improves upon the original design, implementing several new features including:\n\n- Optional multi-threaded processing (header retrieval, release creation, post-processing etc)\n- Advanced search features (name, subject, category, post-date etc)\n- Intelligent local caching of metadata\n- Optional sharing of comments with other nZEDb sites\n- Optional tmux (terminal session multiplexing) engine that provides thread, database and performance monitoring\n- Image and video samples\n- SABnzbd/NZBGet integration (web, API and pause/resume)\n- CouchPotato integration (web and API)\n\n\n## Prerequisites\n\nSystem Administration know-how. nZEDb is not plug-n-play software. Installation and operation requires a moderate amount of administration experience. nZEDb is designed and developed with GNU/Linux operating systems. Certain features are not available on other platforms. An experienced Windows administrator should be able to run nZEDb on a Windows OS.\n\n### Hardware\n\n\t4GB RAM, 2 cores(threads) and 20GB disk space minimum.\n\nIf you wish to use more than 5 threads a quad core CPU is beneficial. While nZEDb can run with \nthese minimums, you will have very limited performance. \n\nThe overall speed of nZEDb is largely governed by performance of the database. As many of the database tables should be held within system RAM as possible. See Database Section below.\n\n### Software\n\n\tPHP (current actively supported versions and various modules)\n    MariaDB 10.0 (strongly preferred database choice)\nThe installation guides have more detailed software requirements.\n\n### Database\n\nMost (if not all) distributions ship MariaDB with a default configuration that will perform well on a Raspberry Pi. If you wish to store more that 500K releases, these default settings will quickly lead to poor performance. Expect this.\n\nAs a general rule of thumb the database will need a minimum of 1-2G buffer RAM for every million releases you intend to store. That RAM should be assigned to either of these two parameters:\n- key_buffer_size\t\t\t(MyISAM)\n- innodb_buffer_pool_size\t(InnoDB)\n\nUse [mysqltuner.pl](http://mysqltuner.pl \"MySQL tuner - Use it!\") for recommendations for these and other important tuner parameters. Also refer to the project's wiki page: https://github.com/nZEDb/nZEDb/wiki/Database-tuning. This is particularly important before you start any large imports or backfills.\n\nMariaDB is normally shipped using MyISAM tables by default. This is fine for running with one or a few threads and is a good way to start using nZEDb. You should migrate to the InnoDB table format if nZEDB is configured to use one of the following:\n\n\tthread counts \u003e 5\n\ttmux mode\n\nThis conversion script is helpful:\n\n\tmisc/testing/DB/convert_mysql_tables.php\n\nBefore converting to InnoDB be sure to set:\n\n\tinnodb_file_per_table\n\n\u003cbr\u003e\n\n## Installation\n\nSpecific installation guides for common Operating Systems can be found on the nZEDb github wiki: https://github.com/nZEDb/nZEDb/wiki/Install-Guides\n\n## Getting Started\n\nAfter you have installed nZEDb and gone throught the initial web-based installation steps (step1, step2 etc.), then review the settings on the Admin-Site-Edit page.\n\nMost of the default settings are fine, however some will need changing.\n\nThe two amazon keys and the associate tag are needed to fetch anything from amazon. The trakt.tv key is optional, but it can help fetching extra information when tvrage and the NFO fails.\n\nSetting the paths to unrar/ffmpeg/mediainfo is optional, but unrar is recommended for retrieving release names and finding passwords. It's best to get the very latest versions of these utilities, whatever comes as default with your distro is often not good enough.\n\nIf you have set the path to unrar, deep rar inspection is recommended.\n\nCompressed headers are recommended if your provider supports XFeature gzip compression. (XFeature GZIP compression, originally by wafflehouse : link on pastebin was removed)\n\nOnce you have set all the options, you can enable one or two groups and start with the simple screen script running in single-threaded mode. Look in the misc/update directory; update_binaries.php downloads usenet articles into the local database; update_releases.php attempts to group these articles into releases and create NZB files.\n\nOnce you've become more familiar with the application, enable a few more groups and if needed enable multi-threading (with low thread counts i.e. \u003c 5). We do not recommend enabling all the groups unless you have performant hardware and good database tuning knowledge.\n\nIf you want an automated way of doing this, you can use one of the scripts in the nix, or tmux folder. The Windows scripts may work.\n\nTo clean up the release names, check out fixReleaseNames.php in misc/testing.\n\nFor an overview of a complete process, look at the  misc/update/nix/screen/sequential/threaded.sh script.\n\nAdvanced users may be interested to try the tmux version of nZEDb in either Complete Sequential, Sequential or non-Sequential (fully parallel) mode. Before starting, review the tmux settings in Site-Edit -\u003e Tmux Settings.\n\n\n### Support\n\nThere is a web forum were you can search for issues previously encountered by others:\nhttps://forums.nzedb.com/\n\nAlso on IRC: irc.synirc.net #nZEDb\n\n### Note\n\nThe nZEDb team have no control over and are not responsible for what is posted on the usenet. Best efforts are made to avoid hazardous content (e.g. virii, malware etc) by nZEDb's automated processess. If you find any objectionable content, please direct any complaints to your usenet provider.\n\n### The Team\n\nKevin123, jonnyboy, Miatrix, zombu2, Codeslave, sinfuljosh, ugo, Whitelighter, Bart39, archer(niel), ThePeePs, ruhllatio, DariusIII\u003cbr /\u003e\u003cbr /\u003e\n\u003ca href=\"https://nzedb.github.io/donate\" target=\"_blank\"\u003eDonate\u003c/a\u003e\n\n\u003cp\u003e\n\n### Licenses\n\nnZEDb is GPL v3. See /docs/LICENSE.txt for the full license.\n\nOther licenses by various software used by nZEDb:\n\nGit.php =\u003e MIT and GPL v3\n\nNet_NNTP =\u003e W3C\n\nPHPMailer =\u003e GNU Lesser General Public License\n\nforkdaemon-php =\u003e Barracuda Networks, Inc.\n\ngetid3 =\u003e GPL v3\n\npassword_compat =\u003e Anthony Ferrara\n\nrarinfo =\u003e Modified BSD\n\nsmarty =\u003e GNU Lesser General Public v2.1\n\nAmazonProductAPI.php =\u003e Sameer Borate\n\nGiantBombAPI.php =\u003e MIT\n\nTMDb PHP API class =\u003e BSD\n\nTVDB PHP API =\u003e Moinax\n\nTVMaze PHP API =\u003e JPinkney\n\nZip file creation class =\u003e No license specified.\n\nsimple_html_dom.php =\u003e MIT\n\nAll external libraries will have their full licenses in their respective folders.\n\nSome licenses might have been missed in this document for various external software, they will be included in their respectful folders.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnzedb%2Fnzedb","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnzedb%2Fnzedb","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnzedb%2Fnzedb/lists"}