Added basic installation instructions

This commit is contained in:
Eduard Urbach 2017-06-11 11:51:31 +02:00
parent e47ad51060
commit 611a4de69a

61
README.md Normal file
View File

@ -0,0 +1,61 @@
# Anime Notifier
## Installation
### Prerequisites
* Install [Go](https://golang.org/dl/) (1.8.3 or higher)
* Install [Aerospike](http://www.aerospike.com/download) (3.14.0 or higher)
### Database
* Remove all namespaces in `/etc/aerospike/aerospike.conf`
* Add a namespace called `arn`:
```
namespace arn {
storage-engine device {
file /home/YOUR_NAME/YOUR_PATH/notify.moe/db/arn-dev.dat
filesize 50M
data-in-memory false
# Maximum object size. 128K is ideal for SSDs
write-block-size 128K
# Write block size x Post write queue = Cache size (for write block buffers)
post-write-queue 128
}
}
```
* Start the database using `sudo service aerospike start`
* Confirm that the status is "green": `sudo service aerospike status`
### Hosts
* Add `127.0.0.1 arn-db` to `/etc/hosts`
* Add `127.0.0.1 beta.notify.moe` to `/etc/hosts`
* Run these commands to forward ports 80/443 to 4000/4001:
```sh
sudo iptables -t nat -A OUTPUT -o lo -p tcp --dport 80 -j REDIRECT --to-port 4000
sudo iptables -t nat -A OUTPUT -o lo -p tcp --dport 443 -j REDIRECT --to-port 4001
```
### Download repository
* Run "go get github.com/animenotifier/notify.moe"
### HTTPS
* Create directory `notify.moe/security`
* Create the certificate `notify.moe/security/fullchain.pem` (domain: `beta.notify.moe`)
* Create the private key `notify.moe/security/privkey.pem`
* Add `notify.moe/security/fullchain.pem`
### API keys
* Get a Google OAuth 2.0 client key & secret from [console.developers.google.com](https://console.developers.google.com)
* Create the file `notify.moe/security/api-keys.json`:
```json
{
"google": {
"id": "YOUR_KEY",
"secret": "YOUR_SECRET"
}
}
```
### Fetch data
* Build & run `jobs/sync-anime/sync-anime` from this repository to fetch anime data