2017-11-01 10:27:30 +00:00
|
|
|
# Installation
|
2017-07-17 03:05:44 +00:00
|
|
|
|
2017-11-01 10:27:30 +00:00
|
|
|
## Prerequisites
|
2017-07-17 03:05:44 +00:00
|
|
|
|
2017-11-01 10:27:30 +00:00
|
|
|
* Install [Ubuntu](https://www.ubuntu.com/) or any of its derivates
|
2017-07-17 03:05:44 +00:00
|
|
|
* 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
|
|
|
|
2017-11-01 10:27:30 +00:00
|
|
|
## Download the repository and its dependencies
|
2017-07-17 03:05:44 +00:00
|
|
|
|
|
|
|
|
* `go get github.com/animenotifier/notify.moe`
|
|
|
|
|
|
2017-11-01 10:27:30 +00:00
|
|
|
## Build all
|
2017-07-17 03:05:44 +00:00
|
|
|
|
2017-11-01 10:27:30 +00:00
|
|
|
* Navigate to the project directory `notify.moe`
|
2017-07-17 03:05:44 +00:00
|
|
|
* Run `make tools` to install [pack](https://github.com/aerogo/pack) & [run](https://github.com/aerogo/run)
|
|
|
|
|
* Run `make ports` to set up local port forwarding *(80 to 4000, 443 to 4001)*
|
2017-11-01 10:27:30 +00:00
|
|
|
* Run `make all`
|
2017-07-17 03:05:44 +00:00
|
|
|
|
2017-11-01 10:27:30 +00:00
|
|
|
## Hosts
|
2017-10-25 22:04:32 +00:00
|
|
|
|
|
|
|
|
* Add `127.0.0.1 beta.notify.moe` to `/etc/hosts`
|
|
|
|
|
|
2017-11-01 10:27:30 +00:00
|
|
|
## HTTPS
|
2017-07-17 03:05:44 +00:00
|
|
|
|
2017-11-01 10:30:01 +00:00
|
|
|
* [Create the certificate](https://stackoverflow.com/questions/10175812/how-to-create-a-self-signed-certificate-with-openssl) `notify.moe/security/fullchain.pem` (domain: `beta.notify.moe`)
|
2017-10-25 22:04:32 +00:00
|
|
|
* Create the private key `notify.moe/security/privkey.pem`
|
2017-07-17 03:05:44 +00:00
|
|
|
|
2017-11-01 10:27:30 +00:00
|
|
|
## Browser
|
|
|
|
|
|
|
|
|
|
* Start Chrome via `google-chrome --ignore-certificate-errors`
|
|
|
|
|
|
|
|
|
|
## API keys
|
2017-07-17 03:05:44 +00:00
|
|
|
|
|
|
|
|
* 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"
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
2017-11-01 10:27:30 +00:00
|
|
|
## Run
|
2017-07-17 03:05:44 +00:00
|
|
|
|
|
|
|
|
* Start the web server in notify.moe directory: `run`
|
|
|
|
|
* Open `https://beta.notify.moe` which should now resolve to localhost
|
