Brak opisu

Norio Suzuki e3a1273ab4 Fixed the tab key handler. when pressed ctrl+tab key, nothing to do 8 lat temu
bin ab7087512b Added search util 10 lat temu
lib 93695a679f use polyfill for browsers not implemented Promise 8 lat temu
local_modules a4ab794cd4 Use POSIX-style paths. 9 lat temu
locales 6c8ee251fe Merge pull request #214 from crowi/redirect-remover 9 lat temu
public 943986dcb9 Fix icons 9 lat temu
resource e3a1273ab4 Fixed the tab key handler. when pressed ctrl+tab key, nothing to do 8 lat temu
test 2d7a57249e Page name normalizer: Fix spaces around slash 9 lat temu
tmp 98e80676bd Fix for multer 1.2 9 lat temu
.babelrc 48dbe895b2 Get rid of babel-preset-es2015 8 lat temu
.env.sample 2329a47bbf Add .env.sample 8 lat temu
.gitignore 2329a47bbf Add .env.sample 8 lat temu
.jshintrc c0f47c5f82 Re:Crowi 11 lat temu
CHANGES.md 2fa8a3c6ed Update 8 lat temu
LICENSE 8069792e45 Move license terms to LICENSE file 11 lat temu
Procfile c0f47c5f82 Re:Crowi 11 lat temu
README.md 04beb121a6 Update README 8 lat temu
app.js b743594a0c Call dotenv in app.js 8 lat temu
app.json 3b0e3d032a set bonsai version for heroku 8 lat temu
circle.yml b9a8ba555d Prepare to start 1.6.0 9 lat temu
gulpfile.js 0024827b44 Merge branch 'master' into migrate-to-webpack2 9 lat temu
npm-shrinkwrap.json 94d75a5702 Introduce dotenv 8 lat temu
package.json 94d75a5702 Introduce dotenv 8 lat temu
webpack.config.js 93695a679f use polyfill for browsers not implemented Promise 8 lat temu

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

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

see: .env.sample

License

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