Trang chủ Khám phá Trợ giúp
Đăng nhập
wiki
/
weseek__growi
mirror of https://github.com/weseek/growi
2
0
Fork 0
Các tập tin Các vấn đề 0 Wiki

Không có mô tả

Tree: 9cbc7d312a
Branches Tags
weseek__growi
ZIP TAR.GZ
Yuki Takei 9cbc7d312a add comments 9 năm trước cách đây
bin 9cbc7d312a add comments 9 năm trước cách đây
config c72da9d0e8 BugFix remove unnecessary configuration 9 năm trước cách đây
lib 504f1faac0 impl bin/generate-plugin-definitions-source.js 9 năm trước cách đây
local_modules 0bba632df5 Remove bluebird require 9 năm trước cách đây
locales 0ecc7d7653 Update 9 năm trước cách đây
public fdf992adde inject js to server's html templates 9 năm trước cách đây
resource 9cbc7d312a add comments 9 năm trước cách đây
test cc193ff39d Merge branch 'wip-v1.6' into support-i18n 9 năm trước cách đây
tmp 98e80676bd Fix for multer 1.2 9 năm trước cách đây
.babelrc 706cb9e6ad tmp 10 năm trước cách đây
.editorconfig 2d42c72e58 add .editorconfig 9 năm trước cách đây
.gitignore 504f1faac0 impl bin/generate-plugin-definitions-source.js 9 năm trước cách đây
.jshintrc c0f47c5f82 Re:Crowi 11 năm trước cách đây
.node-dev.json dc3af550d5 use node-dev and easy-livereload 9 năm trước cách đây
CHANGES.md 16dc7c6844 CHANGES, README updates 9 năm trước cách đây
LICENSE 8069792e45 Move license terms to LICENSE file 11 năm trước cách đây
Procfile c0f47c5f82 Re:Crowi 11 năm trước cách đây
README.md 3f88b589c7 Merge pull request #3 from yuki-takei/master 9 năm trước cách đây
app.js 06b5a3ebc0 modify setup orders of server(to ensure that setting routes is at last) 9 năm trước cách đây
app.json 32f39265d4 Add bonsai 10 năm trước cách đây
circle.yml b9a8ba555d Prepare to start 1.6.0 9 năm trước cách đây
gulpfile.js 0024827b44 Merge branch 'master' into migrate-to-webpack2 9 năm trước cách đây
package.json 504f1faac0 impl bin/generate-plugin-definitions-source.js 9 năm trước cách đây
webpack.config.js 750ea3d040 WIP: constructing webpack.common.config.js 9 năm trước cách đây

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.