1
0
mirror of https://github.com/Unleash/unleash.git synced 2024-12-22 19:07:54 +01:00
unleash.unleash/docs/getting-started.md

41 lines
1.0 KiB
Markdown
Raw Normal View History

2016-12-23 12:00:07 +01:00
# Getting stated
2016-12-02 17:47:13 +01:00
## Requirements
2016-11-30 21:46:40 +01:00
2016-12-02 17:47:13 +01:00
You will need a __PostreSQL__ 9.3+ database instance to be able to run Unleash.
2016-11-30 21:46:40 +01:00
2016-12-02 17:47:13 +01:00
When starting Unleash you must specify a database uri (can be set as environment variable DATABASE_URL)
which includes a username and password, that have rights to migrate the database.
_Unleash_ will, at startup, check whether database migration is needed, and perform necessary migrations.
## Start Unleash
2016-11-30 21:46:40 +01:00
### 1. The simplest way to get started:
```bash
$ npm install unleash-server -g
$ unleash -d postgres://unleash_user:passord@localhost:5432/unleash -p 4242
Unleash started on port:4242
```
2016-11-30 21:46:40 +01:00
### 2. Or programmatically:
2016-12-02 17:47:13 +01:00
You can also depend on unleash
```js
const unleash = require('unleash-server');
unleash.start({
2016-12-27 13:16:34 +01:00
databaseUrl: 'postgres://unleash_user:passord@localhost:5432/unleash'
port: 4242
}).then(unleash => {
console.log(`Unleash started on port:${unleash.app.get('port')}`);
});
```
2016-12-02 17:47:13 +01:00
Available unleash options includes:
2016-12-27 13:16:55 +01:00
- databaseUrl
2016-12-02 17:47:13 +01:00
- port
2016-12-23 12:00:07 +01:00
- logLevel - ('INFO', 'ERROR',)