بدون توضیح

Sotaro KARASAWA 2e905e09ff Merge pull request #231 from crowi/support-plantuml 8 سال پیش
bin ab7087512b Added search util 10 سال پیش
lib 41cd70c485 Support PlantUML 8 سال پیش
local_modules a4ab794cd4 Use POSIX-style paths. 9 سال پیش
locales 6c8ee251fe Merge pull request #214 from crowi/redirect-remover 9 سال پیش
public 943986dcb9 Fix icons 9 سال پیش
resource 41cd70c485 Support PlantUML 8 سال پیش
test 2d7a57249e Page name normalizer: Fix spaces around slash 9 سال پیش
tmp 98e80676bd Fix for multer 1.2 9 سال پیش
.babelrc 68f2f929e3 Upgrade babel 9 سال پیش
.gitignore 95ecee087b modularized fileupload, add support: local storage 10 سال پیش
.jshintrc c0f47c5f82 Re:Crowi 11 سال پیش
CHANGES.md 8ee10efd13 CHANGES 9 سال پیش
LICENSE 8069792e45 Move license terms to LICENSE file 11 سال پیش
Procfile c0f47c5f82 Re:Crowi 11 سال پیش
README.md 8b5a613a58 Fix English (grammar and more) 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 eac9c8f163 update package.json 8 سال پیش
package.json eac9c8f163 update package.json 8 سال پیش
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 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

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

License

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