|
|
@@ -25,11 +25,11 @@ Install dependencies and build CSS and JavaScript:
|
|
|
|
|
|
$ npm install
|
|
|
|
|
|
-More info are [here](https://github.com/crowi/crowi/wiki/Install-and-Configuration).
|
|
|
+More info is [here](https://github.com/crowi/crowi/wiki/Install-and-Configuration).
|
|
|
|
|
|
### WARNING
|
|
|
|
|
|
-Don't use `master` branch because it is unstable but use released tag version expect when you want to contribute the project.
|
|
|
+Don't use `master` branch because it is unstable. Use released version except when you want to contribute to the project.
|
|
|
|
|
|
|
|
|
Dependencies
|
|
|
@@ -47,7 +47,7 @@ Dependencies
|
|
|
Start Up on Local
|
|
|
-------------------
|
|
|
|
|
|
-Crowi is designed setting up to Heroku or some PaaS, but you can start up Crowi with ENV parameter on your local.
|
|
|
+Crowi is designed to be set up on Heroku or some PaaS, but you can also start up Crowi with ENV parameter on your local.
|
|
|
|
|
|
```
|
|
|
$ PASSWORD_SEED=somesecretstring MONGO_URI=mongodb://username:password@localhost/crowi node app.js
|
|
|
@@ -58,10 +58,10 @@ $ PASSWORD_SEED=somesecretstring MONGO_URI=mongodb://username:password@localhost
|
|
|
|
|
|
* `PORT`: Server port. default: `3000`.
|
|
|
* `NODE_ENV`: `production` OR `development`.
|
|
|
-* `MONGO_URI`: URI to connect MongoDB. This parameter is also by `MONGOHQ_URL` OR `MONGOLAB_URI`.
|
|
|
-* `REDIS_URL`: URI to connect Redis (to session store). This parameter is also by `REDISTOGO_URL`.
|
|
|
-* `ELASTICSEARCH_URI`: URI to connect Elasticearch.
|
|
|
-* `PASSWORD_SEED`: A password seed is used by password hash generator.
|
|
|
+* `MONGO_URI`: URI to connect to MongoDB. This parameter is also by `MONGOHQ_URL` OR `MONGOLAB_URI`.
|
|
|
+* `REDIS_URL`: URI to connect to Redis (to session store). This parameter is also by `REDISTOGO_URL`.
|
|
|
+* `ELASTICSEARCH_URI`: URI to connect to Elasticearch.
|
|
|
+* `PASSWORD_SEED`: A password seed used by password hash generator.
|
|
|
* `SECRET_TOKEN`: A secret key for verifying the integrity of signed cookies.
|
|
|
* `FILE_UPLOAD`: `aws` (default), `local`, `none`
|
|
|
|