Albirew/nyaa-pantsu
Archivé
1
0
Bifurcation 0
Ce dépôt a été archivé le 2022-05-07. Vous pouvez voir ses fichiers ou le cloner, mais pas ouvrir de ticket ou de demandes d'ajout, ni soumettre de changements.
nyaa-pantsu/README.md

99 lignes
4,2 Kio
Markdown
Brut Vue normale Historique

2017-05-07 12:29:05 +02:00
![nyanpasu~](https://my.mixtape.moe/aglaxe.png)
2017-05-06 07:05:14 +02:00
2017-07-29 13:14:10 +02:00
# Nyaa replacement [![Build Status](https://travis-ci.org/NyaaPantsu/nyaa.svg?branch=master)](https://travis-ci.org/NyaaPantsu/nyaa) [![Go Report Card](https://goreportcard.com/badge/github.com/NyaaPantsu/nyaa)](https://goreportcard.com/report/github.com/NyaaPantsu/nyaa) [![GoDoc](https://godoc.org/github.com/NyaaPantsu/nyaa?status.svg)](https://godoc.org/github.com/NyaaPantsu/nyaa)[![Coverage Status](https://coveralls.io/repos/github/NyaaPantsu/nyaa/badge.svg?branch=dev)](https://coveralls.io/github/NyaaPantsu/nyaa?branch=dev)
2017-05-03 05:46:14 +02:00
## 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://github.com/NyaaPantsu/nyaa/projects/2)
As of August 17th the [trello board](https://trello.com/b/gMJBwoRq/nyaa-pantsu-cat-roadmap) has been moved to [GitHub Projects](https://github.com/NyaaPantsu/nyaa/projects/2)
2017-05-14 03:14:27 +02:00
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 GitHub Projects board [here](https://github.com/NyaaPantsu/nyaa/projects/2) or click on the "Roadmap".
2017-05-14 03:14:27 +02:00
2017-05-03 05:46:14 +02:00
# Requirements
2017-07-23 03:37:48 +02:00
* Golang ![golang](http://i.imgur.com/UEdZpr4.png)
2017-05-03 05:46:14 +02:00
2017-05-05 00:26:59 +02:00
# 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`
2017-05-17 07:58:40 +02:00
* `go get github.com/NyaaPantsu/nyaa`
2017-05-31 18:07:58 +02:00
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)
2017-05-05 09:15:26 +02:00
* `./nyaa`
* You can now access your local site over on [localhost:9999](http://localhost:9999)
2017-05-05 00:26:59 +02:00
## 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`
2017-05-06 07:52:58 +02:00
## 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.
2017-05-10 02:32:44 +02:00
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.
2017-05-06 07:52:58 +02:00
```sh
2017-05-17 07:58:40 +02:00
# Make sure the project is in here $GOPATH/src/github.com/NyaaPantsu/nyaa
2017-05-06 07:52:58 +02:00
$ 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
2017-05-06 07:52:58 +02:00
```
2017-05-06 07:55:55 +02:00
Access the website by going to [localhost:9999](http://localhost:9999).
2017-05-06 07:52:58 +02:00
2017-05-07 01:23:25 +02:00
> For postgres, place the dump in the toplevel directory and name it to
> nyaa_psql.backup.
2017-05-03 05:46:14 +02:00
# LICENSE
This project is licensed under the MIT License - see the LICENSE.md file for details
2017-05-17 03:28:35 +02:00
# Contributing
Use tabs for css and js files.
2017-06-16 19:44:39 +02:00
# 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)
2017-05-17 03:28:35 +02:00
# Disclaimer
We take no legal responsibility for anything this code is used for. This is purely an educational proof of concept.