Keine Beschreibung

Sotaro KARASAWA 61d6cee25c Prepare for 1.6.3 vor 9 Jahren
bin ab7087512b Added search util vor 10 Jahren
lib 93695a679f use polyfill for browsers not implemented Promise vor 9 Jahren
local_modules a4ab794cd4 Use POSIX-style paths. vor 9 Jahren
locales 6c8ee251fe Merge pull request #214 from crowi/redirect-remover vor 9 Jahren
public 943986dcb9 Fix icons vor 9 Jahren
resource e6d39cd901 Merge pull request #235 from crowi/fix-date-format vor 9 Jahren
test 2d7a57249e Page name normalizer: Fix spaces around slash vor 9 Jahren
tmp 98e80676bd Fix for multer 1.2 vor 9 Jahren
.babelrc 48dbe895b2 Get rid of babel-preset-es2015 vor 9 Jahren
.env.sample 2329a47bbf Add .env.sample vor 9 Jahren
.gitignore 2329a47bbf Add .env.sample vor 9 Jahren
.jshintrc c0f47c5f82 Re:Crowi vor 11 Jahren
CHANGES.md 61d6cee25c Prepare for 1.6.3 vor 9 Jahren
LICENSE 8069792e45 Move license terms to LICENSE file vor 11 Jahren
Procfile c0f47c5f82 Re:Crowi vor 11 Jahren
README.md 04beb121a6 Update README vor 9 Jahren
app.js b743594a0c Call dotenv in app.js vor 9 Jahren
app.json 3b0e3d032a set bonsai version for heroku vor 9 Jahren
circle.yml b9a8ba555d Prepare to start 1.6.0 vor 9 Jahren
gulpfile.js 0024827b44 Merge branch 'master' into migrate-to-webpack2 vor 9 Jahren
npm-shrinkwrap.json 61d6cee25c Prepare for 1.6.3 vor 9 Jahren
package.json 61d6cee25c Prepare for 1.6.3 vor 9 Jahren
webpack.config.js 93695a679f use polyfill for browsers not implemented Promise vor 9 Jahren

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.