Skip to content
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.

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

self-hosted: document the importance of GRIST_DEFAULT_EMAIL #448

Merged
merged 1 commit into from
Nov 26, 2024
Merged
Changes from all commits
Commits
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
33 changes: 33 additions & 0 deletions help/en/docs/self-managed.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ To try Grist out using Docker, make an empty directory for Grist to store materi
docker run -p 8484:8484 \
-v ~/grist:/persist \
-e GRIST_SESSION_SECRET=invent-a-secret-here \
-e [email protected] \
-it gristlabs/grist
```

Expand Down Expand Up @@ -101,6 +102,22 @@ take at least the following steps:

You can also host Grist on AWS. Full instructions on this hosting method are available on the Grist [AWS Marketplace page](install/aws-marketplace.md).

### What is the administrative account? {: .tag-core .tag-ee }

On a new Grist installation, the user who logs in with the email
defined by `GRIST_DEFAULT_EMAIL` is the administrator of this Grist
installation. When Grist runs for the first time, it will create an
account set to the value of `GRIST_DEFAULT_EMAIL`. Note that if this
variable is not set, it defaults to `[email protected]`. Changing the
value of `GRIST_DEFAULT_EMAIL` after the first admin user has been
created will effectively revoke administrator permissions from the
first user and assign them to the new email address.

The administrative account has access to the admin panel where they
may inspect details of the installation or toggle features such as
[telemetry](self-managed.md#how-do-i-control-telemetry) or [Grist
Enterprise](self-managed.md#how-do-i-enable-grist-enterprise).

### How do I sandbox documents? {: .tag-core .tag-ee }

Grist allows for very powerful formulas, using Python. We recommend
Expand Down Expand Up @@ -237,6 +254,22 @@ The name of the team should use only the lower-case characters a-z, the digits
[Custom styling](self-managed.md#how-do-i-customize-styling) to hide any UI elements
you don't need.


#### Changing the value of `GRIST_DEFAULT_EMAIL`

When [using
`GRIST_SINGLE_ORG`](self-managed.md#how-do-i-set-up-a-team), the
single org will also be created initially and owned by the user
configured by `GRIST_DEFAULT_EMAIL`. If you change the value of
`GRIST_DEFAULT_EMAIL`, [the
administrator](self-managed.md#what-is-the-administrative-account) may
temporarily lose access to the team site.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This could be a little more precise.

If GRIST_SINGLE_ORG is set, then on start-up Grist will create the specified team site if isn't already present. When creating it, it will make the current administrator an owner of it. Before changing the administrator, it is a good idea to use team sharing options to add new owners to the team site, since apart from initial creation, administrators have no automatic right to team site membership.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added your note. Does that look better?


In order to prevent this, before changing `GRIST_DEFAULT_EMAIL` use
[team sharing options](../team-sharing) to add new owners to the team
site, since apart from initial creation, administrators have no
automatic right to team site membership.

### How do I set up authentication? {: .tag-core .tag-ee }

Authentication can be set up in many ways for Grist Core and Enterprise, using
Expand Down