Skip to content

add instructions on how to build with grist-ee #1826

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 9, 2025
Merged

add instructions on how to build with grist-ee #1826

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -262,6 +262,23 @@ These sandboxing methods have been written for our own use at Grist Labs and
may need tweaking to work in your own environment - pull requests
very welcome here!

If you wish to include Grist Labs enterprise extensions in your build,
the steps are as follows. Note that this will add non-OSS code to your
build. It will also place a directory called `node_modules` one level
up, at the same level as the Grist repo. If that is a problem for you,
just move everything into a subdirectory first.

yarn install
./buildtools/checkout-ext-directory.sh grist-ee
yarn install --cwd ext --modules-folder ../../node_modules/
WEBPACK_EXTRA_MODULE_PATHS=../node_modules yarn build
yarn run install:python
WEBPACK_EXTRA_MODULE_PATHS=../node_modules yarn start
# Grist will be available at http://localhost:8484/

The enterprise code will by default not be used. You need to explicitly enable
it in the [Admin Panel](https://support.getgrist.com/self-managed/#how-do-i-enable-grist-enterprise).

## Logins

Like git, Grist has features to track document revision history. So for full operation,
Expand Down