Home Explore Help
Sign In
wiki
/
weseek__growi
mirror of https://github.com/weseek/growi
2
0
Fork 0
Files Issues 0 Wiki

No Description

Tree: 990bd814e0
Branches Tags
weseek__growi
ZIP TAR.GZ
Sotaro KARASAWA 990bd814e0 Added exit 8 years ago
bin 990bd814e0 Added exit 8 years ago
lib 93695a679f use polyfill for browsers not implemented Promise 9 years ago
local_modules a4ab794cd4 Use POSIX-style paths. 9 years ago
locales 6c8ee251fe Merge pull request #214 from crowi/redirect-remover 9 years ago
public 943986dcb9 Fix icons 9 years ago
resource 903d320a2a Style update 8 years ago
test 84d74414b2 Update test libraries 8 years ago
tmp 98e80676bd Fix for multer 1.2 9 years ago
.babelrc 48dbe895b2 Get rid of babel-preset-es2015 9 years ago
.env.sample 2329a47bbf Add .env.sample 9 years ago
.gitignore 2329a47bbf Add .env.sample 9 years ago
.jshintrc c0f47c5f82 Re:Crowi 11 years ago
CHANGES.md 61d6cee25c Prepare for 1.6.3 8 years ago
LICENSE 8069792e45 Move license terms to LICENSE file 11 years ago
Procfile c0f47c5f82 Re:Crowi 11 years ago
README.md 04beb121a6 Update README 9 years ago
app.js b743594a0c Call dotenv in app.js 9 years ago
app.json 3b0e3d032a set bonsai version for heroku 9 years ago
circle.yml b9a8ba555d Prepare to start 1.6.0 9 years ago
gulpfile.js 0024827b44 Merge branch 'master' into migrate-to-webpack2 9 years ago
npm-shrinkwrap.json 84d74414b2 Update test libraries 8 years ago
package.json 84d74414b2 Update test libraries 8 years ago
webpack.config.js 93695a679f use polyfill for browsers not implemented Promise 9 years ago

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.