Home Esplora Aiuto
Accedi
wiki
/
weseek__growi
mirror da https://github.com/weseek/growi
2
0
Forka 0
File Problemi 0 Wiki

Nessuna descrizione

Albero (Tree): 2cbfed13a2
Rami (Branch) Tag
weseek__growi
ZIP TAR.GZ
Yuki Takei 2cbfed13a2 update docs 7 anni fa
.github d1f0f9ec84 Revert "GitBook: [master] 12 pages modified" 7 anni fa
.vscode 1338c63415 update .vscode/settings.json 7 anni fa
bin 3d22a381c4 fix lint errors 8 anni fa
config 66d516d21a add blue night theme 7 anni fa
lib f629e3ca41 ensure to inject logger configurations from environment variables 7 anni fa
local_modules 3d179149c8 fix lint errors 8 anni fa
public 5311a6a457 add icons for Keymap Mode 8 anni fa
resource 0e62f09313 fix RevisionBody className when additionalClassName is undefined 7 anni fa
test 36331f279b fix isCreatableName and test 7 anni fa
tmp b875cefd69 add tmp/plugins dir 9 anni fa
.babelrc 48dbe895b2 Get rid of babel-preset-es2015 8 anni fa
.editorconfig 2d42c72e58 add .editorconfig 9 anni fa
.eslintignore d00f8ac763 fix lint errors 8 anni fa
.eslintrc.js 3a5ceb5bab set scmaVersion 8 7 anni fa
.gitignore 2895a572ed add vscode files for debug 7 anni fa
.node-dev.json dc3af550d5 use node-dev and easy-livereload 9 anni fa
CHANGES.md 2cbfed13a2 update docs 7 anni fa
LICENSE 282f6c3101 Update LICENSE 8 anni fa
Procfile dbc71db496 fix Procfile 8 anni fa
README.md 39cfd97e37 remove redis description 7 anni fa
THIRD-PARTY-NOTICES.md d1f0f9ec84 Revert "GitBook: [master] 12 pages modified" 7 anni fa
app.js b2296f2b04 fix error handling 8 anni fa
app.json a507cc6185 add description 8 anni fa
package.json 4c2cbc8006 upgrade libs 7 anni fa
wercker.yml a12156df71 set MONGO_URL when build-prod step runs 8 anni fa
yarn.lock 4c2cbc8006 upgrade libs 7 anni fa

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 ElasticSearch, add environment variables before npm start like following:

export MONGO_URI=mongodb://MONGO_HOST:MONGO_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
    • ELASTICSEARCH_URI: URI to connect to Elasticearch.
    • REDIS_URI: URI to connect to Redis (to session store).
    • PLANTUML_URI: URI to connect to PlantUML server.
    • BLOCKDIAG_URI: URI to connect to blockdiag server.
    • PASSWORD_SEED: A password seed used by password hash generator.
    • SECRET_TOKEN: A secret key for verifying the integrity of signed cookies.
    • SESSION_NAME: The name of the session ID cookie to set in the response by Express. default: connect.sid
    • 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.