96 lignes
4 Kio
Markdown
96 lignes
4 Kio
Markdown
|
|
|
|
# Nyaa replacement [](https://travis-ci.org/NyaaPantsu/nyaa) [](https://goreportcard.com/report/github.com/NyaaPantsu/nyaa) [](https://godoc.org/github.com/NyaaPantsu/nyaa)[](https://coveralls.io/github/NyaaPantsu/nyaa?branch=dev)
|
|
|
|
## 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](https://trello.com/b/gMJBwoRq/nyaa-pantsu-cat-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](https://trello.com/b/gMJBwoRq/nyaa-pantsu-cat-roadmap) or click on the "Roadmap".
|
|
|
|
# Requirements
|
|
|
|
* Golang 
|
|
|
|
# Installation
|
|
All tested versions of Ubuntu fail to build, use a different OS or docker
|
|
* Install [Golang](https://golang.org/doc/install) (version >=1.8)
|
|
* `go get -u github.com/tools/godep`
|
|
* `go get github.com/NyaaPantsu/nyaa`
|
|
|
|
Either use:
|
|
* `godep go build`
|
|
Or use this to have the build version in index.html:
|
|
* `godep go build -ldflags "-X main.buildversion=$(git rev-parse HEAD)"`
|
|
Or you can build using package.sh (Windows & Linux):
|
|
* `./package.sh`
|
|
|
|
|
|
* Download the DB and place it in your root folder named as "nyaa.db" (You want the merged.sqlite3 database, see the dev IRC for more info)
|
|
* `./nyaa`
|
|
* You can now access your local site over on [localhost:9999](http://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](https://docs.docker.com/engine/installation/linux/ubuntu/#install-using-the-repository).
|
|
|
|
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](https://sourceforge.net/projects/dos2unix/files/latest/download) and run "dos2unix.exe"
|
|
on the /deploy/init.sh to convert CR+LF to LF.
|
|
|
|
```sh
|
|
# Make sure the project is in here $GOPATH/src/github.com/NyaaPantsu/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](http://localhost:9999).
|
|
|
|
> For postgres, place the dump in the toplevel directory and name it to
|
|
> nyaa_psql.backup.
|
|
|
|
# LICENSE
|
|
This project is licensed under the MIT License - see the LICENSE.md file for details
|
|
|
|
# Contributing
|
|
Use tabs for css and js files.
|
|
# Contributing to translation
|
|
Please look at /translations/README.md
|
|
# IRC
|
|
#nyaapant<span>su@irc<span>.rizon.n</span>et</span>
|
|
|
|
#nyaapantsu-dev<span>@ir<span>c.rizon.n</span>et</span> (Serious buisness only)
|
|
|
|
# Disclaimer
|
|
We take no legal responsibility for anything this code is used for. This is purely an educational proof of concept.
|