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 is here.
Don't use master
branch because it is unstable. Use released version except when you want to contribute to the project.
- Node.js (6.x)
- MongoDB
- Elasticsearch (optional) (Doc is here)
- Redis (optional)
- Amazon S3 (optional)
- Google Project (optional)
- Slack App (optional)
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
or please write .env
.
PORT
: Server port. default:3000
.NODE_ENV
:production
ORdevelopment
.MONGO_URI
: URI to connect to MongoDB. This parameter is also byMONGOHQ_URL
ORMONGOLAB_URI
.REDIS_URL
: URI to connect to Redis (to session store). This parameter is also byREDISTOGO_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
Optional:
MATHJAX
: If set1
, enable MathJax feature.PLANTUML_URI
: If set the url of PlantUML server, then enable PlantUML feature. e.g.http://localhost:18080
.
see: .env.sample
We can use docker-compose for develop without complicated settings.
$ docker-compose -f docker-compose.development.yml up
- Express restarts when a file changed
- Gulp compiled assets automatically
Please try the following commands.
# Stop containers
$ docker-compose -f docker-compose.development.yml stop
# Remove containers
$ docker-compose -f docker-compose.development.yml rm
# Remove images
$ docker-compose -f docker-compose.development.yml images -q | xargs docker rmi -f
# Build images
$ docker-compose -f docker-compose.development.yml build
- The MIT License (MIT)
- See LICENSE file.