Почетна Преглед Помоћ
Пријавите се
wiki
/
weseek__growi
огледало од https://github.com/weseek/growi
2
0
Креирај огранак 0
Датотеке Дискусије 0 Вики

Нема описа

Дрво: 45cff09c2f
Гране Ознаке
weseek__growi
ZIP TAR.GZ
Yuki Takei 45cff09c2f During the experiment of live-reload пре 9 година
bin ab7087512b Added search util пре 10 година
config 45cff09c2f During the experiment of live-reload пре 9 година
lib 45cff09c2f During the experiment of live-reload пре 9 година
local_modules 0bba632df5 Remove bluebird require пре 9 година
locales 0ecc7d7653 Update пре 9 година
public fdf992adde inject js to server's html templates пре 9 година
resource 45cff09c2f During the experiment of live-reload пре 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 година
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 1a3f0ab6be Change init() and buildServer() interface пре 10 година
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 45cff09c2f During the experiment of live-reload пре 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.