2017-07-17 03:05:44 +00:00
|
|
|
# Anime Notifier
|
|
|
|
|
|
|
|
|
|
## Installation
|
|
|
|
|
|
|
|
|
|
### Prerequisites
|
|
|
|
|
|
|
|
|
|
* Install a Debian based operating system
|
|
|
|
|
* Install [Go](https://golang.org/dl/) (1.9 or higher)
|
2017-10-22 14:57:27 +00:00
|
|
|
* Install [TypeScript](https://www.typescriptlang.org/) (2.5 or higher)
|
2017-07-17 03:05:44 +00:00
|
|
|
* Install [Aerospike](http://www.aerospike.com/download) (3.14.0 or higher)
|
|
|
|
|
|
|
|
|
|
### Download the repository and its dependencies
|
|
|
|
|
|
|
|
|
|
* `go get github.com/animenotifier/notify.moe`
|
|
|
|
|
|
|
|
|
|
### Build all
|
|
|
|
|
|
|
|
|
|
* Run `make tools` to install [pack](https://github.com/aerogo/pack) & [run](https://github.com/aerogo/run)
|
|
|
|
|
* Run `make all`
|
|
|
|
|
* Run `make ports` to set up local port forwarding *(80 to 4000, 443 to 4001)*
|
|
|
|
|
* You should be able to start the server by executing `run` now
|
|
|
|
|
|
|
|
|
|
### 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
|
2017-10-22 13:57:27 +00:00
|
|
|
filesize 300M
|
2017-07-17 03:05:44 +00:00
|
|
|
data-in-memory true
|
|
|
|
|
|
|
|
|
|
# Maximum object size. 128K is ideal for SSDs but we need 1M for search indices.
|
|
|
|
|
write-block-size 1M
|
|
|
|
|
|
|
|
|
|
# Write block size x Post write queue = Cache memory usage (for write block buffers)
|
|
|
|
|
post-write-queue 1
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
2017-10-22 14:50:22 +00:00
|
|
|
* Download the [database for developers](https://mega.nz/#!yFAiSIzI!rlbM4_3WK9hH2OfAt44xGWnWMWs-kVHhvC_DTKyRMBQ) to notify.moe/db/arn-dev.dat
|
2017-07-17 03:05:44 +00:00
|
|
|
* 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`
|
|
|
|
|
|
|
|
|
|
### HTTPS
|
|
|
|
|
|
|
|
|
|
* Create the certificate `notify.moe/security/fullchain.pem` (domain: `beta.notify.moe`)
|
|
|
|
|
* Create the private key `notify.moe/security/privkey.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"
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Run
|
|
|
|
|
|
|
|
|
|
* Start the web server in notify.moe directory: `run`
|
|
|
|
|
* Open `https://beta.notify.moe` which should now resolve to localhost
|
