Domů Procházet Nápověda
Přihlásit se
wiki
/
weseek__growi
zrcadlo https://github.com/weseek/growi
2
0
Rozštěpit 0
Soubory Úkoly 0 Wiki

Bez popisu

Strom: e64870a2ff
Větve Značky
weseek__growi
ZIP TAR.GZ
sou e64870a2ff toBoolean to toBooleanStrict před 8 roky
.github 7770c76f37 WIP: replace 'crowi' to 'growi' před 8 roky
bin 6792d218bc modify the top level logger name to 'growi' před 8 roky
config 021ac36256 organize logger před 8 roky
lib e64870a2ff toBoolean to toBooleanStrict před 8 roky
local_modules 6792d218bc modify the top level logger name to 'growi' před 8 roky
public 5311a6a457 add icons for Keymap Mode před 8 roky
resource 55edfbf853 differentiate markdown/plain comments in backend před 8 roky
test b280931401 fix test před 8 roky
tmp b875cefd69 add tmp/plugins dir před 9 roky
.babelrc 48dbe895b2 Get rid of babel-preset-es2015 před 8 roky
.editorconfig 2d42c72e58 add .editorconfig před 9 roky
.eslintrc.js bf92d07a04 optimize: share emoji_strategy_shrink.json data před 8 roky
.gitignore 53a26e9440 add package-lock.json to .gitignore před 8 roky
.node-dev.json dc3af550d5 use node-dev and easy-livereload před 9 roky
CHANGES.md 33a675c256 update docs před 8 roky
LICENSE 282f6c3101 Update LICENSE před 8 roky
Procfile dbc71db496 fix Procfile před 8 roky
README.md 23d684d28b Update README.md před 8 roky
THIRD-PARTY-NOTICES.md 9a326e38d6 replace "crowi-plus" with "GROWI" před 8 roky
app.js 7500155d69 use bunyan and remove pino před 8 roky
app.json 148d74380f add growi-plugin-pukiwiki-like-linker for to INSTALL_PLUGINS list for Heroku před 8 roky
package.json 17178444b3 Merge pull request #391 from weseek/support/use-bunyan2 před 8 roky
webpack.config.js 750ea3d040 WIP: constructing webpack.common.config.js před 9 roky
wercker.yml 7770c76f37 WIP: replace 'crowi' to 'growi' před 8 roky
yarn.lock 17178444b3 Merge pull request #391 from weseek/support/use-bunyan2 před 8 roky

README.md

Demo Site

GROWI

wercker status dependencies status devDependencies Status docker pulls

Features

Quick Start for Production

Using Heroku

  1. Go to https://heroku.com/deploy
  2. (Optional) Input INSTALL_PLUGINS to install plugins

Using docker-compose

git clone https://github.com/weseek/growi-docker-compose.git growi
cd growi
docker-compose up

See also weseek/growi-docker-compose

On-premise

Migration Guide from Crowi is here.

Dependencies

  • node 8.x (DON'T USE 9.x)
  • npm 5.x
  • yarn
  • MongoDB 3.x

See confirmed versions.

Optional Dependencies

How to start

Build and run the app

git clone https://github.com/weseek/growi.git
cd growi
yarn
MONGO_URI=mongodb://MONGO_HOST:MONGO_PORT/growi npm start

DO NOT USE npm install, use yarn instead.

If you launch growi with Redis and ElasticSearch, add environment variables before npm start like following:

export MONGO_URI=mongodb://MONGO_HOST:MONGO_PORT/growi
export REDIS_URL=redis://REDIS_HOST:REDIS_PORT/growi
export ELASTICSEARCH_URI=http://ELASTICSEARCH_HOST:ELASTICSEARCH_PORT/growi
npm start

For more info, see Developers Guide and Crowi documents.

Command details

|command|desc| |--|--| |npm run build:prod|Build the client| |npm run server:prod|Launch the server| |npm start|Invoke npm run build:prod and npm run server:prod|

How to upgrade

git pull
yarn
npm start

How to install plugins

  • Stop server if server is running
  • yarn add to install plugin or npm install
  • npm start to build client app and start server

Examples

yarn add growi-plugin-lsx
npm start

For more info, see Developers Guide on Wiki.

Environment Variables

  • Required
    • MONGO_URI: URI to connect to MongoDB.
  • Option
    • NODE_ENV: production OR development.
    • PORT: Server port. default: 3000
    • REDIS_URL: URI to connect to Redis (to session store).
    • SESSION_NAME: The name of the session ID cookie to set in the response by Express. default: connect.sid
    • 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

Documentation

Contribution

For development

Build and Run the app

  1. clone this repository
  2. yarn to install all dependencies
    • DO NOT USE npm install
  3. npm run build to build client app
  4. npm run server to start the dev server
  5. Access http://0.0.0.0:3000

Found a Bug?

If you found a bug in the source code, you can help us by submitting an issue to our GitHub Repository. Even better, you can submit a Pull Request with a fix.

Missing a Feature?

You can request a new feature by submitting an issue to our GitHub Repository. If you would like to implement a new feature, firstly please submit the issue with your proposal to make sure we can confirm it. Please clarify what kind of change you would like to propose.

  • For a Major Feature, firstly open an issue and outline your proposal so it can be discussed. It also allows us to coordinate better, prevent duplication of work and help you to create the change so it can be successfully accepted into the project.
  • Small Features can be created and directly submitted as a Pull Request.

Language

You can write issues and PRs in English or Japanese.

Discussion

If you have questions or suggestions, you can join our Slack team and talk about anything, anytime.

License

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