Skip to content

armgit / spree

Public Imported from GitHub
0

Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.

Docs: added Environment Variables deployment guide

Damian Legawiec90409c72f088
diff --git a/docs/developer/deployment/docker.mdx b/docs/developer/deployment/docker.mdx
index 405ae20214..7783029836 100644
--- a/docs/developer/deployment/docker.mdx
+++ b/docs/developer/deployment/docker.mdx
@@ -32,15 +32,4 @@ You will need to supply the following environment variables to run the container
| `REDIS_URL` | Redis URL, used for background jobs processing,this could be your AWS ElastiCache instance or any other Redis instance | `redis://localhost:6379/0` |
| `SECRET_KEY_BASE` | You can generate this by running `bin/rails secret` | `2fad5c0b79d25e4765d3018d8c740f8c3a665f0e5c...` |
-There are also some other environment variables that you can set to customize your Spree application.
-
-| Variable | Description | Default value |
-| --- | --- | --- |
-| `DEVISE_SESSION_TIMEOUT` | Session timeout (in days) | `14` |
-| `PORT` | Web server port | `3000` |
-| `RAILS_ENV` | Rails environment (production, development, test) | `production` |
-| `RAILS_LOG_LEVEL` | Log level, you can switch it to `debug` to see more detailed logs | `info` |
-| `RAILS_MAX_THREADS` | Web server (Puma) threads | `3` |
-| `REDIS_CACHE_URL` | Redis URL, used for caching, this could be your AWS ElastiCache instance or any other Redis instance (optional, if not provided will use file based cache) | `redis://localhost:6379/1` |
-| `SENDGRID_API_KEY` | [SendGrid API key](https://docs.sendgrid.com/api-reference/api-keys) (optional, if not provided will not send transactional emails) | `SG.1234567890` |
-| `SENTRY_DSN` | Sentry DSN (optional, if not provided will not send errors to [Sentry](https://sentry.io/)) | `https://sentry.io/...` |
+This is the bare minimum you need to run Spree Starter. [Learn more about environment variables](/developer/deployment/environment_variables).
diff --git a/docs/developer/deployment/environment_variables.mdx b/docs/developer/deployment/environment_variables.mdx
new file mode 100644
index 0000000000..541f8b674e
--- /dev/null
+++ b/docs/developer/deployment/environment_variables.mdx
@@ -0,0 +1,33 @@
+---
+title: Environment Variables
+icon: "terminal"
+---
+
+[Spree Starter](https://github.com/spree/spree_starter) uses several environment variables to configure the application.
+
+## Required environment variables
+
+This variables are required to run Spree Starter.
+
+| Variable | Description | Example |
+| --- | --- | --- |
+| `DATABASE_URL` | Database URL, this could be your AWS RDS instance or any other PostgreSQL instance | `postgres://user:pass@localhost:5432/spree` |
+| `REDIS_URL` | Redis URL, used for background jobs processing,this could be your AWS ElastiCache instance or any other Redis instance | `redis://localhost:6379/0` |
+| `SECRET_KEY_BASE` | You can generate this by running `bin/rails secret` | `2fad5c0b79d25e4765d3018d8c740f8c3a665f0e5c...` |
+
+## Optional environment variables
+
+There are also some other environment variables that you can set to customize your Spree application.
+
+| Variable | Description | Default value | Example |
+| --- | --- | --- | --- |
+| `DEVISE_SESSION_TIMEOUT` | Session timeout (in days) | `14` | `30` |
+| `GOOGLE_PLACES_API_KEY` | [Google Places API key](https://developers.google.com/places/web-service/get-api-key) (optional, used on checkout for address autocomplete) | | `ABCD1234567890` |
+| `PORT` | Web server port | `3000` | `4000` |
+| `RAILS_ENV` | Rails environment (production, development, test) | `production` | `staging` |
+| `RAILS_LOG_LEVEL` | Log level, you can switch it to `debug` to see more detailed logs | `info` | `debug` |
+| `RAILS_MAX_THREADS` | Web server (Puma) threads | `3` | `5` |
+| `REDIS_CACHE_URL` | Redis URL, used for caching, this could be your AWS ElastiCache instance or any other Redis instance (optional, if not provided will use file based cache) | | `redis://localhost:6379/1` |
+| `SCREENSHOT_API_TOKEN` | [Screenshot API token](https://screenshotapi.net/) (optional, used for screenshot generation) | | `1234132512341234` |
+| `SENDGRID_API_KEY` | [SendGrid API key](https://docs.sendgrid.com/api-reference/api-keys) (optional, if not provided will not send transactional emails) | | `SG.1234567890` |
+| `SENTRY_DSN` | Sentry DSN (optional, if not provided will not send errors to [Sentry](https://sentry.io/)) | | `https://sentry.io/...` |
diff --git a/docs/developer/deployment/render.mdx b/docs/developer/deployment/render.mdx
index 7b6b1a435d..ee2e5e972e 100644
--- a/docs/developer/deployment/render.mdx
+++ b/docs/developer/deployment/render.mdx
@@ -115,5 +115,6 @@ Now that your application is deployed, you also need to setup asset storage as R
Before going to full production, we recommend to also:
+- [Set optional environment variables](/developer/deployment/environment_variables)
- [Setup CDN](/developer/deployment/cdn)
- [Configure Caching](/developer/deployment/caching)
diff --git a/docs/docs.json b/docs/docs.json
index 24579d4e3e..f66c18ad7b 100644
--- a/docs/docs.json
+++ b/docs/docs.json
@@ -75,6 +75,7 @@
"pages": [
"developer/deployment/render",
"developer/deployment/docker",
+ "developer/deployment/environment_variables",
"developer/deployment/assets",
"developer/deployment/cdn",
"developer/deployment/caching"