Halaman utama Jelajahi Bantuan
Masuk
wiki
/
weseek__growi
cermin dari https://github.com/weseek/growi
2
0
Fork 0
Berkas Masalah 0 Wiki

Tidak Ada Deskripsi

Pohon: 354b43779d
Ranting Tag
weseek__growi
ZIP TAR.GZ
sou 354b43779d case 7 tahun lalu
.github 7770c76f37 WIP: replace 'crowi' to 'growi' 8 tahun lalu
.vscode 1338c63415 update .vscode/settings.json 7 tahun lalu
bin 3d22a381c4 fix lint errors 8 tahun lalu
config 99f421b278 organize dll list 7 tahun lalu
lib 354b43779d case 7 tahun lalu
local_modules 3665addacb clean code 7 tahun lalu
public 98d186288d modify webpack output settings 7 tahun lalu
resource 9078618736 Merge branch 'master' into imprv/add-option-preventXSS-sou 7 tahun lalu
test 36331f279b fix isCreatableName and test 7 tahun lalu
tmp b875cefd69 add tmp/plugins dir 9 tahun lalu
.babelrc 90ef4ebfe7 add lodash-webpack-plugin 7 tahun lalu
.editorconfig 2d42c72e58 add .editorconfig 9 tahun lalu
.eslintignore d00f8ac763 fix lint errors 8 tahun lalu
.eslintrc.js 6b5fea4238 add no-var rule to eslint 7 tahun lalu
.gitignore b51b0c5b93 update .gitignore 7 tahun lalu
.node-dev.json dc3af550d5 use node-dev and easy-livereload 9 tahun lalu
CHANGES.md 0d7ddc4bc4 :+1: version and update docs 7 tahun lalu
LICENSE 282f6c3101 Update LICENSE 8 tahun lalu
Procfile dbc71db496 fix Procfile 8 tahun lalu
README.md 229b658f46 Update README.md 7 tahun lalu
THIRD-PARTY-NOTICES.md 8f53061bef Add Apache License 2.0 Notice 7 tahun lalu
app.js b2296f2b04 fix error handling 8 tahun lalu
app.json a507cc6185 add description 8 tahun lalu
package.json 0d7ddc4bc4 :+1: version and update docs 7 tahun lalu
wercker.yml a12156df71 set MONGO_URL when build-prod step runs 8 tahun lalu
yarn.lock 471e4a1c7d upgrade libs 7 tahun lalu

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 (use it as a session store instead of MongoDB).
    • 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
  • Option (Overwritable in admin page)
    • OAUTH_GOOGLE_CLIENT_ID: Google API client id for OAuth login
    • OAUTH_GOOGLE_CLIENT_SECRET: Google API client secret for OAuth login
    • OAUTH_GITHUB_CLIENT_ID: GitHub API client id for OAuth login
    • OAUTH_GITHUB_CLIENT_SECRET: GitHub API client secret for OAuth login

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.