Skip to content

Commit

Permalink
Updates self-managed documentation with new Enterprise toggles
Browse files Browse the repository at this point in the history
  • Loading branch information
Spoffy committed Jul 21, 2024
1 parent a1af19b commit f0e8690
Showing 1 changed file with 14 additions and 8 deletions.
22 changes: 14 additions & 8 deletions help/en/docs/self-managed.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ describe how using [Docker](https://www.docker.com/),
but there are many other tools and services for running
containers.

To try Grist out using Docker, make an empty directory for Grist to store material in (say `~/grist`) and then for Grist Core you can do:
To try Grist out using Docker, make an empty directory for Grist to store material in (say `~/grist`) and then you can do:

```
docker run -p 8484:8484 \
Expand All @@ -63,18 +63,16 @@ docker run -p 8484:8484 \
-it gristlabs/grist
```

For Grist Enterprise use `gristlabs/grist-ee` instead of
`gristlabs/grist`.

You should then be able to visit `http://localhost:8484` in
your browser. Already you will be able to create and edit Grist
documents, and to open and edit documents downloaded from another
Grist installation (such as our SaaS).

If using some other tool or service, here are the important points:

* The container name is `gristlabs/grist` or `gristlabs/grist-ee`
(for some tools, you may need to prefix these names with `docker.io/`).
* The main image name is `gristlabs/grist`, which is our combined Core and Enterprise docker image.
The image `gristlabs/grist-oss` also exists, which contains only Apache licensed code and only supports Grist Core.
(For some tools, you may need to prefix these image names with `docker.io/`.)
* A volume (or mount, or directory) needs to be available at location
`/persist` within the container. It can be initially empty - Grist
will populate it. Without this volume, nothing you do will be stored long-term.
Expand Down Expand Up @@ -267,12 +265,20 @@ If users on your site login via WordPress, or via a custom mechanism
you developed, you may want to consider
[GristConnect](install/grist-connect.md), available for Grist Enterprise.

### How do I activate Grist Enterprise? {: .tag-ee }
### How do I enable Grist Enterprise? {: .tag-ee }

Grist Enterprise can be enabled by visiting the Admin Panel, clicking the
toggle to enable Enterprise, and restarting the Grist instance.

Alternatively, if you are a new Grist hoster, you can use the `gristlabs/grist-ee`
docker image which has Enterprise features enabled by default.

This will give you an unactivated version of Grist Enterprise, with a 30 day trial period.

Activation keys are used to run Grist Enterprise after a trial period
of 30 days has expired.
Get an activation key by [signing up for Grist Enterprise](https://www.getgrist.com/pricing).
You don't need an activation key to run Grist Core.
You don't need an activation key to run Grist Core, and can revert back to Core at any time using the toggle in the Admin Panel.

Place the contents of your activation key in an environment variable called
`GRIST_ACTIVATION`, or place it in a directory available to Grist and
Expand Down

0 comments on commit f0e8690

Please sign in to comment.