Skip to content

Latest commit

 

History

History
145 lines (94 loc) · 5.28 KB

INSTALL.md

File metadata and controls

145 lines (94 loc) · 5.28 KB
Raw

Install

This Guide will help you install meiliNG in no time.

Last Update: v.0.9.0-SNAPSHOT

Getting Started

Hello, Welcome to meiliNG, an oAuth2 based authentication engine to build your customized login in no time.

Installing Dependenices

Installing Node

meiliNG works best with latest LTS version of Node, Please go here to install it by yourself.

Installing Yarn

meiliNG uses yarn for managing dependencies of application.

Note
Currently Yarn 1.x is preferred due to compatibility issues.

Installing node_modules

meiliNG does depend on lots of packages on npmjs.org which does not come out of box.
Please install node dependencies with yarn command.

(Optional) Generate Prisma Definition Files

On postinstall of node_modules or any updates, yarn should automatically generate prisma definition files. you can generate prisma definition files via prisma's internal commands.

Please run yarn generate if the prisma definition files are not properly generated.

Configuring Environment Variables

meiliNG comes with various config methods.
You can use sample .env file (.env.example) shipped with this repository. In order to use it, just copy .env.example to .env

Setting up Database

Setting up MariaDB (or mySQL)

meiliNG uses prisma, a next-generation ORM for Node.JS. Install MariaDB or mySQL depending on your platform.

Setting Database URL

Prisma by default uses environment variables to get URL for connecting database. In order to configure database, you should configure database credentials into URL form.

You should set environment variable DATABASE_URL or edit .env file to following:

  • MySQL/MariaDB: mysql://username:password@host:port/database

Setting up automatically

Run yarn configure and follow the directions on screen.

Note
@ldmsys is currently working on automatic installer for meiliNG.
If you looking for one, Check Issue#49

Setting up manually (Deploy Database)

Use prisma db push to deploy database to specified database you declared above.

Setting up manually (Configuration)

From v0.4.0, Usage of .env is recommended than using config.js.

The following is a example .env files.

### ==== CONFIGURATIONS FOR PRISMA ====

## Database

# This is a database URL for setting up database for meiling.
DATABASE_URL="mysql://username:password@host:port/database?schema=public"

### ==== CONFIGURATIONS FOR MEILING ==== 

## meiliNG API configs

# Hostname of meiliNG (where this api will be served)
MEILING_HOSTNAME="https://demo.meili.ng"

# Allowed Frontend URLs (comma separated)
# > These are the frontend URLs (the app user faces when using meiliNG)
# > These configurations are used for CORS setting of /v1/meiling endpoints
# > Therefore, preventing others webpages pretend being legitimate account webpage
FRONTEND_URLS="https://frontend-1.meili.ng,https://frontend-2.meili.ng,http://also.with.ports:3000"

# The frontend URL for device code verification
MEILING_DEVICE_CODE_VERIFICATION_URL="https://frontend.meili.ng/device"

# The listening port/socket for meiliNG (UNIX Sockets are supported)
FASTIFY_LISTEN=8080

# Is meiliNG behind a reverse proxy? (1: yes, 0: no)
FASTIFY_USE_PROXY=1



## OpenID Configuration

# The "issuer" on OpenID Connect id_token
OPENID_ISSUING_AUTHORITY="https://demo.meili.ng"

# Deprecated: use "yarn keygen" will automatically generate certificates for creating JWTs
OPENID_SECRET_KEY=""

NOTIFICATION_API_HOST="http://notification.meili.ng"
NOTIFICATION_API_KEY="notificationAPIMeilingSecret"



## meiliNG Admin Configuration

# The tokens (comma separated) for accessing Administrator endpoints: /v1/admin
# > These can also be used for Basic Authorization by putting base64-ed username:password format
ADMIN_TOKENS="HakureiShrine,HongMeiling"

# Allowed Admin Frontend URLs (comma separated)
# > These are the frontend URLs for administration (the app admin faces when using meiliNG)
# > These configurations are used for CORS setting of /v1/admin endpoints
ADMIN_FRONTEND_URLS="https://frontend-1.meili.ng,https://frontend-2.meili.ng,http://also.with.ports:3000"

Setting up Manually (Configuring OpenID JWT SecretKey)

These are the secret key to sign your OpenID Token. Please make sure this is long enough and random enough.

Please Run the following:

yarn keygen

Configuring Notification API

--- Deprecated will fully removed on 0.10.0 ---

Start meiliNG

Transpile Typescript Code

In order to start meiliNG, you should compile Typescript code into JavaScript code to let node to run.

  1. Run yarn build

You should do this every time you edit your source code or if there is any update of meiliNG.

Run Application

You can start application by typing yarn start.