Yuki Takei 5b74196f44 ci: update pnpm deploy commands to use --legacy flag 1 month ago
..
codebuild 69fe38373c feat: modernize Dockerfile and entrypoint implementation 1 month ago
Dockerfile 5b74196f44 ci: update pnpm deploy commands to use --legacy flag 1 month ago
Dockerfile.dockerignore 69fe38373c feat: modernize Dockerfile and entrypoint implementation 1 month ago
README.md 04a4eb19d7 change environment variables for v8 memory management 1 month ago
docker-entrypoint.spec.ts 04a4eb19d7 change environment variables for v8 memory management 1 month ago
docker-entrypoint.ts 04a4eb19d7 change environment variables for v8 memory management 1 month ago

README.md

GROWI Official docker image

Actions Status docker-pulls

GROWI-x-docker

Supported tags and respective Dockerfile links

What is GROWI?

GROWI is a team collaboration software and it forked from crowi

see: growilabs/growi

Requirements

  • MongoDB (>= 6.0)

Optional Dependencies

  • ElasticSearch (>= 7.17)
    • Japanese (kuromoji) Analysis plugin
    • ICU Analysis Plugin

Usage

docker run -d \
    -e MONGO_URI=mongodb://MONGODB_HOST:MONGODB_PORT/growi \
    growilabs/growi

and go to http://localhost:3000/ .

If you use ElasticSearch, type this:

docker run -d \
    -e MONGO_URI=mongodb://MONGODB_HOST:MONGODB_PORT/growi \
    -e ELASTICSEARCH_URI=http://ELASTICSEARCH_HOST:ELASTICSEARCH_PORT/growi \
    growilabs/growi

docker-compose

Using docker-compose is the fastest and the most convenient way to boot GROWI.

see: growilabs/growi-docker-compose

Configuration

See GROWI Docs: Admin Guide (en/ja).

Environment Variables

V8 Memory Management

Variable Type Default Description
V8_MAX_HEAP_SIZE int (MB) (unset) Explicitly specify the --max-heap-size value for Node.js
V8_OPTIMIZE_FOR_SIZE "true" / (unset) (unset) Enable the --optimize-for-size V8 flag to reduce memory usage
V8_LITE_MODE "true" / (unset) (unset) Enable the --lite-mode V8 flag to reduce memory usage at the cost of performance

Heap size fallback behavior: When V8_MAX_HEAP_SIZE is not set, the entrypoint automatically detects the container's memory limit via cgroup (v2/v1) and sets the heap size to 60% of the limit. If no cgroup limit is detected, V8's default heap behavior is used.

Issues

If you have any issues or questions about this image, please contact us through GitHub issue.