暫無描述

Sotaro KARASAWA 1ff7f10388 Move from botkit to @slack/client 8 年之前
bin 990bd814e0 Added exit 8 年之前
lib 1ff7f10388 Move from botkit to @slack/client 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 903d320a2a Style update 8 年之前
test c2a844e371 Merge remote-tracking branch 'origin/api-page-get-by-id' into wip-v1.6.3 8 年之前
tmp 98e80676bd Fix for multer 1.2 9 年之前
.babelrc 48dbe895b2 Get rid of babel-preset-es2015 9 年之前
.env.sample 2329a47bbf Add .env.sample 9 年之前
.gitignore 2329a47bbf Add .env.sample 9 年之前
.jshintrc c0f47c5f82 Re:Crowi 11 年之前
CHANGES.md 61d6cee25c Prepare for 1.6.3 8 年之前
LICENSE 8069792e45 Move license terms to LICENSE file 11 年之前
Procfile c0f47c5f82 Re:Crowi 11 年之前
README.md 04beb121a6 Update README 9 年之前
app.js b743594a0c Call dotenv in app.js 9 年之前
app.json 3b0e3d032a set bonsai version for heroku 9 年之前
circle.yml b9a8ba555d Prepare to start 1.6.0 9 年之前
gulpfile.js 0024827b44 Merge branch 'master' into migrate-to-webpack2 9 年之前
npm-shrinkwrap.json 84d74414b2 Update test libraries 8 年之前
package.json 1ff7f10388 Move from botkit to @slack/client 8 年之前
webpack.config.js 93695a679f use polyfill for browsers not implemented Promise 8 年之前

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.