Archives/gristlabs_grist-core
1
0
Fork 0
mirror of https://github.com/gristlabs/grist-core.git synced 2024-10-27 20:44:07 +00:00
Code Issues Projects Releases Wiki Activity

add link to new self-managed handbook (#246)

Browse Source 
Adds a link to a new page for documenting configuration of self-managed Grist.
This commit is contained in:
Paul Fitzpatrick 2022-08-17 19:07:48 -04:00 committed by GitHub
parent 103c795aa2
commit b286256f96
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -98,6 +98,10 @@ To enable gVisor sandboxing, set `--env GRIST_SANDBOX_FLAVOR=gvisor`.
This should work with default docker settings, but may not work in all This should work with default docker settings, but may not work in all
environments. environments.
You can find a lot more about configuring Grist, setting up authentication,
and running it on a public server in our
[Self-Managed Grist](https://support.getgrist.com/self-managed/) handbook.
## Building from source ## Building from source
To build Grist from source, follow these steps: To build Grist from source, follow these steps:
@ -137,11 +141,10 @@ You can change your name in `Profile Settings` in
the [User Menu](https://support.getgrist.com/glossary/#user-menu). the [User Menu](https://support.getgrist.com/glossary/#user-menu).
For multi-user operation, or if you wish to access Grist across the For multi-user operation, or if you wish to access Grist across the
public internet, you'll want to connect it to your own single sign-in service. public internet, you'll want to connect it to your own Single Sign-On service.
There's a `docker-compose` template at https://community.getgrist.com/t/a-template-for-self-hosting-grist-with-traefik-and-docker-compose/856 There are a lot of ways to do this, including [SAML and forward authentication](https://support.getgrist.com/self-managed/#how-do-i-set-up-authentication).
covering using Let's Encrypt for certificates and Google for sign-ins. Grist has been tested with [Authentik](https://goauthentik.io/), [Auth0](https://auth0.com/),
You can also use [SAML](https://github.com/gristlabs/grist-core/blob/main/app/server/lib/SamlConfig.ts). and Google/Microsoft sign-ins via [Dex](https://dexidp.io/).
Grist has been tested with [Authentik](https://goauthentik.io/) and [Auth0](https://auth0.com/).
## Why free and open source software ## Why free and open source software
@ -151,7 +154,7 @@ here, combined with business-specific software designed to scale it to many user
etc. etc.
Grist Labs is an open-core company. We offer Grist hosting as a Grist Labs is an open-core company. We offer Grist hosting as a
service, with free and paid plans. We intend to also develop and sell service, with free and paid plans. We also develop and sell
features related to Grist using a proprietary license, targeted at the features related to Grist using a proprietary license, targeted at the
needs of enterprises with large self-managed installations. We see needs of enterprises with large self-managed installations. We see
data portability and autonomy as a key value Grist can bring to our data portability and autonomy as a key value Grist can bring to our