Crowi is:
- Easy to edit and share,
- Markdown supported,
- Useful timeline list view,
- Fast.
Install dependencies and build CSS and JavaScript:
$ npm install
More info are here.
Don't use master
branch because it is unstable but use released tag version expect when you want to contribute the project.
master
branch is prepared for v1.6. See here to know further info.
- Node.js (6.x)
- MongoDB
- Elasticsearch (optional) (Doc is here)
- Redis (optional)
- Amazon S3 (optional)
- Google Project (optional)
- Slack App (optional)
Crowi is designed setting up to Heroku or some PaaS, but you can start up Crowi with ENV parameter on your local.
$ PASSWORD_SEED=somesecretstring MONGO_URI=mongodb://username:password@localhost/crowi node app.js
PORT
: Server port. default:3000
.NODE_ENV
:production
ORdevelopment
.MONGO_URI
: URI to connect MongoDB. This parameter is also byMONGOHQ_URL
ORMONGOLAB_URI
.REDIS_URL
: URI to connect Redis (to session store). This parameter is also byREDISTOGO_URL
.ELASTICSEARCH_URI
: URI to connect Elasticearch.PASSWORD_SEED
: A password seed is used by password hash generator.SECRET_TOKEN
: A secret key for verifying the integrity of signed cookies.FILE_UPLOAD
:aws
(default),local
,none
- The MIT License (MIT)
- See LICENSE file.