홈 탐색 도움말
로그인
wiki
/
weseek__growi
의 미러 https://github.com/weseek/growi
2
0
포크 0
파일 이슈 0 위키

설명 없음

트리: 0349524f1a
브랜치 태그
weseek__growi
ZIP TAR.GZ
Yuki Takei 0349524f1a rewrite PluginUtils.listPluginNames synchronous ver 9 년 전
bin ab7087512b Added search util 10 년 전
config dc3af550d5 use node-dev and easy-livereload 9 년 전
lib 0349524f1a rewrite PluginUtils.listPluginNames synchronous ver 9 년 전
local_modules 0bba632df5 Remove bluebird require 9 년 전
locales 0ecc7d7653 Update 9 년 전
public fdf992adde inject js to server's html templates 9 년 전
resource 5f10ff8439 give up HMR and impl watch&autorefresh scripts 9 년 전
test cc193ff39d Merge branch 'wip-v1.6' into support-i18n 9 년 전
tmp 98e80676bd Fix for multer 1.2 9 년 전
.babelrc 706cb9e6ad tmp 10 년 전
.editorconfig 2d42c72e58 add .editorconfig 9 년 전
.gitignore fdf992adde inject js to server's html templates 9 년 전
.jshintrc c0f47c5f82 Re:Crowi 11 년 전
.node-dev.json dc3af550d5 use node-dev and easy-livereload 9 년 전
CHANGES.md 16dc7c6844 CHANGES, README updates 9 년 전
LICENSE 8069792e45 Move license terms to LICENSE file 11 년 전
Procfile c0f47c5f82 Re:Crowi 11 년 전
README.md 3f88b589c7 Merge pull request #3 from yuki-takei/master 9 년 전
app.js 06b5a3ebc0 modify setup orders of server(to ensure that setting routes is at last) 9 년 전
app.json 32f39265d4 Add bonsai 10 년 전
circle.yml b9a8ba555d Prepare to start 1.6.0 9 년 전
gulpfile.js 0024827b44 Merge branch 'master' into migrate-to-webpack2 9 년 전
package.json 957a244cd8 impl plugin-loader-v2 9 년 전
webpack.config.js 750ea3d040 WIP: constructing webpack.common.config.js 9 년 전

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 are here.

WARNING

Don't use master branch because it is unstable but use released tag version expect when you want to contribute the project. master branch is prepared for v1.6. See here to know further info.

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 setting up to Heroku or some PaaS, but you can start up Crowi with ENV parameter on your local.

$ PASSWORD_SEED=somesecretstring MONGO_URI=mongodb://username:password@localhost/crowi node app.js

Environment

  • PORT: Server port. default: 3000.
  • NODE_ENV: production OR development.
  • MONGO_URI: URI to connect MongoDB. This parameter is also by MONGOHQ_URL OR MONGOLAB_URI.
  • REDIS_URL: URI to connect Redis (to session store). This parameter is also by REDISTOGO_URL.
  • ELASTICSEARCH_URI: URI to connect Elasticearch.
  • PASSWORD_SEED: A password seed is used by password hash generator.
  • SECRET_TOKEN: A secret key for verifying the integrity of signed cookies.
  • FILE_UPLOAD: aws (default), local, none

(Opt.) Install Plugins

Install plugins from github:

$ npm run install-plugin https://github.com/sopmeone/crowi-plugin-something.git

Modify plugin/plugin.js:

const plugins = [
  require('crowi-plugin-something')
]

Build plugins:

$ npm run webpack:plugin

After above process, rebooting Crowi is required.

CAUTION

Plugins are DISABLED in default settings.
Change it on admin page.

License

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