Ei kuvausta

Sotaro KARASAWA ee68f74dbb Update shrinkwrap 8 vuotta sitten
bin 990bd814e0 Added exit 8 vuotta sitten
lib 1ff7f10388 Move from botkit to @slack/client 8 vuotta sitten
local_modules a4ab794cd4 Use POSIX-style paths. 9 vuotta sitten
locales 6c8ee251fe Merge pull request #214 from crowi/redirect-remover 9 vuotta sitten
public 943986dcb9 Fix icons 9 vuotta sitten
resource 903d320a2a Style update 8 vuotta sitten
test c2a844e371 Merge remote-tracking branch 'origin/api-page-get-by-id' into wip-v1.6.3 8 vuotta sitten
tmp 98e80676bd Fix for multer 1.2 9 vuotta sitten
.babelrc 48dbe895b2 Get rid of babel-preset-es2015 9 vuotta sitten
.env.sample 2329a47bbf Add .env.sample 9 vuotta sitten
.gitignore 2329a47bbf Add .env.sample 9 vuotta sitten
.jshintrc c0f47c5f82 Re:Crowi 11 vuotta sitten
CHANGES.md 61d6cee25c Prepare for 1.6.3 8 vuotta sitten
LICENSE 8069792e45 Move license terms to LICENSE file 11 vuotta sitten
Procfile c0f47c5f82 Re:Crowi 11 vuotta sitten
README.md 04beb121a6 Update README 9 vuotta sitten
app.js b743594a0c Call dotenv in app.js 9 vuotta sitten
app.json 3b0e3d032a set bonsai version for heroku 9 vuotta sitten
circle.yml b9a8ba555d Prepare to start 1.6.0 9 vuotta sitten
gulpfile.js 0024827b44 Merge branch 'master' into migrate-to-webpack2 9 vuotta sitten
npm-shrinkwrap.json ee68f74dbb Update shrinkwrap 8 vuotta sitten
package.json 1ff7f10388 Move from botkit to @slack/client 8 vuotta sitten
webpack.config.js 93695a679f use polyfill for browsers not implemented Promise 9 vuotta sitten

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.