Improve environment variables page (#2639)

* docs: add sample env file and link * Update docusaurus/docs/cms/deployment.md * Update sample-env.md * Update environment.md * Update sample-env.md * Update sample-env.md * Reformat * Add heading for easier linking * Add links to feature pages * Fix anchor link

Author: pwizla

docusaurus/docs/cms/configurations/environment.md

@@ -8,6 +8,8 @@ tags:
 - environment
 ---
 
+import SampleEnv from '/docs/snippets/sample-env.md'
+
 # Environment configuration and variables
 
 Strapi provides specific environment variable names. Defining them in an environment file (e.g., `.env`) will make these variables and their values available in your code.
@@ -29,14 +31,27 @@ Strapi provides the following environment variables:
 | `NODE_ENV` | Type of environment where the application is running.<br/><br/>`production` enables specific behaviors (see <ExternalLink to="https://nodejs.org/en/learn/getting-started/nodejs-the-difference-between-development-and-production" text="Node.js documentation"/> for details) | `String` | `'development'` |
 | `BROWSER` | Open the admin panel in the browser after startup | `Boolean` | `true` |
 | `ENV_PATH` | Path to the file that contains your environment variables | `String` | `'./.env'` |
-| `STRAPI_PLUGIN_I18N_INIT_LOCALE_CODE` <br/><br/>_Optional_ | Initialization locale for the application, if the [Internationalization (i18n) plugin](/cms/features/internationalization) is installed and enabled on Content-Types (see [Configuration of i18n in production environments](/cms/features/internationalization#configuration)) | `String` | `'en'` |
+| `STRAPI_PLUGIN_I18N_INIT_LOCALE_CODE` <br/><br/>_Optional_ | Initialization locale for the application, if the [Internationalization (i18n) feature](/cms/features/internationalization) is installed and enabled on Content-Types (see [Configuration of i18n in production environments](/cms/features/internationalization#configuration)) | `String` | `'en'` |
 | `STRAPI_ENFORCE_SOURCEMAPS` | Forces the bundler to emit source-maps, which is helpful for debugging errors in the admin app. | `boolean` | `false` |
 | `FAST_REFRESH` | _(Only applies to webpack)_<br/>Use <ExternalLink to="https://github.com/pmmmwh/react-refresh-webpack-plugin" text="react-refresh"/> to enable "Fast Refresh" for near-instant feedback while developing the Strapi admin panel. | `boolean` | `true` |
+| `HOST` | Address the Strapi server listens on | `String` | `0.0.0.0` |
+| `PORT` | Port used by the Strapi server | `Number` | `1337` |
+| `APP_KEYS` | Comma-separated keys used to sign cookies and other secrets | `String` | `auto-generated` |
+| `API_TOKEN_SALT` | Salt used when creating [API tokens](/cms/features/api-tokens) | `String` | `auto-generated` |
+| `ADMIN_JWT_SECRET` | Secret for JWT tokens used in the admin panel | `String` | `auto-generated` |
+| `JWT_SECRET` | Secret for JWT tokens generated by the [Users & Permissions](/cms/features/users-permissions) feature | `String` | `auto-generated` |
+| `TRANSFER_TOKEN_SALT` | Salt used for transfer tokens by the [Data Management](/cms/features/data-management) feature | `String` | `auto-generated` |
+| `DATABASE_CLIENT` | Database client to use (e.g., `sqlite`) | `String` | `sqlite` |
+| `DATABASE_FILENAME` | Location of the SQLite database file | `String` | `.tmp/data.db` |
 
 :::tip
 Prefixing an environment variable name with `STRAPI_ADMIN_` exposes the variable to the admin front end (e.g., `STRAPI_ADMIN_MY_PLUGIN_VARIABLE` is accessible through `process.env.STRAPI_ADMIN_MY_PLUGIN_VARIABLE`).
 :::
 
+### Example `.env` file
+
+<SampleEnv />
+
 ## Environment configurations
 
 Configurations can be created with the following naming and structure conventions: `./config/env/{environment}/{filename}`. This is useful when you need specific static configurations for specific environments and using environment variables is not the best solution.
@@ -102,4 +117,4 @@ To learn deeper about how to use environment variables in your code, please refe
 
 <CustomDocCardsWrapper>
 <CustomDocCard icon="chalkboard-simple" title="Access and cast variables" description="Learn how to access and cast environment variables with the env() utility." link="/cms/configurations/guides/access-cast-environment-variables" />
-</CustomDocCardsWrapper>
+</CustomDocCardsWrapper>

docusaurus/docs/cms/deployment.md

@@ -71,7 +71,7 @@ module.exports = ({ env }) => ({
 });
 ```
 
-Then you can create a `.env` file or directly set environment variables in your chosen deployment platform:
+Strapi generates a `.env` file with default values when you create a new project. You can edit this file or set variables in your chosen deployment platform (see [example `.env` file](/cms/configurations/environment#example-env-file)):
 
 ```
 HOST=10.0.0.1

docusaurus/docs/snippets/sample-env.md

@@ -0,0 +1,46 @@
+The Strapi CLI generates an `.env` and an `.env.example` file when creating a new project. The files contain automatically-generated security keys and database settings similar to the following:
+
+<Tabs>
+<TabItem value="env-example" label=".env.example">
+
+```env title=".env.example"
+HOST=0.0.0.0
+PORT=1337
+APP_KEYS="toBeModified1,toBeModified2"
+API_TOKEN_SALT=tobemodified
+ADMIN_JWT_SECRET=tobemodified
+TRANSFER_TOKEN_SALT=tobemodified
+JWT_SECRET=tobemodified
+ENCRYPTION_KEY=tobemodified
+```
+
+</TabItem>
+<TabItem value="env" label=".env">
+
+The variables might differ depending on options selected on project creation.
+
+```env title=".env"
+# Server
+HOST=0.0.0.0
+PORT=1337
+
+# Secrets
+APP_KEYS=appkeyvalue1,appkeyvalue2,appkeyvalue3,appkeyvalue4
+API_TOKEN_SALT=anapitokensalt
+ADMIN_JWT_SECRET=youradminjwtsecret
+TRANSFER_TOKEN_SALT=transfertokensaltvalue
+ENCRYPTION_KEY=yourencryptionkey
+
+# Database
+DATABASE_CLIENT=sqlite
+DATABASE_HOST=
+DATABASE_PORT=
+DATABASE_NAME=
+DATABASE_USERNAME=
+DATABASE_PASSWORD=
+DATABASE_SSL=false
+DATABASE_FILENAME=.tmp/data.db
+```
+
+</TabItem>
+</Tabs>