暫無描述

Sotaro KARASAWA 3e60270f09 Merge pull request #199 from crowi/fix-permissions 9 年之前
bin ab7087512b Added search util 10 年之前
lib 3e60270f09 Merge pull request #199 from crowi/fix-permissions 9 年之前
local_modules 0bba632df5 Remove bluebird require 9 年之前
locales 0ecc7d7653 Update 9 年之前
public 943986dcb9 Fix icons 9 年之前
resource 72b7096436 Supported highlighting of phrase search 9 年之前
test cc193ff39d Merge branch 'wip-v1.6' into support-i18n 9 年之前
tmp 98e80676bd Fix for multer 1.2 9 年之前
.babelrc 706cb9e6ad tmp 10 年之前
.gitignore 95ecee087b modularized fileupload, add support: local storage 10 年之前
.jshintrc c0f47c5f82 Re:Crowi 11 年之前
CHANGES.md 16dc7c6844 CHANGES, README updates 9 年之前
LICENSE 8069792e45 Move license terms to LICENSE file 11 年之前
Procfile c0f47c5f82 Re:Crowi 11 年之前
README.md 16dc7c6844 CHANGES, README updates 9 年之前
app.js 1a3f0ab6be Change init() and buildServer() interface 10 年之前
app.json 32f39265d4 Add bonsai 10 年之前
circle.yml b9a8ba555d Prepare to start 1.6.0 9 年之前
gulpfile.js 0024827b44 Merge branch 'master' into migrate-to-webpack2 9 年之前
npm-shrinkwrap.json 0024827b44 Merge branch 'master' into migrate-to-webpack2 9 年之前
package.json 0024827b44 Merge branch 'master' into migrate-to-webpack2 9 年之前
webpack.config.js 2854b80d3d modify build settings 9 年之前

README.md

Crowi

Crowi - The Simple & Powerful Communication Tool Based on Wiki

Deploy

Circle CI

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 are here.

WARNING

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.

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 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

Environment

  • 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.
  • SECRET_TOKEN: A secret key for verifying the integrity of signed cookies.
  • FILE_UPLOAD: aws (default), local, none

License

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