JavaScript HTML CSS
Latest commit 8ad668c Jul 12, 2018
Permalink
Failed to load latest commit information.
bin Added exit Sep 10, 2017
client Merge pull request #309 from crowi/fix-reveal.js Jul 12, 2018
elasticsearch Downgrade May 14, 2018
lib Merge pull request #309 from crowi/fix-reveal.js Jul 12, 2018
local_modules Fix no-unused-vars (not breaking changes) Jun 26, 2018
locales Convert JSON to YAML Jun 15, 2018
public Upgrade from version 4 May 21, 2018
resource Bundle reveal.js files with webpack Jun 29, 2018
test Fix new-cap Jun 26, 2018
tmp Fix for multer 1.2 Jan 17, 2017
tools Merge pull request #309 from crowi/fix-reveal.js Jul 12, 2018
.babelrc Add aliases Jun 25, 2018
.dockerignore Ignore node_modules May 15, 2018
.env.sample Use babel to run app Feb 9, 2018
.eslintignore Add ignore files Jun 5, 2018
.eslintrc Fix no-new-wrappers Jun 26, 2018
.flowconfig Move files Feb 12, 2018
.gitignore Add compose file Mar 12, 2018
.prettierignore Add ignore files Jun 5, 2018
.prettierrc Add rc files Jun 5, 2018
CHANGES.md Fix bonsai version for heroku. May 16, 2018
Dockerfile Upgade npm@5 May 21, 2018
LICENSE Move license terms to LICENSE file Feb 9, 2015
Procfile Re:Crowi Aug 18, 2014
README.md Update docker-compose May 25, 2018
app.js npm run format Jun 5, 2018
app.json Fix bonsai version for heroku. May 16, 2018
circle.yml Lint Jun 8, 2018
docker-compose.development.yml Colorize output Jun 15, 2018
jsconfig.json Add aliases Jun 25, 2018
package-lock.json Update package-lock.json Jul 6, 2018
package.json Merge branch 'master' into fix-reveal.js Jul 3, 2018

README.md

Crowi

Crowi - The Simple & Powerful Communication Tool Based on Wiki

Deploy

Circle CI Join the chat at https://gitter.im/crowi/general

Crowi is:

  • Easy to edit and share,
  • Markdown supported,
  • Useful timeline list view,
  • Fast.

Install

Install dependencies and build CSS and JavaScript:

$ npm install

More info is here.

WARNING

Don't use master branch because it is unstable. Use released version except when you want to contribute to the project.

Dependencies

  • Node.js (6.x)
  • MongoDB
  • Elasticsearch (optional) (Doc is here)
  • Redis (optional)
  • Amazon S3 (optional)
  • Google Project (optional)
  • Slack App (optional)

Start Up on 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

or please write .env.

Environment

  • PORT: Server port. default: 3000.
  • NODE_ENV: production OR development.
  • 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

Optional:

  • MATHJAX: If set 1, enable MathJax feature.
  • PLANTUML_URI: If set the url of PlantUML server, then enable PlantUML feature. e.g. http://localhost:18080.

see: .env.sample

For develop

We can use docker-compose for develop without complicated settings.

$ docker-compose -f docker-compose.development.yml up

Features

  • Express restarts when a file changed
  • Gulp compiled assets automatically

When a trouble occured

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

License

  • The MIT License (MIT)
  • See LICENSE file.