nyaa-pantsu/README.md

Nyaa replacement

Motivation

The aim of this project is to write a fully featured nyaa replacement in golang that anyone will be able to deploy locally or remotely.

Roadmap

The Roadmap will give you an overview of the features and tasks that the project are currently discussing, working on and have completed. If you are looking for a feature that is not listed just make a GitHub Issue and it will get added to the trello board.

You can view the public trello board here or click on the "Roadmap".

Requirements

• Golang

Installation

Ubuntu 17.04 fails to build, use a different OS or docker

• Install Golang (version >=1.8)
• go get github.com/ewhal/nyaa
• go build
• Download DB and place it in your root folder named as "nyaa.db"
• ./nyaa
• You can now access your local site over on localhost:9999

Usage

Type ./nyaa -h for the list of options.

Systemd

• Edit the unit file os/nyaa.service to your liking
• Copy the package's content so that your unit file can find them.
• Copy the unit file in /usr/lib/systemd/system
• systemctl daemon-reload
• systemctl start nyaa

The provided unit file uses options directly; if you prefer a config file, do the following:

• ./nyaa -print-defaults > /etc/nyaa.conf
• Edit nyaa.conf to your liking
• Replace in the unit file the options by -conf /etc/nyaa.conf

Docker

We support docker for easy development and deployment. Simply install docker and docker-compose by following the instructions here.

Once you've successfully installed docker, make sure you have the database file in the project's directory as nyaa.db. Then, follow these steps to build and run the application.

Windows Users If you get "standard_init_linux.go:178: exec user process caused "no such file or directory" download dos2unix and run "dos2unix.exe" on the /deploy/init.sh to convert CR+LF to LF.

# Make sure the project is in here $GOPATH/src/github.com/ewhal/nyaa
$ cd deploy/
# You may choose another backend by pointing to the
# appropriate docker-compose file.
$ docker-compose -f docker-compose.sqlite.yml build
$ docker-compose -f docker-compose.sqlite.yml up 

Access the website by going to localhost:9999.

For postgres, place the dump in the toplevel directory and name it to nyaa_psql.backup.

TODO

Top Priorities

• Use new db abstraction layer and remove all ORM code
• Use elastic search or sphinix search
• Make filelists hidable
• Implement mockup design from /g/anon
• sukebei
  • get sukebei_torrents table working
  • add config option for sukebei or maybe make things all in one
  • sukebei categories and category images

Lower Priorities

• Get code up to standard of go lint recommendations
• Write tests
• Site theme
• original nyaa theme
• API improvement
• Scraping of fan subbing RSS feeds(WIP)

LICENSE

This project is licensed under the MIT License - see the LICENSE.md file for details