diff --git a/packages/hocuspocus.server/.env.example b/packages/hocuspocus.server/.env.example index 4731a0d8e..2467754cd 100644 --- a/packages/hocuspocus.server/.env.example +++ b/packages/hocuspocus.server/.env.example @@ -58,14 +58,15 @@ PG_HOST=localhost # change allowed origins to your domain ALLOWED_ORIGINS=localhost,docs.plus -# Digital Ocean Spaces Configuration -DO_STORAGE_ENDPOINT=your-digital-ocean-spaces-endpoint -DO_STORAGE_REGION=your-digital-ocean-spaces-region -DO_STORAGE_ACCESS_KEY_ID=your-digital-ocean-spaces-access-key -DO_STORAGE_SECRET_ACCESS_KEY=your-digital-ocean-spaces-secret-access-key -DO_STORAGE_BUCKET=your-digital-ocean-spaces-bucket -DO_STORAGE_MAX_FILE_SIZE=your-digital-ocean-spaces-max-file-size +# Configuration for DigitalOcean Spaces, AWS S3, or any S3-compatible storage services +DO_STORAGE_ENDPOINT=your-endpoint +DO_STORAGE_REGION=your-region +DO_STORAGE_ACCESS_KEY_ID=your-access-key +DO_STORAGE_SECRET_ACCESS_KEY=your-secret-access-key +DO_STORAGE_BUCKET=your-bucket +DO_STORAGE_MAX_FILE_SIZE=your-max-file-size -## Supabase Configuration +# Supabase Configuration: Required for Auth and Realtime features (like chat). +# If you're only using docsplus for the editor, you can ignore this. SUPABASE_ANON_KEY=your-supabase-anon-key SUPABASE_URL=your-supabase-url diff --git a/packages/supabase/.env.example b/packages/supabase/.env.example index ee6d18c94..f30b95f81 100644 --- a/packages/supabase/.env.example +++ b/packages/supabase/.env.example @@ -1,2 +1,5 @@ +# Google Social Login +# For more information, visit: https://supabase.com/docs/guides/auth/social-login +# Check the config.toml file in the root of the project for additional social login parameters. GOOGLE_CLIENT_ID=YOUR_GOOGLE_CLIENT_ID GOOGLE_SECRET=YOUR_GOOGLE_SECRET diff --git a/packages/webapp/.env.example b/packages/webapp/.env.example index 0d0c3a219..421961e82 100644 --- a/packages/webapp/.env.example +++ b/packages/webapp/.env.example @@ -2,15 +2,13 @@ NEXT_PUBLIC_PROVIDER_URL='ws://localhost:1234' NEXT_PUBLIC_RESTAPI_URL='http://localhost:2300/api' NEXT_PUBLIC_SSE_URL='http://localhost:2300/sse' -# replace this with your Tiptap Pro token, if you want to install tiptap pro extension +# Replace this with your Tiptap Pro token if you want to install Tiptap Pro extensions. +# For more information, visit: https://tiptap.dev/docs/editor/extensions/overview?filter=pro TIPTAP_PRO_TOKEN=YOUR_TIPTAP_PRO_TOKEN -# replace this with your Supabase anon key -NEXT_PUBLIC_SUPABASE_ANON_KEY=YOUR_SUPABASE_ANON_KEY - -NEXT_PUBLIC_SUPABASE_URL=http://localhost:54321 -NEXT_PUBLIC_SUPABASE_WS_URL=ws://localhost:54321 -NEXT_PUBLIC_AUTH_REDIRECT_TO=http://localhost:3000/auth/callback - -NEXT_PUBLIC_SPACES_KEY= -NEXT_PUBLIC_SPACES_SECRET= +# Replace this with your Supabase anon key. +# Leave it empty if you don't want to use Auth and Realtime features (like chat). +NEXT_PUBLIC_SUPABASE_ANON_KEY= #YOUR_SUPABASE_ANON_KEY +NEXT_PUBLIC_SUPABASE_URL= #http://localhost:54321 +NEXT_PUBLIC_SUPABASE_WS_URL= #ws://localhost:54321 +NEXT_PUBLIC_AUTH_REDIRECT_TO= #http://localhost:3000/auth/callback