web/notify.moe
Code Issues Pull Requests Activity

Improved installation guide

Browse Source
This commit is contained in:
Eduard Urbach 2017-11-01 11:27:30 +01:00
parent 46dd9f53a8
commit 9b0f01f96e
2 changed files with 17 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CONTRIBUTING.md
View File

@ -3,3 +3,5 @@
Please get in contact with the team on the [Anime Notifier Discord](https://discord.gg/0kimAmMCeXGXuzNF).
We're willing to help with installations and how to get started with contributions.
There are no stupid questions so feel free to ask anything if you encounter any troubles.
If you'd like to install this project locally, take a look at the [Installation](INSTALLATION.md) guide.

54
INSTALLATION.md
View File

@ -1,60 +1,36 @@
# Anime Notifier
# Installation
## Installation
## Prerequisites
### Prerequisites
* Install a Debian based operating system
* Install [Ubuntu](https://www.ubuntu.com/) or any of its derivates
* Install [Go](https://golang.org/dl/) (1.9 or higher)
* Install [TypeScript](https://www.typescriptlang.org/) (2.5 or higher)
* Install [Aerospike](http://www.aerospike.com/download) (3.14.0 or higher)
### Download the repository and its dependencies
## Download the repository and its dependencies
* `go get github.com/animenotifier/notify.moe`
### Build all
## Build all
* Navigate to the project directory `notify.moe`
* 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)*
* Run `make all`
### Database
## Hosts
* 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 300M
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
}
}
```
* Download the database for developers (get in contact with me to receive a link)
* 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
## HTTPS
* Create the certificate `notify.moe/security/fullchain.pem` (domain: `beta.notify.moe`)
* Create the private key `notify.moe/security/privkey.pem`
### API keys
## Browser
* Start Chrome via `google-chrome --ignore-certificate-errors`
## 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`:
@ -68,7 +44,7 @@ namespace arn {
}
```
### Run
## Run
* Start the web server in notify.moe directory: `run`
* Open `https://beta.notify.moe` which should now resolve to localhost